Skip to content

docs: update CLI command reference with missing commands, options, and aliases#581

Merged
notgitika merged 1 commit intoaws:mainfrom
notgitika:docs/cli-command-ref-update
Mar 20, 2026
Merged

docs: update CLI command reference with missing commands, options, and aliases#581
notgitika merged 1 commit intoaws:mainfrom
notgitika:docs/cli-command-ref-update

Conversation

@notgitika
Copy link
Contributor

@notgitika notgitika commented Mar 19, 2026

Description

Updates docs/commands.md and AGENTS.md to reflect the current state of all implemented CLI commands. The command reference was missing several commands, options, and had some inaccuracies.

Closes #581

Changes

docs/commands.md

  • New sections: Command aliases table, Observability (logs, traces), help command, Debugging with Traces and Logs pattern
  • create: Added --protocol, --network-mode, --subnets, --security-groups, CrewAI to frameworks list
  • deploy: Added --target, --plan, --diff flags
  • status: Added --target, --type, --state, --json flags with full descriptions
  • add agent: Added --protocol, --network-mode, --subnets, --security-groups; explicit framework/provider values
  • add memory: Removed nonexistent --description and CUSTOM strategy; added min/max for expiry
  • add gateway: Added --agents, --no-semantic-search, --exception-level
  • add gateway-target: Added --tool-filter-description
  • dev: Added --tool, --input for MCP protocol; protocol port notes
  • invoke: Added --target, --user-id, --tool, --input, positional [prompt]; removed nonexistent --new-session
  • update: Added -c, --check flag
  • Updated CI/CD and JSON output common patterns

AGENTS.md

  • Fixed eval command names: run evalrun evals, eval historyevals history
  • Added missing commands: logs, logs evals, traces list, traces get
  • Added evaluator, online-eval to primitives architecture list

Testing

  • Verified all flags/options against source code in src/cli/commands/ and src/cli/primitives/
  • Docs-only change, no code modified

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

…d aliases

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.
@notgitika notgitika requested a review from a team March 19, 2026 22:36
@notgitika
Copy link
Contributor Author

Working on making all docs better — this is the first pass covering the command reference. More updates coming.

@notgitika notgitika merged commit 41b6c74 into aws:main Mar 20, 2026
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/m PR size: M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants