freemo
71177c6e1a
CI / lint (push) Failing after 18s
CI / build (push) Successful in 18s
CI / helm (push) Successful in 29s
CI / quality (push) Successful in 37s
CI / security (push) Failing after 52s
CI / typecheck (push) Failing after 58s
CI / coverage (push) Has been skipped
CI / benchmark-regression (push) Has been skipped
CI / unit_tests (push) Failing after 1m58s
CI / docker (push) Has been skipped
CI / benchmark-publish (push) Has been cancelled
CI / e2e_tests (push) Has been cancelled
CI / integration_tests (push) Has been cancelled
CI / status-check (push) Has been cancelled
- CHANGELOG: add [Unreleased] entries for TUI first-run experience (#1391), session Markdown export (#1004), and UKO provenance/temporal versioning (#891) - README: add first-run experience and Markdown transcript export bullets - docs/api/tui.md: new TUI API reference covering first-run, persona system, input routing, slash commands, session export/import, and widgets - docs/api/index.md: add TUI entry to module index - docs/api/resource.md: document DatabaseResourceHandler and DevcontainerHandler full protocol implementations with method tables and examples - docs/architecture.md: expand UKO section with provenance/temporal versioning details; update TUI design decision summary - mkdocs.yml: add TUI page to API Reference nav ISSUES CLOSED: #1391 #1004 #891
24 lines
1.4 KiB
Markdown
24 lines
1.4 KiB
Markdown
# API Reference
|
|
|
|
This section documents the public Python API of the `cleveragents` package.
|
|
Each page covers one top-level module or sub-package, listing its exported
|
|
classes, functions, and exceptions with signatures and usage examples.
|
|
|
|
## Module Index
|
|
|
|
| Module | Description |
|
|
|--------|-------------|
|
|
| [`cleveragents.core`](core.md) | Exception hierarchy, error handling, retry patterns, async cleanup |
|
|
| [`cleveragents.a2a`](a2a.md) | Agent-to-Agent (A2A) protocol facade, transport, models, and events |
|
|
| [`cleveragents.actor`](actor.md) | Actor registry, configuration, loader, and compiler |
|
|
| [`cleveragents.skills`](skills.md) | Skill framework — schema, protocol, registry, discovery, and inline executor |
|
|
| [`cleveragents.tool`](tool.md) | Tool runtime, lifecycle, registry, router, and container executor |
|
|
| [`cleveragents.mcp`](mcp.md) | Model Context Protocol (MCP) adapter, client, registry, and sandbox |
|
|
| [`cleveragents.resource`](resource.md) | Resource schema, handlers, and type-inheritance system |
|
|
| [`cleveragents.config`](config.md) | Application settings, logging, metrics, and security scanning |
|
|
| [`cleveragents.tui`](tui.md) | Interactive Terminal UI — app, persona system, input routing, slash commands, session export/import |
|
|
|
|
> **Note:** Internal modules (prefixed with `_`) and implementation details
|
|
> not listed in a module's `__all__` are considered private and may change
|
|
> without notice.
|