From 800961309a545244679e8b63914597e0d8d562db Mon Sep 17 00:00:00 2001 From: HAL 9000 Date: Tue, 7 Apr 2026 15:12:26 +0000 Subject: [PATCH] docs: align CLI showcase bundle with review feedback --- .../cli-tools/actor-management-workflow.md | 62 +++++----- .../cli-tools/audit-log-and-security.md | 2 +- .../showcase/cli-tools/output-format-flags.md | 6 +- .../cli-tools/repo-indexing-workflows.md | 2 +- .../cli-tools/server-and-a2a-integration.md | 6 +- .../cli-tools/session-management-workflows.md | 82 ++++++------- docs/showcase/examples.json | 112 +++++++++++++++++- 7 files changed, 190 insertions(+), 82 deletions(-) diff --git a/docs/showcase/cli-tools/actor-management-workflow.md b/docs/showcase/cli-tools/actor-management-workflow.md index dbb9664db..65edb7899 100644 --- a/docs/showcase/cli-tools/actor-management-workflow.md +++ b/docs/showcase/cli-tools/actor-management-workflow.md @@ -33,12 +33,12 @@ actor, switching the default, and cleaning up — all from the command line. Start by seeing what actor management commands are available: ```bash -$ python -m cleveragents actor --help +$ agents actor --help ``` **Actual Output:** ``` - Usage: python -m cleveragents actor [OPTIONS] COMMAND [ARGS]... + Usage: agents actor [OPTIONS] COMMAND [ARGS]... Actor management (built-ins /; customs local/; unsafe requires --unsafe) @@ -69,7 +69,7 @@ you register yourself use the `local/` namespace. ### Step 2: List All Actors (Rich Table) ```bash -$ python -m cleveragents actor list +$ agents actor list ``` **Actual Output:** @@ -105,7 +105,7 @@ a quick breakdown of total, built-in, custom, unsafe, and provider counts. ### Step 3: List Actors in JSON Format (for Scripting) ```bash -$ python -m cleveragents actor list --format json +$ agents actor list --format json ``` **Actual Output (abbreviated):** @@ -183,7 +183,7 @@ actors by capability. ### Step 4: Inspect a Specific Actor ```bash -$ python -m cleveragents actor show openai/gpt-4o +$ agents actor show openai/gpt-4o ``` **Actual Output:** @@ -199,7 +199,7 @@ $ python -m cleveragents actor show openai/gpt-4o ``` ```bash -$ python -m cleveragents actor show anthropic/claude-sonnet-4-20250514 +$ agents actor show anthropic/claude-sonnet-4-20250514 ``` **Actual Output:** @@ -217,7 +217,7 @@ $ python -m cleveragents actor show anthropic/claude-sonnet-4-20250514 For full machine-readable detail including capabilities: ```bash -$ python -m cleveragents actor show openai/gpt-4o --format json +$ agents actor show openai/gpt-4o --format json ``` **Actual Output:** @@ -291,7 +291,7 @@ EOF Then register it: ```bash -$ python -m cleveragents actor add local/my-haiku-actor --config my-haiku-actor.yaml +$ agents actor add local/my-haiku-actor --config my-haiku-actor.yaml ``` **Actual Output:** @@ -326,7 +326,7 @@ The `add` command: The `--format json` flag is also supported for scripting: ```bash -$ python -m cleveragents actor add local/my-haiku-actor --config my-haiku-actor.yaml --format json +$ agents actor add local/my-haiku-actor --config my-haiku-actor.yaml --format json ``` > **Note:** Re-running `add` on an existing actor name will fail with an @@ -337,7 +337,7 @@ $ python -m cleveragents actor add local/my-haiku-actor --config my-haiku-actor. ### Step 6: Verify the Actor Appears in the List ```bash -$ python -m cleveragents actor list +$ agents actor list ``` **Actual Output:** @@ -373,7 +373,7 @@ can be removed, unlike built-ins. ### Step 7: Switch the Default Actor ```bash -$ python -m cleveragents actor set-default local/my-haiku-actor +$ agents actor set-default local/my-haiku-actor ``` **Actual Output:** @@ -397,7 +397,7 @@ default automatically clears the previous one. You can also set a built-in as the default: ```bash -$ python -m cleveragents actor set-default anthropic/claude-sonnet-4-20250514 +$ agents actor set-default anthropic/claude-sonnet-4-20250514 ``` **Actual Output:** @@ -420,7 +420,7 @@ You can patch individual actor options without rewriting the whole config file using `actor update --option`: ```bash -$ python -m cleveragents actor update local/my-haiku-actor --option temperature=0.7 +$ agents actor update local/my-haiku-actor --option temperature=0.7 ``` **Actual Output:** @@ -441,7 +441,7 @@ actor's `options` blob without touching the rest of the config. Repeat the flag to set multiple options at once: ```bash -$ python -m cleveragents actor update local/my-haiku-actor \ +$ agents actor update local/my-haiku-actor \ --option temperature=0.5 \ --option max_tokens=2048 ``` @@ -454,8 +454,8 @@ Before removing, switch the default back to a built-in (you cannot remove the default actor): ```bash -$ python -m cleveragents actor set-default openai/gpt-4o -$ python -m cleveragents actor remove local/my-haiku-actor +$ agents actor set-default openai/gpt-4o +$ agents actor remove local/my-haiku-actor ``` **Actual Output:** @@ -514,7 +514,7 @@ All built-in actors support streaming, tool calls, and vision. ### Find the Default Actor ```bash -python -m cleveragents actor list --format json | python3 -c " +agents actor list --format json | python3 -c " import sys, json actors = json.load(sys.stdin)['data'] default = next((a for a in actors if a['is_default']), None) @@ -526,7 +526,7 @@ if default: ### List Actors with Vision Support ```bash -python -m cleveragents actor list --format json | python3 -c " +agents actor list --format json | python3 -c " import sys, json actors = json.load(sys.stdin)['data'] for a in actors: @@ -539,7 +539,7 @@ for a in actors: ### Check if an Actor Exists ```bash -python -m cleveragents actor show openai/gpt-4o --format json 2>/dev/null \ +agents actor show openai/gpt-4o --format json 2>/dev/null \ && echo 'Actor exists' || echo 'Actor not found' ``` @@ -551,20 +551,20 @@ python -m cleveragents actor show openai/gpt-4o --format json 2>/dev/null \ Click to see the full verified command session ``` -$ python -m cleveragents actor --help - Usage: python -m cleveragents actor [OPTIONS] COMMAND [ARGS]... +$ agents actor --help + Usage: agents actor [OPTIONS] COMMAND [ARGS]... Actor management (built-ins /; customs local/; unsafe requires --unsafe) Commands: run, add, update, remove, list, show, set-default, context -$ python -m cleveragents actor list +$ agents actor list Actors (5 total) [table with 5 built-in actors, openai/gpt-4o marked as default] ✓ OK 5 actors listed -$ python -m cleveragents actor list --format json +$ agents actor list --format json {"command":"","status":"ok","exit_code":0,"data":[...5 actors with full capability metadata...]} -$ python -m cleveragents actor show openai/gpt-4o +$ agents actor show openai/gpt-4o ╭─── Actor details ───╮ │ Name: openai/gpt-4o │ │ Provider: Openai │ @@ -574,7 +574,7 @@ $ python -m cleveragents actor show openai/gpt-4o │ Type: │ ╰─────────────────────╯ -$ python -m cleveragents actor show openai/gpt-4o --format json +$ agents actor show openai/gpt-4o --format json {"command":"","status":"ok","exit_code":0,"data":{"name":"openai/gpt-4o","provider":"Openai","model":"gpt-4o","unsafe":false,"is_default":true,"is_built_in":true,...}} $ cat > my-haiku-actor.yaml << 'EOF' @@ -583,7 +583,7 @@ model: claude-3-5-haiku-20241022 unsafe: false EOF -$ python -m cleveragents actor add local/my-haiku-actor --config my-haiku-actor.yaml +$ agents actor add local/my-haiku-actor --config my-haiku-actor.yaml ╭────────── Actor added ───────────╮ │ Name: local/my-haiku-actor │ │ Provider: Anthropic │ @@ -598,30 +598,30 @@ $ python -m cleveragents actor add local/my-haiku-actor --config my-haiku-actor. ╰───────────────────╯ ✓ OK Actor added -$ python -m cleveragents actor list +$ agents actor list Actors (6 total) [table now shows local/my-haiku-actor with Custom: 1 in summary] ✓ OK 6 actors listed -$ python -m cleveragents actor set-default local/my-haiku-actor +$ agents actor set-default local/my-haiku-actor ╭───── Default actor updated ──────╮ │ Name: local/my-haiku-actor │ │ Default: yes │ ╰──────────────────────────────────╯ -$ python -m cleveragents actor update local/my-haiku-actor --option temperature=0.7 +$ agents actor update local/my-haiku-actor --option temperature=0.7 ╭───────── Actor updated ──────────╮ │ Name: local/my-haiku-actor │ │ Default: yes │ ╰──────────────────────────────────╯ -$ python -m cleveragents actor set-default openai/gpt-4o +$ agents actor set-default openai/gpt-4o ╭─ Default actor updated ─╮ │ Name: openai/gpt-4o │ │ Default: yes │ ╰─────────────────────────╯ -$ python -m cleveragents actor remove local/my-haiku-actor +$ agents actor remove local/my-haiku-actor ╭─ Actor Removed ─╮ │ Name: local/my-haiku-actor │ ╰─────────────────────────────╯ diff --git a/docs/showcase/cli-tools/audit-log-and-security.md b/docs/showcase/cli-tools/audit-log-and-security.md index 023c69555..fd0becac3 100644 --- a/docs/showcase/cli-tools/audit-log-and-security.md +++ b/docs/showcase/cli-tools/audit-log-and-security.md @@ -17,7 +17,7 @@ interactive confirmation. ## Prerequisites - CleverAgents installed (`pip install cleveragents`) -- Python 3.12 or higher +- Python 3.13 or higher ## What You'll Learn diff --git a/docs/showcase/cli-tools/output-format-flags.md b/docs/showcase/cli-tools/output-format-flags.md index 28c892682..f839481ce 100644 --- a/docs/showcase/cli-tools/output-format-flags.md +++ b/docs/showcase/cli-tools/output-format-flags.md @@ -79,13 +79,17 @@ The output is wrapped in the **spec-required envelope**: | Field | Description | |---|---| -| `command` | The CLI command that was run | +| `command` | The CLI command that was run (blank for commands that do not report it) | | `status` | `"ok"`, `"warn"`, or `"error"` | | `exit_code` | `0` for success | | `data` | The command-specific payload | | `timing.duration_ms` | Elapsed time in milliseconds | | `messages` | Human-readable status messages | +> **Note:** Some legacy subcommands do not populate the `command` field. When that +> happens the value is an empty string (`""`), as shown in the diagnostics and +> actor examples below. The rest of the envelope fields are always present. + --- ### Step 2: Check the version in YAML format diff --git a/docs/showcase/cli-tools/repo-indexing-workflows.md b/docs/showcase/cli-tools/repo-indexing-workflows.md index c3337a163..e6e6f3067 100644 --- a/docs/showcase/cli-tools/repo-indexing-workflows.md +++ b/docs/showcase/cli-tools/repo-indexing-workflows.md @@ -12,7 +12,7 @@ installation**. ## Prerequisites - CleverAgents installed (`pip install cleveragents` or from source with `uv sync`) -- Python 3.12 or higher +- Python 3.13 or higher - At least one resource registered in the resource registry (see [Resource and Skill Management](resource-and-skill-management.md)) diff --git a/docs/showcase/cli-tools/server-and-a2a-integration.md b/docs/showcase/cli-tools/server-and-a2a-integration.md index 69c3131d3..b7124fcb2 100644 --- a/docs/showcase/cli-tools/server-and-a2a-integration.md +++ b/docs/showcase/cli-tools/server-and-a2a-integration.md @@ -12,7 +12,7 @@ operations directly to application services. ## Prerequisites - CleverAgents installed (`pip install cleveragents`) -- Python 3.12 or higher +- Python 3.13 or higher ## What You'll Learn @@ -1023,8 +1023,8 @@ $ agents server serve --host 127.0.0.1 --port 8080 --log-level debug ## Related Examples -- See [`config-and-automation-profiles.md`](config-and-automation-profiles.md) - for the full guide to configuration management and the five-level resolution chain +- See [`project-init-and-context-management.md`](project-init-and-context-management.md) + for the full guide to project configuration and the automation resolution chain - See [`output-format-flags.md`](output-format-flags.md) for the complete guide to `--format json/yaml/plain/table/rich` - See `docs/showcase/cli-tools/` for more CLI tool examples diff --git a/docs/showcase/cli-tools/session-management-workflows.md b/docs/showcase/cli-tools/session-management-workflows.md index 2cf15cb66..40bac9208 100644 --- a/docs/showcase/cli-tools/session-management-workflows.md +++ b/docs/showcase/cli-tools/session-management-workflows.md @@ -38,12 +38,12 @@ backup, and finally cleaning up — all from the command line. Start by seeing what session management commands are available: ```bash -$ python -m cleveragents session --help +$ agents session --help ``` **Actual Output:** ``` - Usage: python -m cleveragents session [OPTIONS] COMMAND [ARGS]... + Usage: agents session [OPTIONS] COMMAND [ARGS]... Manage interactive sessions. @@ -74,7 +74,7 @@ unique and time-ordered, making sessions naturally sortable by creation time. The simplest session creation — no actor bound, uses system defaults: ```bash -$ python -m cleveragents session create +$ agents session create ``` **Actual Output:** @@ -113,7 +113,7 @@ Bind a session to a specific actor so all messages in the session are processed by that actor: ```bash -$ python -m cleveragents session create --actor openai/gpt-4o +$ agents session create --actor openai/gpt-4o ``` **Actual Output:** @@ -149,7 +149,7 @@ actors (e.g. `openai/gpt-4o`, `anthropic/claude-sonnet-4-20250514`). For JSON output (useful in scripts): ```bash -$ python -m cleveragents session create --actor openai/gpt-4o --format json +$ agents session create --actor openai/gpt-4o --format json ``` **Actual Output:** @@ -171,7 +171,7 @@ $ python -m cleveragents session create --actor openai/gpt-4o --format json After creating a few sessions, list them all: ```bash -$ python -m cleveragents session list +$ agents session list ``` **Actual Output:** @@ -205,7 +205,7 @@ storage used. For machine-readable output: ```bash -$ python -m cleveragents session list --format json +$ agents session list --format json ``` **Actual Output:** @@ -244,7 +244,7 @@ $ python -m cleveragents session list --format json Use `session tell` to append a user message and receive an assistant response: ```bash -$ python -m cleveragents session tell \ +$ agents session tell \ --session 01HXYZ4M1Q3F0R0E5HR8K5T8A \ "What is the capital of France?" ``` @@ -258,7 +258,7 @@ assistant: Acknowledged: What is the capital of France? Send a follow-up message to build conversation history: ```bash -$ python -m cleveragents session tell \ +$ agents session tell \ --session 01HXYZ4M1Q3F0R0E5HR8K5T8A \ "Now explain the Eiffel Tower's history in one sentence." ``` @@ -272,7 +272,7 @@ assistant: Acknowledged: Now explain the Eiffel Tower's history in one sentence. You can also override the actor for a single message: ```bash -$ python -m cleveragents session tell \ +$ agents session tell \ --session 01HXYZ4M1Q3F0R0E5HR8K5T8A \ --actor anthropic/claude-sonnet-4-20250514 \ "Summarize our conversation so far." @@ -299,7 +299,7 @@ View the complete session state including recent messages, linked plans, and token usage: ```bash -$ python -m cleveragents session show 01HXYZ4M1Q3F0R0E5HR8K5T8A +$ agents session show 01HXYZ4M1Q3F0R0E5HR8K5T8A ``` **Actual Output:** @@ -334,7 +334,7 @@ $ python -m cleveragents session show 01HXYZ4M1Q3F0R0E5HR8K5T8A For JSON output (useful for scripting): ```bash -$ python -m cleveragents session show 01HXYZ4M1Q3F0R0E5HR8K5T8A --format json +$ agents session show 01HXYZ4M1Q3F0R0E5HR8K5T8A --format json ``` **Actual Output:** @@ -380,7 +380,7 @@ Plan ID, Phase, and State columns. If a cost budget is configured, a Export the full session data to a portable JSON file: ```bash -$ python -m cleveragents session export \ +$ agents session export \ --output /tmp/my-session-backup.json \ 01HXYZ4M1Q3F0R0E5HR8K5T8A ``` @@ -472,7 +472,7 @@ For human-readable sharing (e.g. documentation, code reviews), export as Markdown: ```bash -$ python -m cleveragents session export \ +$ agents session export \ --format md \ --output /tmp/my-session-transcript.md \ 01HXYZ4M1Q3F0R0E5HR8K5T8A @@ -538,7 +538,7 @@ Acknowledged: Now explain the Eiffel Tower's history in one sentence. Restore a previously exported session: ```bash -$ python -m cleveragents session import --input /tmp/my-session-backup.json +$ agents session import --input /tmp/my-session-backup.json ``` **Actual Output:** @@ -585,7 +585,7 @@ The import command: Delete a session permanently with the impact summary: ```bash -$ python -m cleveragents session delete --yes 01HXYZ3K9P2E9Q9D4GQ7J4S7Z +$ agents session delete --yes 01HXYZ3K9P2E9Q9D4GQ7J4S7Z ``` **Actual Output:** @@ -626,7 +626,7 @@ The delete command: ### Get the Most Recent Session ID ```bash -python -m cleveragents session list --format json | python3 -c " +agents session list --format json | python3 -c " import sys, json data = json.load(sys.stdin) sessions = data.get('sessions', []) @@ -641,7 +641,7 @@ else: ### Count Sessions by Actor ```bash -python -m cleveragents session list --format json | python3 -c " +agents session list --format json | python3 -c " import sys, json from collections import Counter data = json.load(sys.stdin) @@ -654,7 +654,7 @@ for actor, count in actors.most_common(): ### Backup All Sessions to Individual Files ```bash -python -m cleveragents session list --format json | python3 -c " +agents session list --format json | python3 -c " import sys, json, subprocess data = json.load(sys.stdin) for session in data.get('sessions', []): @@ -672,7 +672,7 @@ for session in data.get('sessions', []): ```bash SESSION_ID="01HXYZ4M1Q3F0R0E5HR8K5T8A" -python -m cleveragents session show "$SESSION_ID" --format json | python3 -c " +agents session show "$SESSION_ID" --format json | python3 -c " import sys, json data = json.load(sys.stdin) count = data['session_summary']['messages'] @@ -686,13 +686,13 @@ if count == 0: ```bash # Create session and capture the ID -SESSION_ID=$(python -m cleveragents session create --actor openai/gpt-4o --format json \ +SESSION_ID=$(agents session create --actor openai/gpt-4o --format json \ | python3 -c "import sys, json; print(json.load(sys.stdin)['session_id'])") echo "Created session: $SESSION_ID" # Send a message -python -m cleveragents session tell \ +agents session tell \ --session "$SESSION_ID" \ "Hello! Please introduce yourself." ``` @@ -725,12 +725,12 @@ The JSON export format (schema version `1.0`) contains: Click to see the full verified command session ``` -$ python -m cleveragents session --help - Usage: python -m cleveragents session [OPTIONS] COMMAND [ARGS]... +$ agents session --help + Usage: agents session [OPTIONS] COMMAND [ARGS]... Manage interactive sessions. Commands: create, list, show, delete, export, import, tell -$ python -m cleveragents session create +$ agents session create ╭─ Session ─╮ │ Session ID: 01HXYZ3K9P2E9Q9D4GQ7J4S7Z │ │ Actor: (none) │ @@ -746,7 +746,7 @@ $ python -m cleveragents session create ╰─────────────────────╯ ✓ OK Session created -$ python -m cleveragents session create --actor openai/gpt-4o +$ agents session create --actor openai/gpt-4o ╭─ Session ─╮ │ Session ID: 01HXYZ4M1Q3F0R0E5HR8K5T8A │ │ Actor: openai/gpt-4o │ @@ -768,26 +768,26 @@ $ python -m cleveragents session create --actor openai/gpt-4o ╰──────────────────╯ ✓ OK Session created -$ python -m cleveragents session list +$ agents session list [table with 2 sessions] ✓ OK 2 sessions listed -$ python -m cleveragents session list --format json +$ agents session list --format json {"sessions": [...], "summary": {"total": 2, "most_recent": "01HXYZ4M", ...}} -$ python -m cleveragents session tell --session 01HXYZ4M1Q3F0R0E5HR8K5T8A "What is the capital of France?" +$ agents session tell --session 01HXYZ4M1Q3F0R0E5HR8K5T8A "What is the capital of France?" user: What is the capital of France? assistant: Acknowledged: What is the capital of France? -$ python -m cleveragents session tell --session 01HXYZ4M1Q3F0R0E5HR8K5T8A "Now explain the Eiffel Tower's history in one sentence." +$ agents session tell --session 01HXYZ4M1Q3F0R0E5HR8K5T8A "Now explain the Eiffel Tower's history in one sentence." user: Now explain the Eiffel Tower's history in one sentence. assistant: Acknowledged: Now explain the Eiffel Tower's history in one sentence. -$ python -m cleveragents session tell --session 01HXYZ4M1Q3F0R0E5HR8K5T8A --actor anthropic/claude-sonnet-4-20250514 "Summarize our conversation so far." +$ agents session tell --session 01HXYZ4M1Q3F0R0E5HR8K5T8A --actor anthropic/claude-sonnet-4-20250514 "Summarize our conversation so far." user: Summarize our conversation so far. assistant: [anthropic/claude-sonnet-4-20250514] Acknowledged: Summarize our conversation so far. -$ python -m cleveragents session show 01HXYZ4M1Q3F0R0E5HR8K5T8A +$ agents session show 01HXYZ4M1Q3F0R0E5HR8K5T8A ╭─ Session Summary ─╮ │ ID: 01HXYZ4M1Q3F0R0E5HR8K5T8A │ │ Actor: openai/gpt-4o │ @@ -804,7 +804,7 @@ $ python -m cleveragents session show 01HXYZ4M1Q3F0R0E5HR8K5T8A ╰─────────────────╯ ✓ OK Session details loaded -$ python -m cleveragents session export --output /tmp/my-session-backup.json 01HXYZ4M1Q3F0R0E5HR8K5T8A +$ agents session export --output /tmp/my-session-backup.json 01HXYZ4M1Q3F0R0E5HR8K5T8A ╭─ Session Export ─╮ │ Session: 01HXYZ4M1Q3F0R0E5HR8K5T8A │ │ Output: /tmp/my-session-backup.json │ @@ -825,11 +825,11 @@ $ python -m cleveragents session export --output /tmp/my-session-backup.json 01H ╰──────────────╯ ✓ OK Export completed -$ python -m cleveragents session export --format md --output /tmp/my-session-transcript.md 01HXYZ4M1Q3F0R0E5HR8K5T8A +$ agents session export --format md --output /tmp/my-session-transcript.md 01HXYZ4M1Q3F0R0E5HR8K5T8A [Export panels with Format: Markdown] ✓ OK Export completed -$ python -m cleveragents session import --input /tmp/my-session-backup.json +$ agents session import --input /tmp/my-session-backup.json ╭─ Session Import ─╮ │ Input: /tmp/my-session-backup.json │ │ Session ID: 01HXYZ6Q4T6I3U3H8KU1N8W1D │ @@ -847,7 +847,7 @@ $ python -m cleveragents session import --input /tmp/my-session-backup.json ╰──────────╯ ✓ OK Import completed -$ python -m cleveragents session delete --yes 01HXYZ3K9P2E9Q9D4GQ7J4S7Z +$ agents session delete --yes 01HXYZ3K9P2E9Q9D4GQ7J4S7Z ╭─ Deletion Summary ─╮ │ Session: 01HXYZ3K9P2E9Q9D4GQ7J4S7Z │ │ Messages: 0 removed │ @@ -894,13 +894,13 @@ $ python -m cleveragents session delete --yes 01HXYZ3K9P2E9Q9D4GQ7J4S7Z - **Create a session and immediately send a message in one pipeline:** ```bash - SID=$(python -m cleveragents session create --format json | python3 -c "import sys,json; print(json.load(sys.stdin)['session_id'])") - python -m cleveragents session tell --session "$SID" "Hello!" + SID=$(agents session create --format json | python3 -c "import sys,json; print(json.load(sys.stdin)['session_id'])") + agents session tell --session "$SID" "Hello!" ``` - **Export all sessions to a backup directory:** ```bash mkdir -p ~/session-backups - python -m cleveragents session list --format json | python3 -c " + agents session list --format json | python3 -c " import sys, json, subprocess for s in json.load(sys.stdin)['sessions']: subprocess.run(['python', '-m', 'cleveragents', 'session', 'export', @@ -909,11 +909,11 @@ $ python -m cleveragents session delete --yes 01HXYZ3K9P2E9Q9D4GQ7J4S7Z ``` - **Stream a response in real-time:** ```bash - python -m cleveragents session tell --session --stream "Tell me a story." + agents session tell --session --stream "Tell me a story." ``` - **Inspect token usage across all sessions:** ```bash - python -m cleveragents session list --format json | python3 -c " + agents session list --format json | python3 -c " import sys, json data = json.load(sys.stdin) print(f\"Total sessions: {data['summary']['total']}\") diff --git a/docs/showcase/examples.json b/docs/showcase/examples.json index a9f1908f0..8228fdc2a 100644 --- a/docs/showcase/examples.json +++ b/docs/showcase/examples.json @@ -35,9 +35,7 @@ "agents actor show anthropic/claude-sonnet-4-20250514", "agents actor show openai/gpt-4o --format json", "agents actor add local/my-haiku-actor --config my-haiku-actor.yaml", - "agents actor add local/my-haiku-actor --config my-haiku-actor.yaml --format json", "agents actor set-default local/my-haiku-actor", - "agents actor set-default anthropic/claude-sonnet-4-20250514", "agents actor update local/my-haiku-actor --option temperature=0.7", "agents actor set-default openai/gpt-4o", "agents actor remove local/my-haiku-actor" @@ -68,6 +66,112 @@ "educational_value": "high", "generated_by": "uat-tester", "generated_at": "2026-04-07" + }, + { + "title": "Database Migration Management with agents db", + "category": "cli-tools", + "path": "cli-tools/database-migration-management.md", + "feature": "Database migration management", + "commands": [ + "agents db --help", + "agents db current", + "agents db history", + "agents db history --format json", + "agents db upgrade", + "agents db current --format json", + "agents db downgrade -- -1", + "agents db upgrade head" + ], + "complexity": "intermediate", + "educational_value": "high", + "generated_by": "uat-tester", + "generated_at": "2026-04-07" + }, + { + "title": "Managing Conversation Sessions with the CleverAgents CLI", + "category": "cli-tools", + "path": "cli-tools/session-management-workflows.md", + "feature": "Session management workflows", + "commands": [ + "agents session --help", + "agents session create", + "agents session create --actor openai/gpt-4o", + "agents session create --actor openai/gpt-4o --format json", + "agents session list", + "agents session list --format json", + "agents session tell --session \"prompt\"", + "agents session show ", + "agents session show --format json", + "agents session export --output file.json ", + "agents session export --format md --output file.md ", + "agents session import --input file.json", + "agents session delete --yes " + ], + "complexity": "intermediate", + "educational_value": "high", + "generated_by": "uat-tester", + "generated_at": "2026-04-07" + }, + { + "title": "Audit Log & Security: Tracking Every Security-Relevant Operation", + "category": "cli-tools", + "path": "cli-tools/audit-log-and-security.md", + "feature": "Audit log and security commands", + "commands": [ + "agents audit list", + "agents audit list --plan plan-abc123", + "agents audit list --type plan_applied", + "agents audit list --project my-webapp", + "agents audit list --limit 3", + "agents audit list --since 2026-03-31T14:43:41", + "agents audit show 1", + "agents audit count", + "agents audit prune --days 30 --yes", + "agents audit prune --days 30", + "agents audit prune --days 0" + ], + "complexity": "intermediate", + "educational_value": "high", + "generated_by": "uat-tester", + "generated_at": "2026-04-07" + }, + { + "title": "REPL and Actor Run: Interactive AI Sessions from the Terminal", + "category": "cli-tools", + "path": "cli-tools/repl-and-actor-run.md", + "feature": "REPL and interactive session", + "commands": [ + "agents repl", + "agents repl --no-history", + "agents actor run openai/gpt-4o \"Say hello\"", + "agents actor run local/demo-assistant \"prompt\" --config my-assistant.yaml", + "agents actor run local/demo-assistant \"prompt\" --output answer.txt", + "agents actor run local/demo-assistant \"prompt\" --temperature 0.9", + "agents actor run local/demo-assistant \"prompt\" --context my-session --context-dir /tmp/chats" + ], + "complexity": "intermediate", + "educational_value": "high", + "generated_by": "uat-tester", + "generated_at": "2026-04-07" + }, + { + "title": "Repository Indexing Workflows with CleverAgents", + "category": "cli-tools", + "path": "cli-tools/repo-indexing-workflows.md", + "feature": "Repo indexing workflows", + "commands": [ + "agents repo --help", + "agents repo index local/src-only", + "agents repo index local/src-only --full", + "agents repo index local/my-repo --format json", + "agents repo index local/my-repo --timeout-seconds 60", + "agents repo status local/src-only", + "agents repo status local/my-repo --format json" + ], + "complexity": "intermediate", + "educational_value": "high", + "generated_by": "uat-tester", + "generated_at": "2026-04-07" } ], "categories": { @@ -77,7 +181,7 @@ "keywords": ["CLI", "command-line", "terminal", "console", "tool"] }, "api-clients": { - "name": "API Clients", + "name": "API Clients", "description": "Command-line clients for web APIs", "keywords": ["API", "REST", "client", "HTTP", "web", "request"] }, @@ -92,5 +196,5 @@ "keywords": ["test", "pytest", "behave", "unittest", "automation", "QA"] } }, - "last_updated": null + "last_updated": "2026-04-07" } -- 2.52.0