Files
cleveragents-core/docs/api/index.md
T
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
docs: update changelog, API docs, and architecture for 2026-04-02 merged PRs
- 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
2026-04-02 19:30:53 +00:00

1.4 KiB

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 Exception hierarchy, error handling, retry patterns, async cleanup
cleveragents.a2a Agent-to-Agent (A2A) protocol facade, transport, models, and events
cleveragents.actor Actor registry, configuration, loader, and compiler
cleveragents.skills Skill framework — schema, protocol, registry, discovery, and inline executor
cleveragents.tool Tool runtime, lifecycle, registry, router, and container executor
cleveragents.mcp Model Context Protocol (MCP) adapter, client, registry, and sandbox
cleveragents.resource Resource schema, handlers, and type-inheritance system
cleveragents.config Application settings, logging, metrics, and security scanning
cleveragents.tui 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.