Skip to content

Commit 1b43c59

Browse files
aidandaly24aidandaly24
committed
docs: rename --agent flags to --runtime and remove stale type fields
Update all documentation to reflect upstream renames: - --agent → --runtime, -a → -r across all commands - --agent-arn → --runtime-arn, --agent-runtime-id → --runtime-id - Remove stale "type" fields from JSON examples in evals.md, memory.md, and container-builds.md Constraint: --agent-id, --agent-alias-id, --agent-client-id, --agent-client-secret are unchanged (different semantics) Constraint: --type agent filter value in status/fetch stays as-is Confidence: high Scope-risk: narrow
1 parent bc4a594 commit 1b43c59

File tree

5 files changed

+126
-131
lines changed

5 files changed

+126
-131
lines changed

‎docs/commands.md‎

Lines changed: 86 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -119,21 +119,21 @@ Check deployment status and resource details.
119119

120120
```bash
121121
agentcore status
122-
agentcore status --agent MyAgent
122+
agentcore status --runtime MyAgent
123123
agentcore status --type evaluator
124124
agentcore status --state deployed
125-
agentcore status --agent-runtime-id abc123
125+
agentcore status --runtime-id abc123
126126
agentcore status --json
127127
```
128128

129-
| Flag | Description |
130-
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
131-
| `--agent-runtime-id <id>` | Look up a specific agent runtime by ID |
132-
| `--target <name>` | Select deployment target |
133-
| `--type <type>` | Filter by resource type: `agent`, `memory`, `credential`, `gateway`, `evaluator`, `online-eval`, `policy-engine`, `policy` |
134-
| `--state <state>` | Filter by deployment state: `deployed`, `local-only`, `pending-removal` |
135-
| `--agent <name>` | Filter to a specific agent |
136-
| `--json` | JSON output |
129+
| Flag | Description |
130+
| ------------------- | -------------------------------------------------------------------------------------------------------------------------- |
131+
| `--runtime-id <id>` | Look up a specific runtime by ID |
132+
| `--target <name>` | Select deployment target |
133+
| `--type <type>` | Filter by resource type: `agent`, `memory`, `credential`, `gateway`, `evaluator`, `online-eval`, `policy-engine`, `policy` |
134+
| `--state <state>` | Filter by deployment state: `deployed`, `local-only`, `pending-removal` |
135+
| `--runtime <name>` | Filter to a specific runtime |
136+
| `--json` | JSON output |
137137

138138
### validate
139139

@@ -421,15 +421,15 @@ Add an online eval config for continuous agent monitoring.
421421
```bash
422422
agentcore add online-eval \
423423
--name QualityMonitor \
424-
--agent MyAgent \
424+
--runtime MyAgent \
425425
--evaluator ResponseQuality Builtin.Faithfulness \
426426
--sampling-rate 10
427427
```
428428

429429
| Flag | Description |
430430
| ---------------------------- | --------------------------------------------- |
431431
| `--name <name>` | Config name |
432-
| `-a, --agent <name>` | Agent to monitor |
432+
| `-r, --runtime <name>` | Runtime to monitor |
433433
| `-e, --evaluator <names...>` | Evaluator name(s), `Builtin.*` IDs, or ARNs |
434434
| `--evaluator-arn <arns...>` | Evaluator ARN(s) |
435435
| `--sampling-rate <rate>` | Percentage of requests to evaluate (0.01–100) |
@@ -471,25 +471,25 @@ Start local development server with hot-reload.
471471

472472
```bash
473473
agentcore dev
474-
agentcore dev --agent MyAgent --port 3000
474+
agentcore dev --runtime MyAgent --port 3000
475475
agentcore dev --logs # Non-interactive
476476
agentcore dev "Hello" --stream # Invoke running dev server
477-
agentcore dev "Hello" --agent MyAgent # Invoke specific agent
477+
agentcore dev "Hello" --runtime MyAgent # Invoke specific runtime
478478

479479
# MCP protocol dev commands
480480
agentcore dev list-tools
481481
agentcore dev call-tool --tool myTool --input '{"arg": "value"}'
482482
```
483483

484-
| Flag / Argument | Description |
485-
| -------------------- | ---------------------------------------------------- |
486-
| `[prompt]` | Send a prompt to a running dev server |
487-
| `-p, --port <port>` | Port (default: 8080; MCP uses 8000, A2A uses 9000) |
488-
| `-a, --agent <name>` | Agent to run or invoke (required if multiple agents) |
489-
| `-s, --stream` | Stream response when invoking |
490-
| `-l, --logs` | Non-interactive stdout logging |
491-
| `--tool <name>` | MCP tool name (with `call-tool` prompt) |
492-
| `--input <json>` | MCP tool arguments as JSON (with `--tool`) |
484+
| Flag / Argument | Description |
485+
| ---------------------- | -------------------------------------------------------- |
486+
| `[prompt]` | Send a prompt to a running dev server |
487+
| `-p, --port <port>` | Port (default: 8080; MCP uses 8000, A2A uses 9000) |
488+
| `-r, --runtime <name>` | Runtime to run or invoke (required if multiple runtimes) |
489+
| `-s, --stream` | Stream response when invoking |
490+
| `-l, --logs` | Non-interactive stdout logging |
491+
| `--tool <name>` | MCP tool name (with `call-tool` prompt) |
492+
| `--input <json>` | MCP tool arguments as JSON (with `--tool`) |
493493

494494
### invoke
495495

@@ -498,7 +498,7 @@ Invoke a deployed agent endpoint.
498498
```bash
499499
agentcore invoke "What can you do?"
500500
agentcore invoke --prompt "Hello" --stream
501-
agentcore invoke --agent MyAgent --target staging
501+
agentcore invoke --runtime MyAgent --target staging
502502
agentcore invoke --session-id abc123 # Continue session
503503
agentcore invoke --json # JSON output
504504

@@ -510,7 +510,7 @@ agentcore invoke call-tool --tool myTool --input '{"key": "value"}'
510510
| ------------------- | -------------------------------------------------------- |
511511
| `[prompt]` | Prompt text (positional argument) |
512512
| `--prompt <text>` | Prompt text (flag, takes precedence over positional) |
513-
| `--agent <name>` | Specific agent |
513+
| `--runtime <name>` | Specific runtime |
514514
| `--target <name>` | Deployment target |
515515
| `--session-id <id>` | Continue a specific session |
516516
| `--user-id <id>` | User ID for runtime invocation (default: `default-user`) |
@@ -529,21 +529,21 @@ Stream or search agent runtime logs.
529529

530530
```bash
531531
agentcore logs # Stream logs (follow mode)
532-
agentcore logs --agent MyAgent # Specific agent
532+
agentcore logs --runtime MyAgent # Specific runtime
533533
agentcore logs --since 1h --level error # Search last hour for errors
534534
agentcore logs --since 2d --until 1d --query "timeout"
535535
agentcore logs --json # JSON Lines output
536536
```
537537

538-
| Flag | Description |
539-
| ----------------- | -------------------------------------------------------------------------------- |
540-
| `--agent <name>` | Select specific agent |
541-
| `--since <time>` | Start time (defaults to 1h ago in search mode; e.g. `1h`, `30m`, `2d`, ISO 8601) |
542-
| `--until <time>` | End time (defaults to now in search mode; e.g. `now`, ISO 8601) |
543-
| `--level <level>` | Filter by log level: `error`, `warn`, `info`, `debug` |
544-
| `-n, --limit <n>` | Maximum number of log lines to return |
545-
| `--query <text>` | Server-side text filter |
546-
| `--json` | Output as JSON Lines |
538+
| Flag | Description |
539+
| ------------------ | -------------------------------------------------------------------------------- |
540+
| `--runtime <name>` | Select specific runtime |
541+
| `--since <time>` | Start time (defaults to 1h ago in search mode; e.g. `1h`, `30m`, `2d`, ISO 8601) |
542+
| `--until <time>` | End time (defaults to now in search mode; e.g. `now`, ISO 8601) |
543+
| `--level <level>` | Filter by log level: `error`, `warn`, `info`, `debug` |
544+
| `-n, --limit <n>` | Maximum number of log lines to return |
545+
| `--query <text>` | Server-side text filter |
546+
| `--json` | Output as JSON Lines |
547547

548548
### traces
549549

@@ -553,31 +553,31 @@ View and download agent traces.
553553

554554
```bash
555555
agentcore traces list
556-
agentcore traces list --agent MyAgent --limit 50
556+
agentcore traces list --runtime MyAgent --limit 50
557557
agentcore traces list --since 1h --until now
558558
```
559559

560-
| Flag | Description |
561-
| ---------------- | --------------------------------------------------------------------------- |
562-
| `--agent <name>` | Select specific agent |
563-
| `--limit <n>` | Maximum number of traces to display (default: 20) |
564-
| `--since <time>` | Start time (defaults to 12h ago; e.g. `5m`, `1h`, `2d`, ISO 8601, epoch ms) |
565-
| `--until <time>` | End time (defaults to now; e.g. `now`, `1h`, ISO 8601, epoch ms) |
560+
| Flag | Description |
561+
| ------------------ | --------------------------------------------------------------------------- |
562+
| `--runtime <name>` | Select specific runtime |
563+
| `--limit <n>` | Maximum number of traces to display (default: 20) |
564+
| `--since <time>` | Start time (defaults to 12h ago; e.g. `5m`, `1h`, `2d`, ISO 8601, epoch ms) |
565+
| `--until <time>` | End time (defaults to now; e.g. `now`, `1h`, ISO 8601, epoch ms) |
566566

567567
#### traces get
568568

569569
```bash
570570
agentcore traces get <traceId>
571-
agentcore traces get abc123 --agent MyAgent --output ./trace.json
571+
agentcore traces get abc123 --runtime MyAgent --output ./trace.json
572572
```
573573

574-
| Flag | Description |
575-
| ----------------- | -------------------------------- |
576-
| `<traceId>` | Trace ID to retrieve (required) |
577-
| `--agent <name>` | Select specific agent |
578-
| `--output <path>` | Output file path |
579-
| `--since <time>` | Start time (defaults to 12h ago) |
580-
| `--until <time>` | End time (defaults to now) |
574+
| Flag | Description |
575+
| ------------------ | -------------------------------- |
576+
| `<traceId>` | Trace ID to retrieve (required) |
577+
| `--runtime <name>` | Select specific runtime |
578+
| `--output <path>` | Output file path |
579+
| `--since <time>` | Start time (defaults to 12h ago) |
580+
| `--until <time>` | End time (defaults to now) |
581581

582582
---
583583

@@ -591,42 +591,42 @@ Run on-demand evaluation against historical agent traces.
591591

592592
```bash
593593
# Project mode
594-
agentcore run eval --agent MyAgent --evaluator ResponseQuality --days 7
594+
agentcore run eval --runtime MyAgent --evaluator ResponseQuality --days 7
595595

596596
# Standalone mode (no project required)
597597
agentcore run eval \
598-
--agent-arn arn:aws:...:runtime/abc123 \
598+
--runtime-arn arn:aws:...:runtime/abc123 \
599599
--evaluator-arn arn:aws:...:evaluator/eval123 \
600600
--region us-east-1
601601
```
602602

603-
| Flag | Description |
604-
| ---------------------------- | ----------------------------------------- |
605-
| `-a, --agent <name>` | Agent name from project |
606-
| `--agent-arn <arn>` | Agent runtime ARN (standalone mode) |
607-
| `-e, --evaluator <names...>` | Evaluator name(s) or `Builtin.*` IDs |
608-
| `--evaluator-arn <arns...>` | Evaluator ARN(s) (use with `--agent-arn`) |
609-
| `--region <region>` | AWS region (required with `--agent-arn`) |
610-
| `-s, --session-id <id>` | Evaluate a specific session |
611-
| `-t, --trace-id <id>` | Evaluate a specific trace |
612-
| `--days <days>` | Lookback window in days (default: 7) |
613-
| `--output <path>` | Custom output file path |
614-
| `--json` | JSON output |
603+
| Flag | Description |
604+
| ---------------------------- | ------------------------------------------- |
605+
| `-r, --runtime <name>` | Runtime name from project |
606+
| `--runtime-arn <arn>` | Runtime ARN (standalone mode) |
607+
| `-e, --evaluator <names...>` | Evaluator name(s) or `Builtin.*` IDs |
608+
| `--evaluator-arn <arns...>` | Evaluator ARN(s) (use with `--runtime-arn`) |
609+
| `--region <region>` | AWS region (required with `--runtime-arn`) |
610+
| `-s, --session-id <id>` | Evaluate a specific session |
611+
| `-t, --trace-id <id>` | Evaluate a specific trace |
612+
| `--days <days>` | Lookback window in days (default: 7) |
613+
| `--output <path>` | Custom output file path |
614+
| `--json` | JSON output |
615615

616616
### evals history
617617

618618
View past on-demand eval run results.
619619

620620
```bash
621621
agentcore evals history
622-
agentcore evals history --agent MyAgent --limit 5 --json
622+
agentcore evals history --runtime MyAgent --limit 5 --json
623623
```
624624

625-
| Flag | Description |
626-
| --------------------- | -------------------- |
627-
| `-a, --agent <name>` | Filter by agent name |
628-
| `-n, --limit <count>` | Max runs to display |
629-
| `--json` | JSON output |
625+
| Flag | Description |
626+
| ---------------------- | ---------------------- |
627+
| `-r, --runtime <name>` | Filter by runtime name |
628+
| `-n, --limit <count>` | Max runs to display |
629+
| `--json` | JSON output |
630630

631631
### pause online-eval
632632

@@ -665,18 +665,18 @@ agentcore resume online-eval --arn arn:aws:...:online-eval-config/abc123
665665
Stream or search online eval logs.
666666

667667
```bash
668-
agentcore logs evals --agent MyAgent --since 1h
668+
agentcore logs evals --runtime MyAgent --since 1h
669669
agentcore logs evals --follow --json
670670
```
671671

672-
| Flag | Description |
673-
| --------------------- | --------------------------------------------- |
674-
| `-a, --agent <name>` | Filter by agent |
675-
| `--since <time>` | Start time (e.g. `1h`, `30m`, `2d`, ISO 8601) |
676-
| `--until <time>` | End time |
677-
| `-n, --limit <count>` | Maximum log lines |
678-
| `-f, --follow` | Stream in real-time |
679-
| `--json` | JSON Lines output |
672+
| Flag | Description |
673+
| ---------------------- | --------------------------------------------- |
674+
| `-r, --runtime <name>` | Filter by runtime |
675+
| `--since <time>` | Start time (e.g. `1h`, `30m`, `2d`, ISO 8601) |
676+
| `--until <time>` | End time |
677+
| `-n, --limit <count>` | Maximum log lines |
678+
| `-f, --follow` | Stream in real-time |
679+
| `--json` | JSON Lines output |
680680

681681
---
682682

@@ -705,14 +705,14 @@ Package agent artifacts without deploying.
705705

706706
```bash
707707
agentcore package
708-
agentcore package --agent MyAgent
708+
agentcore package --runtime MyAgent
709709
agentcore package -d ./my-project
710710
```
711711

712-
| Flag | Description |
713-
| ------------------------ | ---------------------- |
714-
| `-d, --directory <path>` | Project directory |
715-
| `-a, --agent <name>` | Package specific agent |
712+
| Flag | Description |
713+
| ------------------------ | ------------------------ |
714+
| `-d, --directory <path>` | Project directory |
715+
| `-r, --runtime <name>` | Package specific runtime |
716716

717717
### update
718718

@@ -773,13 +773,13 @@ agentcore deploy -y
773773

774774
```bash
775775
# Stream runtime logs
776-
agentcore logs --agent MyAgent
776+
agentcore logs --runtime MyAgent
777777

778778
# Search for errors in the last 2 hours
779779
agentcore logs --since 2h --level error
780780

781781
# List recent traces
782-
agentcore traces list --agent MyAgent --limit 10
782+
agentcore traces list --runtime MyAgent --limit 10
783783

784784
# Download a specific trace
785785
agentcore traces get <traceId> --output ./debug-trace.json

‎docs/container-builds.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ In `agentcore.json`, set `"build": "Container"`:
5454

5555
```json
5656
{
57-
"type": "AgentCoreRuntime",
5857
"name": "MyAgent",
5958
"build": "Container",
6059
"entrypoint": "main.py",

0 commit comments

Comments
 (0)