This release is a pre-release and may not be stable for production use.
kaos-ui
Part of Kelvin Agentic OS (KAOS) — open agentic infrastructure for legal work, built by 273 Ventures. See the full KAOS package map for the rest of the stack.
kaos-ui is the project scaffolder for KAOS user-facing applications. It
ships six production-ready templates — web:api (FastAPI), web:spa
(Vite + React + Tailwind v4 + shadcn/ui, kaos-agents-wired), dashboard:streamlit,
tui:textual, module (KAOS module package), and workflow (single-file
script) — and exposes the same scaffold/info/doctor lifecycle to MCP agents
through four read-only tools.
It is the dependency-light entry point every KAOS user-facing app builds
from. kaos-ui does not run servers, talk to LLMs, or render UI itself
— it produces working projects that do those things, with the
conventions and toolchain that the rest of the KAOS ecosystem assumes.
To expose kaos-ui over the Model Context Protocol, register its tools
on a KaosRuntime and serve it through the companion package
kaos-mcp (ships separately).
Install
uv add kaos-ui
# or
pip install kaos-ui
kaos-ui requires Python 3.13 or newer and has three runtime
dependencies (kaos-core, pydantic, pydantic-settings). Templates
that depend on pnpm, cargo, or docker declare those expectations
in their kaos-ui-doctor check; kaos-ui itself does not require them.
Quick start
Scaffold a project from the CLI:
# Discover what's available
kaos-ui list
# See full detail (deps, env, post-install, next steps)
kaos-ui info web:spa
# Materialize a project
kaos-ui new web:spa myapp
cd myapp
make install # runs the manifest's post_install chain
make dev # boots the dev servers
Or drive the same lifecycle from Python:
import asyncio
from pathlib import Path
from kaos_core import KaosRuntime
from kaos_ui import register_ui_tools, scaffold
async def main() -> None:
# Use scaffold() directly:
result = scaffold(template="workflow", name="demo", target_dir=Path("./demo"))
print(f"created {len(result.files)} files in {result.target}")
# Or register the MCP tools onto a runtime:
runtime = KaosRuntime()
n = register_ui_tools(runtime)
print(f"registered {n} kaos-ui MCP tools")
tool = runtime.tools.get_tool("kaos-ui-list-templates")
res = await tool.execute({})
print("templates:", res.structuredContent["count"])
asyncio.run(main())
Concepts
The package is built around four small primitives.
| Concept | What it is |
|---|---|
ScaffoldResult |
Typed, frozen dataclass returned by scaffold(). result.template / result.target / result.files for attribute access; result.to_dict() for the serialization boundary into CLI JSON output or MCP ToolResult.structuredContent. |
TemplateManifest |
Per-kind metadata: description, tags, required env vars, post-install commands, next-step instructions, and the on-disk template directory. Registered via register_template(); looked up via get_manifest(kind). |
KaosUISettings |
Typed settings (KAOS_UI_ env prefix) for python_version, node_version, and templates_dir override. Resolved at the CLI/MCP boundary and threaded into scaffold() — never read mid-scaffolder. |
| MCP tools | Four KaosTool subclasses exposing the lifecycle to agents — ListTemplatesTool, TemplateInfoTool, ScaffoldTool, DoctorTool. Each ships explicit ToolAnnotations and structured error envelopes (what / how_to_fix / alternative_tool). |
CLI
kaos-ui ships a kaos-ui CLI. Every structured command supports
--json for machine-readable output:
kaos-ui list # registered template kinds
kaos-ui list --json # structured envelope: {"command": "list", ...}
kaos-ui info web:spa # full manifest detail
kaos-ui info workflow --json
kaos-ui new web:spa myapp # materialize a project
kaos-ui new web:spa myapp --dry-run # plan without writing
kaos-ui doctor ./myapp # health-check a scaffolded project
kaos-ui doctor . --json # structured findings
Compatibility & status
| Aspect | |
|---|---|
| Python | 3.13, 3.14 |
| OS | Linux, macOS, Windows (pure-Python wheel; no native code) |
| Maturity | Alpha. Public API is documented in kaos_ui.__all__ (19 symbols). |
| Stability policy | Pre-1.0: minor bumps may change behaviour. Every change is documented in CHANGELOG.md. Shipping template kinds (and their post_install + next_steps contracts), the MCP tool surface, and the KAOS_UI_* environment-variable namespace are public API. |
| Test coverage | 105 tests, 81% line coverage; the four MCP tools are 98%+ covered. |
| Type checker | Validated with ty, Astral's Python type checker. |
Companion packages
kaos-ui is one of the packages in the
Kelvin Agentic OS. The broader stack:
| Package | Layer | What it does |
|---|---|---|
kaos-core |
Core | Foundational runtime, MCP-native types, registries, execution engine, VFS |
kaos-content |
Core | Typed document AST: Block/Inline, provenance, views |
kaos-mcp |
Bridge | FastMCP server, kaos management CLI, MCP resource templates |
kaos-pdf |
Extraction | PDF → AST with provenance |
kaos-web |
Extraction | Web extraction, browser automation, search, domain intelligence |
kaos-office |
Extraction | DOCX / PPTX / XLSX readers + writers to AST |
kaos-tabular |
Extraction | DuckDB-powered SQL analytics |
kaos-source |
Data | Government + financial data connectors (Federal Register, eCFR, EDGAR, GovInfo, PACER, GLEIF) |
kaos-llm-client |
LLM | Multi-provider LLM transport |
kaos-llm-core |
LLM | Typed LLM programming (Signatures, Programs, Optimizers) |
kaos-nlp-core |
Primitives (Rust) | High-performance NLP primitives |
kaos-nlp-transformers |
ML | Dense embeddings + retrieval |
kaos-graph |
Primitives (Rust) | Graph algorithms + RDF/SPARQL |
kaos-ml-core |
Primitives (Rust) | Classical ML on the document AST |
kaos-citations |
Legal | Legal citation extraction, resolution, verification |
kaos-agents |
Agentic | Agent runtime, memory, recipes |
kaos-reference |
Sample | Reference module for module authors |
Packages depend on kaos-core; everything else is opt-in. Mix and match the
ones you need.
Pre-built example
The repository ships a complete reference application under
examples/single-user-chat/ that
exercises the web:spa template end-to-end: bearer-token auth, SSE
streaming proxy with a read-only KAOS tool allowlist, persistent VFS,
markdown rendering with link sanitization, and a stop/cancel control.
It's the canonical proof that the scaffold output runs in anger.
Development
git clone https://github.com/273v/kaos-ui
cd kaos-ui
uv sync --group dev
Install pre-commit hooks (recommended — they run the same checks as CI on every commit, scoped to staged files):
uvx pre-commit install
uvx pre-commit run --all-files # one-time full sweep
Manual QA commands (the same set CI runs):
uv run ruff format --check kaos_ui tests
uv run ruff check kaos_ui tests
uv run ty check kaos_ui tests
uv run pytest -m "not slow"
Build from source
uv build
uv pip install dist/*.whl
Contributing
Issues and pull requests are welcome. See CONTRIBUTING.md
for setup, quality gates, pull request expectations, and engineering
standards. By contributing you certify the
Developer Certificate of Origin v1.1 —
sign every commit with git commit -s. Please open an issue before starting
on a non-trivial change so we can align on scope.
Security
For security issues, please do not file a public issue. Report privately via GitHub Private Vulnerability Reporting or email security@273ventures.com. See SECURITY.md for the full disclosure policy.
License
Apache License 2.0 — see LICENSE and NOTICE.
Copyright 2026 273 Ventures LLC. Built for kelvin.legal.
Release files for kaos-ui 0.1.0a16
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| kaos_ui-0.1.0a16.tar.gz | 184.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kaos_ui-0.1.0a16-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 386.0 kB
Release files / kaos_ui-0.1.0a16.tar.gz
| Download URL | kaos_ui-0.1.0a16.tar.gz |
|---|---|
| Size | 184.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cffd914e099ac7ca0bbcd0b714e59d7ea914eb7ed6b7d3edb6cb8a91ae870817
|
|
BLAKE2b-256 checksum How to use checksums |
c1c52b21bed51671b259e9e76b1def613d8ecec403482856caf05564e21eb007
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 23, 2026.
Transparency logRelease files / kaos_ui-0.1.0a16-py3-none-any.whl
| Download URL | kaos_ui-0.1.0a16-py3-none-any.whl |
|---|---|
| Size | 201.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0b6ede0c17a4f8f5eb4772384fa8ba471a3d08072fae6554639a95ef2f9f6fd6
|
|
BLAKE2b-256 checksum How to use checksums |
052b6942495190343d5f796e782f1615f51568a6886712ef02905069cd2da1dc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 23, 2026.
Transparency log