docs: update changelog and CLI reference docs for 2026-04-02 merged PRs
CI / build (push) Successful in 18s
CI / lint (push) Failing after 18s
CI / helm (push) Successful in 23s
CI / quality (push) Successful in 35s
CI / typecheck (push) Failing after 45s
CI / coverage (push) Has been skipped
CI / benchmark-regression (push) Has been skipped
CI / security (push) Failing after 52s
CI / unit_tests (push) Failing after 1m50s
CI / docker (push) Has been skipped
CI / benchmark-publish (push) Has been cancelled
CI / integration_tests (push) Has been cancelled
CI / e2e_tests (push) Has been cancelled
CI / status-check (push) Has been cancelled

- CHANGELOG: add Fixed entries for PRs #1574, #1570, #1569, #1547, #1548,
  #1522, #1524, #1525, #1520, #1553 covering rich output panels for session,
  actor, and plan commands, plus version commit SHA and provider fix
- docs/reference/session_cli.md: document new rich output panels for
  session create (Settings, Actor Details), session list (Name column,
  Summary panel), session show (Automation field), session delete
  (Deletion Summary, Cleanup panels); update export to document --format md
- docs/reference/actor_cli.md: document new rich output panels for
  actor remove (Actor Removed, Impact, Cleanup) and actor list (Summary panel)
- docs/reference/plan_cli.md: document new rich output for plan list
  (Elapsed column, Filters panel, Summary panel)
- docs/reference/cli_system_commands.md: document commit SHA resolution
  order (CLEVERAGENTS_COMMIT env var → git rev-parse → 'unknown')

ISSUES CLOSED: #1574 #1570 #1569 #1547 #1548 #1522 #1524 #1525 #1520 #1553
This commit is contained in:
2026-04-02 23:05:14 +00:00
parent 629154488e
commit 0382b2f722
5 changed files with 166 additions and 13 deletions
+35
View File
@@ -34,6 +34,41 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
### Fixed
- `agents session list` rich output now includes a **Name** column and a **Summary** panel
showing total sessions, most recent, oldest, total messages, and storage usage. JSON output
also includes a `summary` section with the same statistics. (#1574, #1570)
- `agents session delete` rich output now renders a **Deletion Summary** panel (session ID,
messages removed, storage freed, plans orphaned) and a **Cleanup** panel (backups, logs,
context, checkpoints) before the success message. (#1569)
- `agents session create` rich output now renders a **Settings** panel (automation profile,
streaming, context, memory, max history) and an **Actor Details** panel (provider, model,
temperature, context window) when an actor is bound. (#1547)
- `agents session show` rich output now includes the **Automation** field in the Session
Summary panel and a `✓ OK` success message. (#1548)
- `agents plan list` rich output now renders spec-required columns (ID, Phase, State, Action,
Project, **Elapsed**), a **Filters** panel (shown only when filters are active), a
**Summary** panel (total, processing, completed, errored counts), and a success message. (#1522)
- `agents actor remove` rich output now renders an **Actor Removed** panel (name, provider,
model), an **Impact** panel (sessions and plans affected), and a **Cleanup** panel (config
and orphaned contexts) before the success message. (#1524)
- `agents actor list` rich output now renders a **Summary** panel (total, built-in, custom,
unsafe, providers used) and a success message after the actors table. (#1525)
- `agents version` now displays the actual git commit SHA (from `CLEVERAGENTS_COMMIT`
environment variable or `git rev-parse --short HEAD`) in the Build panel, replacing the
placeholder `"unknown"` value. (#1520)
- `LangChainChatProvider.name` and `LangChainChatProvider.model_id` are now mutable
properties with setters, fixing an `AttributeError` when `PlanService` attempted to
resolve provider names and model IDs after instantiation. This resolves a crash in
`agents build` and `agents tell`. (#1553)
- `agents tool add` now accepts YAML configs using the spec-required `tool:` wrapper key
(e.g. `tool:\n name: ...`). The `cleveragents:` version header is silently ignored.
Flat format (without wrapper) remains supported for backward compatibility. (#1471)
+26
View File
@@ -91,6 +91,16 @@ Remove a custom actor by its namespaced name.
agents actor remove <NAME>
```
### Rich Output Panels
After removal, the `rich` format renders three panels:
- **Actor Removed** — name, provider, and model of the removed actor.
- **Impact** — number of sessions, active plans, and actions that referenced the actor.
- **Cleanup** — config retention status and number of orphaned contexts.
Followed by a `✓ OK Actor removed` success message.
### Examples
```bash
@@ -117,6 +127,22 @@ agents actor list [--format FORMAT]
| `plain` | Plain text key-value pairs |
| `table` | ASCII table without Rich styling |
### Rich Output
The `rich` format renders a table with columns: **Name**, **Provider**, **Model**,
**Default**, **Built-in**, **Unsafe**, and **Updated**. After the table, a **Summary**
panel is shown with:
| Field | Description |
|-------|-------------|
| Total | Total number of actors |
| Built-in | Count of built-in actors |
| Custom | Count of custom actors |
| Unsafe | Count of actors marked unsafe |
| Providers Used | Number of distinct providers |
Followed by a `✓ OK N actors listed` success message.
### Examples
```bash
+9 -1
View File
@@ -31,11 +31,19 @@ agents version [--format rich|plain|json|yaml]
| `channel` | string | Release channel (`stable`) |
| `python` | string | Python runtime version |
| `build_date` | string | ISO date of build (`YYYY-MM-DD`) |
| `commit` | string | Short git SHA of HEAD |
| `commit` | string | Actual short git SHA of HEAD (from `CLEVERAGENTS_COMMIT` env var or `git rev-parse --short HEAD`; `"unknown"` if neither is available) |
| `schema` | string | Data schema version (`v3`) |
| `platform` | string | OS and architecture |
| `dependencies` | object | Key dependency versions (langgraph, langchain-core, pydantic, typer) |
### Commit SHA Resolution
The `commit` field is resolved in the following order:
1. `CLEVERAGENTS_COMMIT` environment variable — set at build time (e.g. in Docker or CI).
2. `git rev-parse --short HEAD` — used when running from source with git available.
3. `"unknown"` — fallback when neither source is available.
### Sample output — rich (default)
```
+19 -3
View File
@@ -116,10 +116,26 @@ agents plan list [REGEX] [OPTIONS]
| `--action` | Filter by action name |
| `--format`, `-f` | Output format |
### Output Fields
### Rich Output
Includes **Profile** and **Invariants** columns in all output formats
when present on the plan.
The `rich` format renders a **Plans** table with columns:
| Column | Description |
|--------|-------------|
| ID | Truncated plan ULID (8 chars) |
| Phase | Current lifecycle phase |
| State | Processing state |
| Action | Action name |
| Project | First linked project name (or `(none)`) |
| Elapsed | Wall-clock time since plan creation (`HH:MM:SS`) |
After the table:
- **Filters** panel — shown only when at least one filter (`--phase`, `--state`,
`--project`, `--action`) is active. Lists the active filter values.
- **Summary** panel — total plans, processing count, completed count, and errored count.
Followed by a `✓ OK N plan(s) listed` success message.
## `agents plan execute`
+77 -9
View File
@@ -10,7 +10,7 @@ The `agents session` command group manages **sessions** — persistent conversat
| `agents session list` | List all sessions |
| `agents session show` | Show session details and recent messages |
| `agents session delete` | Delete a session permanently |
| `agents session export` | Export a session as JSON |
| `agents session export` | Export a session as JSON or Markdown |
| `agents session import` | Import a session from JSON |
| `agents session tell` | Send a message to a session |
@@ -31,9 +31,15 @@ agents session create [--actor <ACTOR>] [--format <FORMAT>]
| `--actor` | Orchestrator actor name in `namespace/name` format |
| `--format`, `-f` | Output format: `json`, `yaml`, `plain`, `table`, `rich` (default: `rich`) |
### Output
### Rich Output Panels
Returns session info including `session_id`, `actor`, `created`, and `namespace`.
The `rich` format renders three panels:
- **Session** — session ID, actor, namespace, and creation timestamp.
- **Settings** — automation profile, streaming, context, memory, and max history.
- **Actor Details** — provider, model, temperature, and context window (only shown when an actor is bound).
Followed by a `✓ OK Session created` success message.
### Example
@@ -58,14 +64,41 @@ agents session list [--format <FORMAT>]
|------|-------------|
| `--format`, `-f` | Output format (default: `rich`) |
### Rich Output
The `rich` format renders a sessions table with columns: **ID**, **Name**, **Actor**,
**Messages**, and **Updated**. After the table, a **Summary** panel is shown with:
| Field | Description |
|-------|-------------|
| Total | Number of sessions |
| Most Recent | Name or truncated ID of the most recently updated session |
| Oldest | Name or truncated ID of the oldest session |
| Total Messages | Sum of messages across all sessions |
| Storage | Estimated storage used |
Followed by a `✓ OK N sessions listed` success message.
### JSON Output Shape
```json
{
"sessions": [
{"id": "...", "actor": "...", "messages": 5, "updated": "..."}
{
"id": "01HXYZ...",
"name": "my-session",
"actor": "openai/gpt-4",
"messages": 5,
"updated": "2026-04-02T21:56:04"
}
],
"total": 1
"summary": {
"total": 1,
"most_recent": "my-session",
"oldest": "my-session",
"total_messages": 5,
"storage": "0 KB"
}
}
```
@@ -91,6 +124,16 @@ agents session show <SESSION_ID> [--format <FORMAT>]
|------|-------------|
| `--format`, `-f` | Output format (default: `rich`) |
### Rich Output Panels
- **Session Summary** — session ID, actor, namespace, message count, created/updated timestamps, and **Automation** profile.
- **Recent Messages** — table of the last 5 messages (role, content preview, timestamp).
- **Linked Plans** — list of plan IDs linked to this session (if any).
- **Token Usage** — input tokens, output tokens, and estimated cost.
- **Cost Budget** — total cost, max cost, utilization percentage, and remaining budget (if a budget is configured).
Followed by a `✓ OK Session details loaded` success message.
---
## `agents session delete`
@@ -113,14 +156,23 @@ agents session delete <SESSION_ID> [--yes]
|------|-------|-------------|
| `--yes` | `-y` | Skip confirmation prompt |
### Rich Output Panels
After deletion, the `rich` format renders:
- **Deletion Summary** — session ID, messages removed, storage freed, and plans orphaned.
- **Cleanup** — backup status, log preservation, context cleared, and checkpoint status.
Followed by a `✓ OK Session deleted` success message.
---
## `agents session export`
Export a session as JSON to a file or stdout.
Export a session as JSON or Markdown to a file or stdout.
```bash
agents session export <SESSION_ID> [--output <FILE>] [--force]
agents session export <SESSION_ID> [--output <FILE>] [--force] [--format <FORMAT>]
```
### Arguments
@@ -135,12 +187,29 @@ agents session export <SESSION_ID> [--output <FILE>] [--force]
|------|-------|-------------|
| `--output` | `-o` | Output file path (default: stdout) |
| `--force` | | Overwrite existing output file |
| `--format` | | Export format: `json` (default, re-importable) or `md` (Markdown transcript, lossy) |
### Notes
- Parent directories are created automatically when writing to a file.
- Without `--force`, the command refuses to overwrite an existing file.
- The exported JSON includes a SHA-256 checksum for integrity validation.
- The exported JSON includes a `sha256:`-prefixed checksum for integrity validation.
- The `md` format produces a human-readable Markdown transcript with session metadata,
full message history (role/timestamp/content), and linked plan references. It cannot
be re-imported.
### Examples
```bash
# Export as JSON (default)
agents session export 01HXYZ... -o session.json
# Export as Markdown transcript
agents session export 01HXYZ... --format md -o session.md
# Overwrite existing file
agents session export 01HXYZ... -o session.json --force
```
---
@@ -189,7 +258,6 @@ agents session tell --session <SESSION_ID> [--actor <ACTOR>] [--stream] <PROMPT>
### Notes
- In M3, actor execution is stubbed — the assistant echoes an acknowledgement.
- Both user and assistant messages are persisted with sequence ordering.
- The session's `updated_at` timestamp is refreshed after each message.