Files
cleveragents-core/docs/showcase/examples.json
T
HAL9000 f38491e5a6 docs: add showcase example for CLI version/info/diagnostics basics
Add a verified CLI showcase for the version, info, and diagnostics commands,
register in examples.json and update CHANGELOG/CONTRIBUTORS.

ISSUES CLOSED: #7592
2026-06-14 23:57:38 -04:00

242 lines
8.8 KiB
JSON

{
"examples": [
{
"title": "Understanding CleverAgents CLI Version, Info, and Diagnostics Commands",
"category": "cli-tools",
"path": "cli-tools/cli-version-info-diagnostics.md",
"feature": "Version info diagnostics fast-path regular initialization",
"commands": [
"agents version",
"agents info",
"agents diagnostics",
"agents --format json version",
"agents --format json info",
"agents --format json diagnostics",
"agents --format yaml version",
"agents --format yaml info",
"agents --format yaml diagnostics"
],
"complexity": "beginner",
"educational_value": "high",
"generated_by": "uat-tester",
"generated_at": "2026-04-19"
},
{
"title": "CleverAgents CLI Basics: Version, Info & Diagnostics",
"category": "cli-tools",
"path": "cli-tools/cleveragents-cli-basics.md",
"feature": "CLI version/info/diagnostics basics \u2014 fast-path behavior and output envelope",
"commands": [
"python -m cleveragents --help",
"python -m cleveragents --version",
"python -m cleveragents version",
"python -m cleveragents --format json version",
"python -m cleveragents info",
"python -m cleveragents --format json info",
"python -m cleveragents diagnostics",
"python -m cleveragents --format json diagnostics",
"python -m cleveragents diagnostics --check"
],
"complexity": "beginner",
"educational_value": "high",
"generated_by": "uat-tester",
"generated_at": "2026-04-07"
},
{
"title": "Mastering Output Format Flags in CleverAgents CLI",
"category": "cli-tools",
"path": "cli-tools/output-format-flags.md",
"feature": "Output formats JSON YAML plain",
"commands": [
"agents --format json version",
"agents --format yaml version",
"agents --format plain version",
"agents -f json version",
"agents --format json info",
"agents --format json diagnostics",
"agents -f json actor list",
"agents -f yaml actor list",
"agents -f plain actor list"
],
"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": "Interactive REPL and single-shot actor run commands",
"commands": [
"agents repl",
"agents repl --help",
"agents actor run",
"agents actor run openai/gpt-4o \"Say hello\"",
"agents actor run --help",
"agents actor run local/demo-assistant \"What is the capital of France?\" --config my-assistant.yaml",
"agents actor run local/demo-assistant \"What is the capital of France?\" --config my-assistant.yaml --output answer.txt",
"agents actor run local/demo-assistant \"Write a haiku about mountains\" --config my-assistant.yaml --temperature 0.9",
"agents actor run local/demo-assistant \"I'm working on a Python project\" --config my-assistant.yaml --context my-session --context-dir /tmp/my-contexts",
"agents actor run local/demo-assistant \"What are best practices for error handling?\" --config my-assistant.yaml --context my-session --context-dir /tmp/my-contexts"
],
"complexity": "intermediate",
"educational_value": "high",
"generated_by": "uat-tester",
"generated_at": "2026-04-07"
},
{
"title": "Managing AI Actors with the CleverAgents CLI",
"category": "cli-tools",
"path": "cli-tools/actor-management-workflow.md",
"feature": "Actor management workflows",
"commands": [
"agents actor --help",
"agents actor list",
"agents actor list --format json",
"agents actor list --format yaml",
"agents actor show openai/gpt-4o",
"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"
],
"complexity": "intermediate",
"educational_value": "high",
"generated_by": "uat-tester",
"generated_at": "2026-04-07"
},
{
"title": "Server Connection and A2A Protocol Integration",
"category": "cli-tools",
"path": "cli-tools/server-and-a2a-integration.md",
"feature": "Server and A2A integration",
"commands": [
"agents server --help",
"agents server status",
"agents server status --format json",
"agents server connect https://agents.example.com",
"agents server connect https://agents.example.com --format json",
"agents server connect https://agents.example.com --namespace my-team --format json",
"agents server connect http://localhost:8080 --no-tls-verify --format json",
"agents server status --format yaml",
"agents server status --format plain",
"agents server serve --help"
],
"complexity": "advanced",
"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 management and security tracking",
"commands": [
"agents audit list",
"agents audit list --plan plan-abc123",
"agents audit list --type plan_applied",
"agents audit list --project data-pipeline",
"agents audit list --limit 3",
"agents audit list --since 2026-03-31T14:43:41",
"agents audit show 1",
"agents audit show 2",
"agents audit show 99999",
"agents audit count",
"agents audit prune --days 30 --yes",
"agents audit prune --days 30",
"agents audit prune --days 0",
"agents audit --help",
"agents audit list --help",
"agents audit show --help",
"agents audit prune --help"
],
"complexity": "intermediate",
"educational_value": "high",
"generated_by": "uat-tester",
"generated_at": "2026-04-07"
},
{
"title": "Managing Tools and Validations in CleverAgents",
"category": "cli-tools",
"path": "cli-tools/tool-and-validation-management.md",
"feature": "Tool and validation management",
"commands": [
"agents tool add --config examples/tools/custom-tool.yaml",
"agents validation add --config examples/validations/required-validation.yaml",
"agents validation add --config examples/validations/wrapped-validation.yaml",
"agents tool list",
"agents tool list --type validation",
"agents tool list --type tool",
"agents tool list --namespace qa",
"agents tool show local/line-counter",
"agents tool show qa/coverage-check",
"agents tool list --format json",
"agents tool show local/line-counter --format json",
"agents validation add --config examples/validations/required-validation.yaml --update",
"agents tool remove --yes local/line-counter"
],
"complexity": "intermediate",
"educational_value": "high",
"generated_by": "uat-tester",
"generated_at": "2026-04-07"
}
],
"categories": {
"cli-tools": {
"name": "CLI Tools",
"description": "Text-based command-line applications",
"keywords": [
"CLI",
"command-line",
"terminal",
"console",
"tool"
]
},
"api-clients": {
"name": "API Clients",
"description": "Command-line clients for web APIs",
"keywords": [
"API",
"REST",
"client",
"HTTP",
"web",
"request"
]
},
"data-processing": {
"name": "Data Processing",
"description": "Tools for data analysis and transformation",
"keywords": [
"data",
"CSV",
"JSON",
"parser",
"analyzer",
"transform"
]
},
"testing-tools": {
"name": "Testing Tools",
"description": "Testing utilities and automation",
"keywords": [
"test",
"pytest",
"behave",
"unittest",
"automation",
"QA"
]
}
},
"last_updated": "2026-05-07"
}