On this page
Manage and run agents defined in .agent.json files.
#claudestream agent
Manage and run agents defined in .agent.json files. Agent definitions declare a model, prompt template, allowed tools with input schemas, sandbox permissions, and budget limits (cost, turns, tokens). Use subcommands to validate configurations, run agents against prompts, and inspect metadata.
#agent run
Load an agent definition and run it with the given prompt. Accepts a path to a .agent.json file or a bare agent name (resolved from .claudestream/agents/). The definition specifies the model, a prompt template with {variable} placeholders, tool schemas, sandbox policy, and budget constraints. Use --var key=value to substitute template variables. Use --model to override the model declared in the definition.
Effect: mutating
#Flags
| Name | Short | Type | Presence | Env | Description |
|---|---|---|---|---|---|
--var | list[str] | default: [] | Template variable in key=value format, repeatable for multiple variables | ||
--model | -m | str | optional | Override the model declared in the agent definition file; when omitted the definition's own model is used | |
--profile | str | required | Name of the claudewheel profile to use for authentication | ||
--cwd | str | optional | Working directory path for the Claude Code process to operate in; when omitted the subprocess inherits this process's directory | ||
--footer, --no-footer | bool | optional | Display cost and timing summary on stderr after completion (displayed when neither --footer nor --no-footer is passed) | ||
--color, --no-color | bool | optional | Enable ANSI colored output for terminal display and formatting (enabled, subject to TTY and NO_COLOR detection, when neither --color nor --no-color is passed) |
#Arguments
| Name | Type | Presence | Description |
|---|---|---|---|
definition | str | required | Agent name or filesystem path to a .agent.json definition file |
prompt | str | required | User message prompt to send to the agent for processing |
#agent list
List available agents from .claudestream/agents/. Scans the agents directory in the working directory (or the directory specified by --cwd) and prints a table with each agent's name, schema version, and description. Use this to discover which agents are configured before running one with 'agent run'.
Effect: read_only
#Flags
| Name | Short | Type | Presence | Env | Description |
|---|---|---|---|---|---|
--cwd | str | optional | Working directory path to scan for agent definitions; when omitted the current directory is scanned |
#agent info
Display agent definition details for a given agent name or path. Loads the .agent.json file, parses it, and prints every configured field: name, version, description, model, budget limits, sandbox policy, tool schemas, MCP server config, and stream options. Use this to inspect an agent's full configuration before invoking it.
Effect: read_only
#Arguments
| Name | Type | Presence | Description |
|---|---|---|---|
name | str | required | Agent name or filesystem path to the .agent.json definition |
#agent validate
Validate an agent definition by loading and checking its .agent.json file for structural and semantic correctness. Verifies that budget values are non-negative, the prompt template is non-empty, tool schemas are well-formed, and required fields are present. Reports specific errors on failure or prints a success confirmation.
Effect: read_only
#Arguments
| Name | Type | Presence | Description |
|---|---|---|---|
name | str | required | Agent name or filesystem path to the .agent.json definition |