freemo c129ea5098 docs(tui): add exhaustive detail for block cursor, settings, notifications, per-window hotkeys, and secondary screens
Expand the TUI specification section with comprehensive detail that was
identified as missing in a gap analysis against the original design prompt
and Toad TUI feature inventory. The flat "Global Hotkey Reference" table
is replaced with 16 per-window/overlay hotkey tables.

New specification content:

Block Cursor and Context Menu:
- Block cursor navigation (alt+up/down, space, enter)
- Floating context menu with 7 actions: copy to clipboard (c), copy to
  prompt (p), export as Markdown (e), export as SVG (v), maximize (m),
  retry (r), show raw data (d)
- New diagram: context menu popup

Conversation Block Details:
- Tool call states with 4 lifecycle phases (pending, completed collapsed,
  completed expanded, failed) and tools.expand setting (never/always/
  success/fail/both)
- Actor thought block with collapsed (max 10 lines) and expanded states
- Permission question widget with allow/reject options and queue behavior
- New diagrams: tool call states, thought block, question widget

Prompt Architecture Detail:
- History navigation with per-mode JSONL files (prompt vs shell), up/down
  at start/end of TextArea, 10K entry cap
- Key passthrough from conversation Window to prompt on printable chars
- Multiline detection (newlines, triple backticks, shift+enter)
- Shell danger detection with heuristic patterns (rm -rf, chmod 777, dd,
  fork bombs, mkfs, sudo) and configurable shell.warn_dangerous setting

Notification System:
- Flash messages (4 semantic styles: default, success, warning, error)
- Desktop notifications via notifypy (never/on-blur/always), 5 trigger
  events, low-severity suppression
- Terminal title management with VT escape sequences, state-dependent
  icons, and configurable blink on input-needed
- Sound effects (4 event sounds, graceful degradation)

Clipboard Operations:
- Auto-copy on selection (ui.auto_copy), block copy via context menu,
  pyperclip with OSC 52 fallback

Session Persistence and Resume:
- SQLite storage schema (10 columns) at ~/.local/state/cleveragents/tui.db
- 6-step resume workflow via ctrl+r or /session:import

Sessions Screen:
- New diagram: sessions modal with active + saved session sections
- Time formatting, session state indicators, keyboard bindings

Settings Screen:
- New diagram: schema-driven settings modal with search
- Complete settings schema: 7 categories, 30+ settings with types,
  defaults, ranges, and descriptions (UI, notifications, sidebar, agent,
  tools, shell, diff)

Additional Features:
- Conversation content pruning (prune_low_mark/prune_excess thresholds)
- Double-tap safety (ctrl+c 5s quit window, escape 400ms terminal exit)
- Loading states (rainbow throbber + rotating quotes alternative)
- Conversation export (JSON, Markdown, per-block SVG)
- Column width and scrollbar configuration

Per-Window Hotkey Tables (16 tables replacing 1 flat table):
- Global, MainScreen prompt, MainScreen conversation/cursor, block context
  menu, terminal focused, sidebar visible, sidebar fullscreen, reference
  picker (search + tree modes), slash command overlay, plan detail modal,
  project detail modal, persona editor modal, permissions screen, settings
  screen, sessions screen, question widget, help panel
2026-03-11 00:39:57 -04:00
2026-02-22 14:18:24 -05:00
2026-03-10 12:38:35 -04:00
2024-01-25 23:10:04 -05:00
2024-01-25 23:10:04 -05:00
2024-01-25 23:10:04 -05:00
2024-01-25 23:10:04 -05:00
2026-02-23 22:20:03 +00:00
2024-01-25 23:10:04 -05:00
2024-01-25 23:10:04 -05:00
2024-01-25 23:14:00 -05:00
2026-03-10 12:38:35 -04:00
2024-01-25 23:14:00 -05:00

CleverAgents Core

CleverAgents is a Python-first automation platform. It provides a unified agents CLI, embedded runtime, and service orchestration tools while embracing modern Python tooling.

Highlights

  • Unified CLI entry points: cleveragents and agents
  • Fast Typer/Click-based interface with parity for help/version behavior
  • Behavior-driven coverage via Behave and Robot Framework
  • Nox automation for linting, typing, testing, docs, builds, and benchmarks
  • MkDocs-powered documentation with CleverAgents branding

Quick Start

# clone the CleverAgents core repository
git clone https://git.cleverthis.com/cleveragents/core.git
cd core

# install dependencies
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev,tests,docs]"

# set up pre-commit hooks and verify tooling
bash scripts/setup-dev.sh

# verify the CLI
agents --help
agents --version

Developing

Pre-commit hooks run automatically on every git commit (formatting, linting, type checking, security scanning). To run checks manually:

# core validation
nox -s format            # ruff auto-formatting
nox -s lint              # ruff linting
nox -s typecheck         # pyright type checking
nox -s unit_tests        # behave unit tests
nox -s integration_tests # robot integration tests

# quality & security
nox -s security_scan     # bandit security scanning
nox -s dead_code         # vulture dead code detection
nox -s complexity        # radon complexity analysis
nox -s pre_commit        # run all pre-commit hooks
nox -s adr_compliance    # verify ADR compliance

For the full quality automation guide, see docs/development/quality-automation.md.

Documentation

nox -s docs
nox -s serve_docs

Tests

Behave feature scenarios live under features/ and Robot suites under robot/. Use the Nox sessions above to execute them in parity with the implementation plan.

Observability

LangSmith tracing is optional and off by default. Enable it by exporting CLEVERAGENTS_LANGSMITH_ENABLED=true along with a project name and API key (CLEVERAGENTS_LANGSMITH_PROJECT, CLEVERAGENTS_LANGSMITH_API_KEY). The settings module automatically mirrors these values to LANGCHAIN_TRACING_V2, LANGCHAIN_PROJECT, and LANGCHAIN_API_KEY, so LangChain/LangGraph agents emit traces without extra wiring. Additional knobs such as CLEVERAGENTS_LANGSMITH_ENDPOINT, CLEVERAGENTS_LANGSMITH_USER_ID, and CLEVERAGENTS_LANGSMITH_TAGS are documented in docs/observability.md.

LLM provider configuration

CleverAgents ships with a LangChain/LangGraph powered provider registry that discovers whichever API keys you export and automatically selects the best available provider. The CLI now uses actors: select an actor with --actor <name> (or set a default via agents actor set-default). Actors embed provider/model choices; built-in actors are seeded from CLEVERAGENTS_DEFAULT_PROVIDER / CLEVERAGENTS_DEFAULT_MODEL, then fall back to the built-in order (openai → anthropic → google → azure → openrouter → groq → together → cohere → gemini).

Required environment variables

Provider Primary variables
OpenAI OPENAI_API_KEY
Anthropic ANTHROPIC_API_KEY
Google GOOGLE_API_KEY or GOOGLE_GENAI_API_KEY
Azure OpenAI AZURE_OPENAI_API_KEY plus AZURE_OPENAI_ENDPOINT/AZURE_OPENAI_DEPLOYMENT
OpenRouter OPENROUTER_API_KEY (+ optional CLEVERAGENTS_OPENROUTER_ORGANIZATION for sanitized headers)
Gemini GEMINI_API_KEY or GOOGLE_GEMINI_API_KEY
Cohere COHERE_API_KEY
Groq GROQ_API_KEY
Together TOGETHER_API_KEY

Set CLEVERAGENTS_DEFAULT_PROVIDER to pin the global provider (for example export CLEVERAGENTS_DEFAULT_PROVIDER=openai) and CLEVERAGENTS_DEFAULT_MODEL to lock in a model ID. When unset, the registry picks the first configured provider and uses its published default model such as gpt-4o for OpenAI or claude-sonnet-4-20250514 for Anthropic.

Diagnostics and testing shortcuts

  • agents diagnostics prints whether the registry can see your credentials and which actor/provider is selected.
  • agents tell and agents build require --actor <name> unless a default actor is set; use agents actor set-default <name> to configure one.
  • Built-in actors (<provider>/<model>) are immutable, custom actors must be named local/<id>, and the default actor cannot be removed. Use --unsafe when adding/updating configs marked unsafe; runtime only warns when invoking unsafe actors.
  • CLEVERAGENTS_TESTING_USE_MOCK_AI=true forces the in-repo mock provider so Behave/Robot suites never hit external APIs.
  • The full capability matrix (streaming, tool calls, JSON mode, etc.) is documented in docs/reference/providers.md.
S
Description
test
Readme 84 MiB
Languages
Python 75.8%
Gherkin 18.3%
RobotFramework 4.8%
TypeScript 0.9%
Shell 0.2%