Skip to content

Commit 41b6c74

Browse files
authored
docs: update CLI command reference with missing commands, options, and aliases (#581)
Add command aliases table, observability section (logs, traces), and missing flags across create, deploy, status, invoke, dev, and other commands. Fix AGENTS.md eval command names and add logs/traces entries.
1 parent 686dbee commit 41b6c74

File tree

2 files changed

+270
-106
lines changed

2 files changed

+270
-106
lines changed

AGENTS.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,14 @@ Note: CDK L3 constructs are in a separate package `@aws/agentcore-cdk`.
3030
- `status` - Check deployment status
3131
- `dev` - Local development server (CodeZip: uvicorn with hot-reload; Container: Docker build + run with volume mount)
3232
- `invoke` - Invoke agents (local or deployed)
33-
- `run eval` - Run on-demand evaluation against agent sessions
34-
- `eval history` - View past eval run results
33+
- `run evals` - Run on-demand evaluation against agent sessions
34+
- `evals history` - View past eval run results
3535
- `pause online-eval` - Pause (disable) a deployed online eval config
3636
- `resume online-eval` - Resume (enable) a paused online eval config
37+
- `logs` - Stream or search agent runtime logs
38+
- `logs evals` - Stream or search online eval logs
39+
- `traces list` - List recent traces for a deployed agent
40+
- `traces get` - Download a trace to a JSON file
3741
- `package` - Package agent artifacts without deploying (zip for CodeZip, container image build for Container)
3842
- `validate` - Validate configuration files
3943
- `update` - Check for CLI updates
@@ -53,8 +57,8 @@ Note: CDK L3 constructs are in a separate package `@aws/agentcore-cdk`.
5357

5458
## Primitives Architecture
5559

56-
All resource types (agent, memory, identity, gateway, mcp-tool) are modeled as **primitives** -- self-contained classes
57-
in `src/cli/primitives/` that own the full add/remove lifecycle for their resource type.
60+
All resource types (agent, memory, identity, evaluator, online-eval, gateway, mcp-tool) are modeled as **primitives** --
61+
self-contained classes in `src/cli/primitives/` that own the full add/remove lifecycle for their resource type.
5862

5963
Each primitive extends `BasePrimitive` and implements: `add()`, `remove()`, `previewRemove()`, `getRemovable()`,
6064
`registerCommands()`, and `addScreen()`.

0 commit comments

Comments
 (0)