jiraya agent
Referência do comando jiraya agent da CLI do Jiraya: subcomandos, uso, flags e exemplos, gerados a partir da ajuda.
Work with agents
Subcomandos
| Comando | Descrição |
|---|---|
jiraya agent archive | Archive an agent |
jiraya agent avatar | Upload an avatar image for an agent |
jiraya agent copy | Copy an existing agent into a new one (optionally on a different runtime) |
jiraya agent create | Create a new agent |
jiraya agent env | Read and update an agent's custom environment variables (audited) |
jiraya agent get | Get agent details |
jiraya agent list | List agents in the workspace |
jiraya agent mcp | Manage which workspace MCP servers an agent uses |
jiraya agent restore | Restore an archived agent |
jiraya agent skills | Manage agent skill assignments |
jiraya agent tasks | List runs for an agent |
jiraya agent update | Update an agent |
jiraya agent archive
Archive an agent
Uso
jiraya agent archive <id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | json |
jiraya agent avatar
Upload an avatar image for an agent
Uso
jiraya agent avatar <id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--file string | Path to the avatar image file (required) | |
--output string | Output format: table or json | json |
jiraya agent copy
Copy an existing agent into a new one (optionally on a different runtime)
Copy an existing agent's portable configuration into a brand-new agent.
The source agent is left untouched. By default the copy lands on the same runtime as the source; pass --runtime-id to fork it onto a different runtime.
Copied by default without a dedicated override flag: conversation starters.
Copied by default, each overridable with the matching flag: name (suffixed " (copy)"), description, instructions, avatar, custom_args, max_concurrent_tasks, invocation permission (permission_mode + allow-list), assigned workspace skills, and — only when the target runtime is unchanged — model, thinking_level and service_tier.
Secret and machine-local fields are never copied: custom_env, mcp_config and runtime_config. Supply fresh values for the copy with the same secret-safe flags as 'agent create' when the target machine needs them.
Runtime-specific fields do not travel across a runtime change: when --runtime-id selects a different runtime, --model is required (pass --model "" to accept the target runtime's default), and thinking_level / service_tier are dropped unless set explicitly.
Uso
jiraya agent copy <source-agent-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--custom-args string | Override custom CLI arguments as a JSON array. | |
--custom-env string | Set custom_env on the copy as a JSON object (never copied from the source). Prefer --custom-env-stdin/--custom-env-file for secrets. Pass '{}' for an empty map. | |
--custom-env-file string | Read --custom-env from a file path (suggested mode: 0600). Mutually exclusive with --custom-env and --custom-env-stdin. | |
--custom-env-stdin | Read --custom-env from stdin. Mutually exclusive with --custom-env and --custom-env-file. | |
--description string | Override the copied description | |
--instructions string | Override the copied instructions | |
--max-concurrent-tasks int32 | Override maximum concurrent tasks | 6 |
--mcp-config string | Set mcp_config on the copy as a JSON object (never copied from the source). Prefer --mcp-config-stdin/--mcp-config-file for secrets. | |
--mcp-config-file string | Read --mcp-config from a file path (suggested mode: 0600). Mutually exclusive with --mcp-config and --mcp-config-stdin. | |
--mcp-config-stdin | Read --mcp-config from stdin. Mutually exclusive with --mcp-config and --mcp-config-file. | |
--model string | Model identifier for the copy. Required when --runtime-id selects a different runtime (pass "" to accept the target runtime default). Empty otherwise = runtime default. | |
--name string | Name for the new agent (default: "<source name> (copy)") | |
--no-skills | Do not copy the source agent's workspace skill assignments. | |
--output string | Output format: table or json | json |
--permission-mode string | Override invocation permission mode: private or public_to. Authoritative over --visibility. | |
--public-to-member strings | public_to: allow the given member user id(s) to invoke the copy. Repeatable. | |
--public-to-workspace | public_to: allow every workspace member to invoke the copy. | |
--runtime-config string | Set runtime_config on the copy as a JSON string (never copied from the source). | |
--runtime-id string | Target runtime ID (default: the source agent's runtime). A different value forks the agent onto that runtime. | |
--service-tier string | Override Codex service tier. Not carried across a runtime change unless set here. | |
--thinking-level string | Override thinking level. Not carried across a runtime change unless set here. | |
--visibility string | Override visibility: private or workspace (legacy; mapped to --permission-mode) |
jiraya agent create
Create a new agent
Uso
jiraya agent create [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--conversation-starters string | Conversation starters as a JSON array of {"label","prompt"} objects (at most 3; label ≤80, prompt ≤4000). Shown above the Chat composer; selecting one fills the composer and does not start a run. Omit to default to none. | |
--custom-args string | Custom CLI arguments as JSON array. For model selection prefer --model; some providers (codex app-server, openclaw) reject --model in custom_args. | |
--custom-env string | Custom environment variables as JSON object, e.g. '{"KEY":"value"}'. Treated as secret material — never logged by the CLI, but values passed on the command line are visible to shell history and 'ps'; prefer --custom-env-stdin or --custom-env-file for real secrets. Pass '{}' to set an empty map. | |
--custom-env-file string | Read the --custom-env JSON object from a file path (suggested mode: 0600). Mutually exclusive with --custom-env and --custom-env-stdin. | |
--custom-env-stdin | Read the --custom-env JSON object from stdin. Keeps secrets out of shell history and 'ps'. Mutually exclusive with --custom-env and --custom-env-file. | |
--description string | Agent description | |
--instructions string | Agent instructions | |
--max-concurrent-tasks int32 | Maximum concurrent runs (1-50) | 6 |
--mcp-config string | MCP server configuration as a JSON object, e.g. '{"mcpServers":{"shortcut":{...}}}'. Treated as secret material (MCP entries often carry API tokens) — never logged by the CLI, but values passed on the command line are visible to shell history and 'ps'; prefer --mcp-config-stdin or --mcp-config-file for real secrets. | |
--mcp-config-file string | Read the --mcp-config JSON object from a file path (suggested mode: 0600). Mutually exclusive with --mcp-config and --mcp-config-stdin. | |
--mcp-config-stdin | Read the --mcp-config JSON object from stdin. Keeps secrets out of shell history and 'ps'. Mutually exclusive with --mcp-config and --mcp-config-file. | |
--model string | Model identifier (e.g. claude-sonnet-4-6, openai/gpt-4o). Prefer this over passing --model in --custom-args. | |
--name string | Agent name (required) | |
--output string | Output format: table or json | json |
--permission-mode string | Invocation permission mode: private (owner only) or public_to (allow-list via --public-to-*). Authoritative over --visibility when set. | |
--public-to-member strings | public_to: allow the given member user id(s) to invoke this agent. Repeatable. | |
--public-to-workspace | public_to: allow every workspace member to invoke this agent. | |
--runtime-config string | Runtime config as JSON string | |
--runtime-id string | Runtime ID (required) | |
--service-tier string | Codex execution speed: empty = inherit local Codex configuration; default = explicit Standard when supported by the daemon's installed Codex CLI; a catalog tier such as priority = explicit Fast. | |
--thinking-level string | Reasoning/effort level for the agent's runtime (e.g. Claude: low|medium|high|xhigh|max; Codex values come from the runtime model catalog). The set is runtime/model-specific; malformed values are rejected server-side and the daemon validates the exact model/level pair. Some runtimes (e.g. hermes) expose no reasoning control and reject every value. Empty = runtime default. | |
--visibility string | Visibility: private or workspace (legacy; mapped to --permission-mode. private->private, workspace->public_to+workspace target) | private |
jiraya agent env
Read and update an agent's custom environment variables (audited)
jiraya agent env get
Print an agent's custom_env as a JSON map (agent owner or workspace owner/admin; every call is recorded)
Uso
jiraya agent env get <agent-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: json or table | json |
jiraya agent env set
Replace an agent's custom_env (agent owner or workspace owner/admin; values equal to **** preserve the existing entry)
Uso
jiraya agent env set <agent-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--custom-env string | Replacement custom_env as a JSON object, e.g. '{"KEY":"value"}'. Values equal to '****' preserve the existing entry. Treated as secret material — values passed on the command line are visible to shell history and 'ps'; prefer --custom-env-stdin or --custom-env-file for real secrets. Pass '{}' to clear all keys. | |
--custom-env-file string | Read the replacement custom_env JSON object from a file path (suggested mode: 0600). Mutually exclusive with --custom-env and --custom-env-stdin. | |
--custom-env-stdin | Read the replacement custom_env JSON object from stdin. Keeps secrets out of shell history and 'ps'. Mutually exclusive with --custom-env and --custom-env-file. | |
--output string | Output format: json or table | json |
jiraya agent get
Get agent details
Uso
jiraya agent get <id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | json |
jiraya agent list
List agents in the workspace
Uso
jiraya agent list [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--include-archived | Include archived agents | |
--output string | Output format: table or json | table |
jiraya agent mcp
Manage which workspace MCP servers an agent uses
Assigns MCP servers from the workspace library to an agent. A library entry does nothing until it is added to an agent here, and each assignment carries its own on/off toggle — the same shape as workspace skills.
This is separate from the agent's OWN mcp_config ('agent update --mcp-config'), which holds servers private to that agent. Both are merged at claim time; the agent's own entry wins on a name collision.
jiraya agent mcp add
Give a workspace MCP server to an agent
Assigns a workspace MCP server to this agent, enabled. Take the server id from 'jiraya workspace mcp list'. Adding one twice is a no-op.
Uso
jiraya agent mcp add <agent-id> <server-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | table |
jiraya agent mcp disable
Turn an assigned MCP server off for this agent
Stops the agent from receiving this server without dropping the assignment, so turning it back on later is one command.
Uso
jiraya agent mcp disable <agent-id> <server-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | table |
jiraya agent mcp enable
Turn an assigned MCP server back on for this agent
Uso
jiraya agent mcp enable <agent-id> <server-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | table |
jiraya agent mcp list
List the workspace MCP servers assigned to an agent
Uso
jiraya agent mcp list <agent-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | table |
jiraya agent mcp remove
Take a workspace MCP server away from an agent
Removes the assignment. The workspace library entry itself is untouched and other agents keep theirs.
Uso
jiraya agent mcp remove <agent-id> <server-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | table |
jiraya agent restore
Restore an archived agent
Uso
jiraya agent restore <id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | json |
jiraya agent skills
Manage agent skill assignments
jiraya agent skills add
Add skills to an agent without replacing existing assignments
Uso
jiraya agent skills add <agent-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | json |
--skill-ids strings | Skill IDs to add (comma-separated) |
jiraya agent skills list
List skills assigned to an agent
Uso
jiraya agent skills list <agent-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | table |
jiraya agent skills set
Set skills for an agent (replaces all current assignments)
Uso
jiraya agent skills set <agent-id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | json |
--skill-ids strings | Skill IDs to assign (comma-separated) |
jiraya agent tasks
List runs for an agent
Uso
jiraya agent tasks <id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | table |
jiraya agent update
Update an agent
Uso
jiraya agent update <id> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--conversation-starters string | New conversation starters as a JSON array of {"label","prompt"} objects (at most 3; label ≤80, prompt ≤4000). Pass '[]' to clear. Omit to leave the stored value unchanged. | |
--custom-args string | New custom CLI arguments as JSON array. For model selection prefer --model; some providers (codex app-server, openclaw) reject --model in custom_args. | |
--description string | New description | |
--instructions string | New instructions | |
--max-concurrent-tasks int32 | New max concurrent runs (1-50) | |
--mcp-config string | New MCP server configuration as a JSON object, e.g. '{"mcpServers":{...}}'. Pass 'null' to clear. Treated as secret material — never logged by the CLI, but values passed on the command line are visible to shell history and 'ps'; prefer --mcp-config-stdin or --mcp-config-file for real secrets. | |
--mcp-config-file string | Read the --mcp-config JSON from a file path (suggested mode: 0600). Mutually exclusive with --mcp-config and --mcp-config-stdin. | |
--mcp-config-stdin | Read the --mcp-config JSON from stdin. Keeps secrets out of shell history and 'ps'. Mutually exclusive with --mcp-config and --mcp-config-file. | |
--model string | New model identifier. Pass an empty string to clear and fall back to the runtime default. | |
--name string | New name | |
--output string | Output format: table or json | json |
--permission-mode string | New invocation permission mode: private or public_to. Authoritative over --visibility. Owner-only. | |
--public-to-member strings | public_to: allow the given member user id(s) to invoke this agent. Repeatable. | |
--public-to-workspace | public_to: allow every workspace member to invoke this agent. | |
--runtime-config string | New runtime config as JSON string | |
--runtime-id string | New runtime ID | |
--service-tier string | New Codex execution speed: default = explicit Standard when supported by the daemon's installed Codex CLI; a catalog tier such as priority = explicit Fast. Pass an empty string to clear and inherit local Codex configuration. | |
--status string | New status | |
--thinking-level string | New reasoning/effort level for the agent's runtime (e.g. Claude: low|medium|high|xhigh|max; Codex values come from the runtime model catalog). The set is runtime/model-specific; malformed values are rejected server-side and the daemon validates the exact model/level pair. Some runtimes (e.g. hermes) expose no reasoning control and reject every value. Pass an empty string to clear and fall back to the runtime default. | |
--visibility string | New visibility: private or workspace (legacy; mapped to --permission-mode) |
Atualizado em