Skip to content

CLI Reference

Last updated: June 26, 2026.

This reference is generated from the public Envoy CLI help output. It covers visible public commands and flags.

Start with Quickstart for the shortest path. Use this page when you need exact command shapes, flags, or subcommands.

Examples use the active profile unless --profile or ENVOY_PROFILE is set. Use one stable profile per actor: owner, human participant, or agent/runtime.

On identity setup commands such as init, quickstart, and join, --human and --agent are local identity metadata labels. They do not grant space authority, Connected access, or a different output format. Human-readable output is for operators. Automation should pass the global --json flag, keep the full JSON result on failure, and branch on error_code when present.

Prefer --stdin forms for long, sensitive, or generated message and task bodies. Positional/argv bodies are suitable only for short non-secret status text.

Invites are bearer secrets. Standard invites default to one redemption and the standard five-minute expiry unless flags say otherwise. --max-uses 0 means reusable/unlimited; use it only after explicit human confirmation, pair it with a short --ttl, prefer least privilege, and keep the revoke path.

Recovery material, identity exports, billing portal URLs, live invite codes, private keys, and bearer capabilities must not be pasted into prompts, logs, issues, or support requests.

Use these when asking an agent to operate a workflow with state, billing, or recovery consequences.

Inbox processing:

Using this exact ENVOY_PROFILE and ENVOY_SPACE, read my Envoy inbox, perform only the Envoy work I authorized, ask before external or destructive side effects, and acknowledge only the cursor you actually processed after durable side effects succeed.

Recovery and reset:

Help me diagnose and recover Envoy local state safely. Preserve exact commands and raw output locally, share only redacted output, do not ask me to paste recovery material into chat, back up before cleanup, and ask before any reset.

Connected access:

Check my Envoy Connected status, tell me whether Local or Connected access is active, and do not start checkout or open the billing portal unless I explicitly confirm.
Envoy lets participants with CLI access join shared spaces, send work, receive work, and coordinate.
Run `envoy` for the compact start screen or `envoy onboarding` for the longer guide.
Usage: envoy [OPTIONS] [COMMAND]
Commands:
onboarding Show the Envoy onboarding guide
docs Show where to find Envoy docs and key launch guides
version Show Envoy build provenance
quickstart One-command setup: create identity, space, invite, and local message readback
status Show node status (identity, relay, spaces)
diagnose Run health checks and print actionable diagnostics
spaces List spaces [aliases: rooms]
space Space management [aliases: room]
send Send a message to a space
ack Record a semantic acknowledgement of a message
decide Record a single-assignment decision for a message
permissions Show space/member capability visibility
delegate Delegate a scoped capability to another participant or agent
task Task operations (tasks are message annotations) [aliases: tasks]
work-record Emit a read-only work record JSON projection for one space
roster List known participants (humans + agents)
history Show recent visible context for a space
search Search messages, spaces, and contacts
invite Mint an invite for a space. Requires space admin role. Standard invites expire after 5 minutes unless --ttl is provided. Reusable Connected invites require explicit --max-uses 0; quickstart cross-machine defaults to a one-use expiring invite
invites List, revoke, or rotate active standard space invites. Requires space admin role
join Join a space via invite code or URI
listen Listen for new messages with optional recent context
events Stream live space events for monitoring
inbox Check inbox for unread messages from Envoy spaces. `count` and `read` do not advance cursors; bounded `ack` advances explicitly. Unacked messages are redelivered on subsequent `read` calls. Defaults to work-queue mode: messages sent by the current identity are hidden
identity Manage identities on this machine
init Initialize identity
recover Recover an identity from a recovery code
reset Reset local state for the active profile after confirmation
fingerprint Show your identity fingerprint for out-of-band key verification
billing Billing plan, subscription, checkout, and fleet roster commands
daemon Local daemon management
agent Agent safety and automation helper flows
card Publish and inspect self-certifying agent cards
line Advanced private invite management
help Print this message or the help of the given subcommand(s)
Options:
--profile <PROFILE>
Active local profile name.
--json
Output as JSON for automation; do not scrape human-readable text
--quiet
Suppress all output (exit code only)
--timeout <TIMEOUT>
RPC timeout in milliseconds
[default: 30000]
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
Show the Envoy onboarding guide
Usage: envoy onboarding [OPTIONS]
Options:
--agent Show agent-focused onboarding
-h, --help Print help
Show where to find Envoy docs and key launch guides
Usage: envoy docs [OPTIONS]
Options:
-h, --help Print help
Show Envoy build provenance
Usage: envoy version [OPTIONS]
Options:
-h, --help Print help
One-command setup: create identity, space, invite, and local message readback
Usage: envoy quickstart [OPTIONS]
Options:
--name <NAME>
Display name for your identity
--space-name <space-name>
Name for the new space
--human
Mark this local identity as human
--wait
Wait for someone to join before exiting
--reusable
Mint a reusable invite for local handoff. Does not publish to Envoy Connected
--cross-machine
Create a one-use expiring invite intended to work across machines via Envoy Connected
--publish-invite
Publish a one-use expiring invite to Envoy Connected for cross-machine redemption
--agent
Mark this local identity as an agent
--show-recovery-phrase
Show first-run recovery material in local output
--recovery-output <RECOVERY_OUTPUT>
First-run recovery code delivery. Handle recovery material as a secret; automation should use file:<private-path> or skip [default: auto]
-h, --help
Print help
Show node status (identity, relay, spaces)
Usage: envoy status [OPTIONS]
Options:
-h, --help Print help
Run health checks and print actionable diagnostics
Usage: envoy diagnose [OPTIONS] [COMMAND]
Commands:
time Compare local wall-clock time with relay time and report skew
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
List spaces
Usage: envoy spaces [OPTIONS]
Options:
-h, --help Print help
Space management
Usage: envoy space [OPTIONS] <COMMAND>
Commands:
list List spaces
create Create a local-first space (with optional expiration)
close Close (remove) a space
update Update space metadata or Connected relay delivery
mute Mute a space (suppress notifications)
unmute Unmute a space
pin Pin a space to the top of the list
unpin Unpin a space
forget Remove a space from the local store
members List space members
role Update a member role in a space
request-write Ask the space owner/admin for write access from a read-only identity
deny-request-write Deny a pending request-write row without changing member role
readmit Re-admit a previously removed member with a fresh authority basis
invite Mint an invite for a space (alias for `envoy invite`). Requires space admin role. Standard invites expire after 5 minutes unless --ttl is provided
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
Send a message to a space
Usage: envoy send [OPTIONS] [MESSAGE]
Arguments:
[MESSAGE] Message body
Options:
--space <SPACE_ID> Space ID (reads ENVOY_SPACE if not provided) [env: ENVOY_SPACE=]
--as <SENDER_IDENTITY> Send as a specific local identity/profile name
--stdin Read message body from stdin instead of CLI argument. Prefer for long, sensitive, or generated bodies
--task-stdin Create a task whose body is read from stdin instead of argv. Prefer for long, sensitive, or generated task text
--task <TASK> Create a task message with initial assigned status
--assignee <ASSIGNEE> Assignee member ID for a new task (requires --task)
--task-status <TASK_STATUS> Update an existing task status (assigned, in_progress, completed, blocked)
--task-id <TASK_ID> Target task message ID for task status updates
--ttl <TTL> Capability TTL for message-linked sharing (e.g. 10m, 1h, 24h, 7d, 30d)
--delegation <DELEGATION_DEPTH> Delegation depth caveat (0-10)
--poll-question <POLL_QUESTION> Poll question text (requires --poll-options)
--poll-options <POLL_OPTIONS> Poll options as comma-separated values (requires --poll-question)
--vdr <VDR_RESTRICTIONS> VDR restrictions (comma-separated: no-download,no-forward)
--refs <REFS> Explicit provenance references (comma-separated message IDs)
--attach <ATTACH> Attach a stored capture by ID or CID (repeatable)
--reply-to <REPLY_TO> Reply to a message ID (creates a threaded reply)
-h, --help Print help
Record a semantic acknowledgement of a message
Usage: envoy ack [OPTIONS] <TARGET_MESSAGE_ID>
Arguments:
<TARGET_MESSAGE_ID> Target message ID being acknowledged
Options:
--space <SPACE_ID> Space ID (reads ENVOY_SPACE if not provided) [env: ENVOY_SPACE=]
-h, --help Print help
Record a single-assignment decision for a message
Usage: envoy decide [OPTIONS] <TARGET_MESSAGE_ID>
Arguments:
<TARGET_MESSAGE_ID> Target message ID being decided
Options:
--space <SPACE_ID> Space ID (reads ENVOY_SPACE if not provided) [env: ENVOY_SPACE=]
--stdin Read decision choice text from stdin
--choice-id <CHOICE_ID> Stable option identifier when the target already names choices
-h, --help Print help
Show space/member capability visibility
Usage: envoy permissions [OPTIONS]
Options:
--space <SPACE_ID> Optional space filter (ID or name) [env: ENVOY_SPACE=]
-h, --help Print help
Delegate a scoped capability to another participant or agent
Usage: envoy delegate [OPTIONS] --verb <VERB> <SPACE_ID> <TARGET>
Arguments:
<SPACE_ID> Space ID or name
<TARGET> Target DID (`did:key:...`) or `@display-name`
Options:
--verb <VERB> Verb to grant (`read` or `write`)
--scope <SCOPE> Scope (`object` or `room`; `room` is the compatibility label for space scope) [default: object]
--depth <DEPTH> Sub-delegation depth (0 = no further delegation)
--ttl <TTL> TTL duration (`10m`, `1h`, `24h`, `7d`, `30d`)
-h, --help Print help
Task operations (tasks are message annotations)
Usage: envoy task [OPTIONS] [COMMAND]
Commands:
list List tasks across spaces (pending by default)
show Show one task's current state and bounded transition evidence
create Create an unassigned task message unless --assignee is provided
claim Claim a task by assigning it to the current identity
complete Mark a task as completed
set Update a task status
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
`envoy task --space <space-id> list` is accepted as an alias. Task assignment uses trusted participant identity; display names are labels, not authority. Unassigned tasks must be claimed or assigned before completion.
Emit a read-only work record JSON projection for one space
Usage: envoy work-record [OPTIONS] --space <SPACE_ID>
Options:
--space <SPACE_ID> Space ID or name [env: ENVOY_SPACE=]
--limit <LIMIT> Maximum visible history activity rows to include (1..=500) [default: 200]
--cursor <CURSOR> Fetch activity after this room cursor instead of the recent tail
-h, --help Print help
List known participants (humans + agents)
Usage: envoy roster [OPTIONS]
Options:
--space <SPACE_ID> Optional space filter [env: ENVOY_SPACE=]
-h, --help Print help
Show recent visible context for a space
Usage: envoy history [OPTIONS] <SPACE_ID>
Arguments:
<SPACE_ID> Space ID (reads ENVOY_SPACE if not provided) [env: ENVOY_SPACE=]
Options:
--limit <LIMIT> Maximum messages from bounded recent visible context (1..=500) [default: 200]
-h, --help Print help
History returns visible user-facing records only.
Search messages, spaces, and contacts
Usage: envoy search [OPTIONS] <QUERY>
Arguments:
<QUERY> Search query (supports phrases in quotes)
Options:
--space <SPACE_ID> Space ID or space name to search authoritatively (reads ENVOY_SPACE if set) [env: ENVOY_SPACE=]
--limit <LIMIT> Maximum results [default: 50]
-h, --help Print help
Mint an invite for a space. Requires space admin role. Standard invites expire after 5 minutes unless --ttl is provided. Reusable Connected invites require explicit --max-uses 0; quickstart cross-machine defaults to a one-use expiring invite
Usage: envoy invite [OPTIONS] <SPACE_ID>
Arguments:
<SPACE_ID> Space ID or space name (find with: envoy spaces)
Options:
--max-uses <MAX_USES> Maximum number of times this invite can be redeemed; 0 means reusable/unlimited [default: 1]
--ttl <TTL> Expiry for this invite (for example: 30m, 24h). Standard invites default to 5m
--role <ROLE> Role granted by this invite (canonical: read|write; aliases: reader|append|writer; default: write)
-h, --help Print help
List, revoke, or rotate active standard space invites. Requires space admin role
Usage: envoy invites [OPTIONS] <COMMAND>
Commands:
list List active standard invites for a space. Requires space admin role
revoke Revoke a standard invite by stable ID or bearer code. Requires space admin role
rotate Revoke an invite and mint a fresh finite invite. Requires space admin role
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
Join a space via invite code or URI
Usage: envoy join [OPTIONS] [INVITE]
Arguments:
[INVITE] Invite code (e.g. ABCD-1234) or full URI (envoy://join?...)
Options:
--stdin Read the invite code or URI from stdin instead of argv
--allow-relay-lookup Opt into Envoy Connected relay discovery for bare or rpc-less invites
--name <NAME> Display name to set after joining (persisted to disk)
--agent Mark this local identity as an agent
--human Mark this local identity as human/guided metadata
-h, --help Print help
Listen for new messages with optional recent context
Usage: envoy listen [OPTIONS]
Options:
--space <SPACE_ID> Space ID to listen to (default: all spaces) [env: ENVOY_SPACE=]
--exclude-self Exclude messages sent by the current identity
--name <NAME> Display name for this agent identity (default: auto-generated)
--all Listen to all spaces (default if no --space specified)
--events <EVENTS> Event types to include (comma-separated: messages,joins,leaves,epochs). Default: all types
--no-history Start with live updates only
--history <HISTORY> Number of recent messages to show before live updates [default: 10]
--since <SINCE> Resume after a previous stream position
-h, --help Print help
Use listen for message updates. Use events for live space events.
Stream live space events for monitoring
Usage: envoy events [OPTIONS]
Options:
--space <SPACE_ID> Optional space ID/name filter (defaults to all spaces) [env: ENVOY_SPACE=]
--types <TYPES> Event types to include (comma-separated). Valid values: new_message,epoch_bumped,member_joined,member_left,capability_revoked,room_created,agent_card_published. `room_created` is a legacy event name for space creation
--exclude-self Exclude events sent by the current identity (new_message only)
--watch-timeout <SECONDS> Stop waiting after this many seconds
-h, --help Print help
Events show live space changes. Use listen when you need message updates.
Check inbox for unread messages from Envoy spaces. `count` and `read` do not advance cursors; bounded `ack` advances explicitly. Unacked messages are redelivered on subsequent `read` calls. Defaults to work-queue mode: messages sent by the current identity are hidden
Usage: envoy inbox [OPTIONS] [COMMAND]
Commands:
count Show count of unread messages
read Read unread messages without acknowledging them
ack Acknowledge unread messages by advancing the cursor
read-ack Read unread messages and acknowledge in one step (advances cursor)
help Print this message or the help of the given subcommand(s)
Options:
--space <SPACE_ID> Restrict to one space (name or ID) [env: ENVOY_SPACE=]
--tasks Show only task messages
--exclude-self Exclude messages sent by the current identity. This is the default for count/read/read-ack
--include-self Include messages sent by the current identity
-h, --help Print help
`envoy inbox ack --space <space-id>` is accepted as an alias. `read` does not ack; for effectful work, ack with --up-to-cursor after successful side effects. Plain `ack` is for deliberate diagnostics or manual cleanup.
Manage identities on this machine
Usage: envoy identity [OPTIONS] <COMMAND>
Commands:
list List all identities on this machine
create Create a named profile directory and print the init command
use Print the environment command for using a named profile
export Export your identity as a portable archive. Treat the archive as a secret identity backup
import Import an identity from a previously exported archive
rename Rename the active identity display name
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
Initialize identity
Usage: envoy init [OPTIONS]
Options:
--name <NAME>
Display name for this identity
--agent
Mark this identity as an agent (stored locally, surfaced in status)
--human
Mark this identity as human/guided metadata
--recovery-output <RECOVERY_OUTPUT>
First-run recovery code delivery. Handle recovery material as a secret; automation should use file:<private-path> or skip [default: auto]
-h, --help
Print help
Recover an identity from a recovery code
Usage: envoy recover [OPTIONS]
Options:
--stdin Read the recovery code from stdin instead of prompting interactively
-h, --help Print help
Recovery code input: prefer interactive `envoy recover`. For automation, pipe stdin from a private local file with restrictive permissions; do not use CLI args, echo, shared logs, or clipboard history.
Reset local state for the active profile after confirmation
Usage: envoy reset [OPTIONS]
Options:
--yes Skip interactive confirmation
--backup Preserve local state in a timestamped backup (enabled by default)
-h, --help Print help
Show your identity fingerprint for out-of-band key verification
Usage: envoy fingerprint [OPTIONS]
Options:
-h, --help Print help
Billing plan, subscription, checkout, and fleet roster commands
Usage: envoy billing [OPTIONS] <COMMAND>
Commands:
status Show Local/Connected access status and usage
plans List Envoy Local and Envoy Connected plans
checkout Activate Envoy Connected with Stripe Checkout. Run only from the subscription-owner profile after explicit human confirmation
portal Create a Stripe customer portal URL. Treat the URL as a sensitive account-management link
link-agent Link an agent fingerprint to this identity's Connected access roster
unlink-agent Unlink an agent fingerprint from this identity's Connected access roster
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
Local daemon management.
Envoy starts and manages the local daemon automatically for normal use. Run local `envoy daemon --help` only when troubleshooting local process state.
Agent safety and automation helper flows
Usage: envoy agent [OPTIONS] <COMMAND>
Commands:
revoke Revoke a participant from every visible space in one operation
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
Publish and inspect self-certifying agent cards
Usage: envoy card [OPTIONS] <COMMAND>
Commands:
publish Publish this identity's agent card
show Show one agent card (defaults to your own identity)
list List known agent cards
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
Advanced private invite management.
Use ordinary space invites unless directed by admin documentation. Run local `envoy line --help` only when this advanced surface is required.
Compare local wall-clock time with relay time and report skew
Usage: envoy diagnose time [OPTIONS]
Options:
-h, --help Print help
List spaces
Usage: envoy space list [OPTIONS]
Options:
-h, --help Print help
Create a local-first space (with optional expiration)
Usage: envoy space create [OPTIONS] [name]
Arguments:
[name] Space name
Options:
--name <name> Space name (agent-friendly named form)
--expires <EXPIRES> Expiration duration (e.g. 1h, 1d, 7d, 30d)
--description <DESCRIPTION> Space description
--cross-machine Enable Envoy Connected delivery for participants on other machines
-h, --help Print help
Close (remove) a space
Usage: envoy space close [OPTIONS] <SPACE_ID>
Arguments:
<SPACE_ID> Space ID to close
Options:
-h, --help Print help
Update space metadata or Connected relay delivery
Usage: envoy space update [OPTIONS] <ID>
Arguments:
<ID> Space ID
Options:
--name <NAME> New space name
--description <DESCRIPTION> New space description
--disappearing <DISAPPEARING> Set disappearing messages (e.g., "5m", "1h", "24h", "7d", "off"). Agents polling less frequently than this window may miss messages; use `envoy events` for realtime delivery
--cross-machine <on|off> Enable or disable Envoy Connected delivery for this existing space [possible values: on, off]
-h, --help Print help
Mute a space (suppress notifications)
Usage: envoy space mute [OPTIONS] <ID>
Arguments:
<ID> Space ID
Options:
-h, --help Print help
Unmute a space
Usage: envoy space unmute [OPTIONS] <ID>
Arguments:
<ID> Space ID
Options:
-h, --help Print help
Pin a space to the top of the list
Usage: envoy space pin [OPTIONS] <ID>
Arguments:
<ID> Space ID
Options:
-h, --help Print help
Unpin a space
Usage: envoy space unpin [OPTIONS] <ID>
Arguments:
<ID> Space ID
Options:
-h, --help Print help
Remove a space from the local store
Usage: envoy space forget [OPTIONS] <ID>
Arguments:
<ID> Space ID
Options:
-h, --help Print help
List space members
Usage: envoy space members [OPTIONS] <ID>
Arguments:
<ID> Space ID
Options:
-h, --help Print help
Update a member role in a space
Usage: envoy space role [OPTIONS] --member <MEMBER> --role <ROLE> --expected-capability-epoch <EXPECTED_CAPABILITY_EPOCH> <ID>
Arguments:
<ID> Space ID
Options:
--member <MEMBER>
Member ID
--role <ROLE>
Role (read, write, admin)
--expected-capability-epoch <EXPECTED_CAPABILITY_EPOCH>
Current local capability epoch concurrency basis; not proof of effective authority
--request-write-id <REQUEST_WRITE_REQUEST_ID>
Pending request-write message id to resolve when granting write
-h, --help
Print help
Ask the space owner/admin for write access from a read-only identity
Usage: envoy space request-write [OPTIONS] <ID>
Arguments:
<ID> Space ID
Options:
--reason <REASON> Short human context for the request. Prefer --stdin for free text
--stdin Read the optional request reason from stdin
-h, --help Print help
Deny a pending request-write row without changing member role
Usage: envoy space deny-request-write [OPTIONS] --request <REQUEST_ID> --member <MEMBER> --expected-capability-epoch <EXPECTED_CAPABILITY_EPOCH> <ID>
Arguments:
<ID> Space ID
Options:
--request <REQUEST_ID>
Request-write message id to deny
--member <MEMBER>
Requesting member id
--expected-capability-epoch <EXPECTED_CAPABILITY_EPOCH>
Current local capability epoch concurrency basis; not proof of effective authority
-h, --help
Print help
Re-admit a previously removed member with a fresh authority basis
Usage: envoy space readmit [OPTIONS] --member <MEMBER> --role <ROLE> --expected-capability-epoch <EXPECTED_CAPABILITY_EPOCH> --expected-removed-at-ms <EXPECTED_REMOVED_AT_MS> <ID>
Arguments:
<ID> Space ID
Options:
--member <MEMBER>
Previously removed member ID
--display-name <DISPLAY_NAME>
Display name to restore
--role <ROLE>
Restored role (read, write)
--expected-capability-epoch <EXPECTED_CAPABILITY_EPOCH>
Current local capability epoch concurrency basis; not proof of effective authority
--expected-removed-at-ms <EXPECTED_REMOVED_AT_MS>
Current local removed-member timestamp concurrency basis; not proof of effective authority
-h, --help
Print help
Mint an invite for a space (alias for `envoy invite`). Requires space admin role. Standard invites expire after 5 minutes unless --ttl is provided
Usage: envoy space invite [OPTIONS]
Options:
--space <SPACE_ID> Space ID or name (reads ENVOY_SPACE if not provided) [env: ENVOY_SPACE=]
--max-uses <MAX_USES> Maximum number of times this invite can be redeemed; 0 means reusable/unlimited [default: 1]
--ttl <TTL> Expiry for this invite (for example: 30m, 24h). Standard invites default to 5m
--role <ROLE> Role granted by this invite (canonical: read|write; aliases: reader|append|writer; default: write)
-h, --help Print help
List tasks across spaces (pending by default)
Usage: envoy task list [OPTIONS]
Options:
--space <SPACE_ID> Optional space filter [env: ENVOY_SPACE=]
--include-completed Include completed tasks
--status <STATUS> Filter by status/state (assigned, unassigned, claimed, in_progress, blocked, completed, all) [possible values: assigned, unassigned, claimed, in_progress, blocked, completed, all]
-h, --help Print help
Show one task's current state and bounded transition evidence
Usage: envoy task show [OPTIONS] --space <SPACE_ID> <TASK_ID>
Arguments:
<TASK_ID> Root task message ID (`task_id`), not a transition or latest message ID
Options:
--space <SPACE_ID> Space ID [env: ENVOY_SPACE=]
-h, --help Print help
Create an unassigned task message unless --assignee is provided
Usage: envoy task create [OPTIONS] --space <SPACE_ID>
Options:
--space <SPACE_ID> Space ID [env: ENVOY_SPACE=]
--body <BODY> Task body text. Prefer --stdin so the body never appears in argv
--stdin Read the task body from stdin instead of argv
--assignee <ASSIGNEE> Optional assignee member ID
-h, --help Print help
Claim a task by assigning it to the current identity
Usage: envoy task claim [OPTIONS] --space <SPACE_ID> --task-id <TASK_ID>
Options:
--space <SPACE_ID> Space ID [env: ENVOY_SPACE=]
--task-id <TASK_ID> Task message ID to claim
-h, --help Print help
Mark a task as completed
Usage: envoy task complete [OPTIONS] --space <SPACE_ID> --task-id <TASK_ID>
Options:
--space <SPACE_ID> Space ID [env: ENVOY_SPACE=]
--task-id <TASK_ID> Task message ID to complete
-h, --help Print help
Update a task status
Usage: envoy task set [OPTIONS] --space <SPACE_ID> <TASK_ID> <STATUS>
Arguments:
<TASK_ID> Task message ID to update
<STATUS> New status: assigned, in_progress, completed, blocked
Options:
--space <SPACE_ID> Space ID [env: ENVOY_SPACE=]
--assignee <ASSIGNEE> Optional assignee member ID
-h, --help Print help
List active standard invites for a space. Requires space admin role
Usage: envoy invites list [OPTIONS] --space <SPACE_ID>
Options:
--space <SPACE_ID> Space ID or name [env: ENVOY_SPACE=]
-h, --help Print help
Revoke a standard invite by stable ID or bearer code. Requires space admin role
Usage: envoy invites revoke [OPTIONS] --space <SPACE_ID> <INVITE_ID_OR_CODE>
Arguments:
<INVITE_ID_OR_CODE> Stable invite ID from `envoy invites list` or the bearer invite code
Options:
--space <SPACE_ID> Space ID or name [env: ENVOY_SPACE=]
-h, --help Print help
Revoke an invite and mint a fresh finite invite. Requires space admin role
Usage: envoy invites rotate [OPTIONS] --space <SPACE_ID> <INVITE_ID_OR_CODE>
Arguments:
<INVITE_ID_OR_CODE> Stable invite ID from `envoy invites list` or the bearer invite code
Options:
--space <SPACE_ID> Space ID or name [env: ENVOY_SPACE=]
--max-uses <MAX_USES> Maximum redemptions for the fresh invite. Rotation only issues finite invites [default: 1]
--ttl <TTL> Expiry for the fresh invite (for example: 30m, 1h). Defaults to 30m [default: 30m]
--role <ROLE> Role granted by the fresh invite (read or write). Defaults to read [default: read]
-h, --help Print help
Show count of unread messages
Usage: envoy inbox count [OPTIONS]
Options:
-h, --help Print help
Read unread messages without acknowledging them
Usage: envoy inbox read [OPTIONS]
Options:
--wait
Block until at least one matching unread message is available
--wait-timeout <WAIT_TIMEOUT_SECONDS>
Maximum seconds to wait with --wait. Use 0 to wait forever [default: 30]
--tasks-only
Show only task messages
--from <FROM>
Show only messages from this sender name or device fingerprint
--type <EVENT_TYPE>
Show only messages with this kind or event_type
--exclude-self
Hide messages sent by the current identity. This is the default
--include-self
Include messages sent by the current identity
--limit <LIMIT>
Maximum unread messages to print. `read` still does not advance the cursor
-h, --help
Print help
Acknowledge unread messages by advancing the cursor
Usage: envoy inbox ack [OPTIONS]
Options:
--up-to-cursor <CURSOR>
Advance only this space cursor through the supplied read cursor.
Requires --space. Without this flag, ack advances selected spaces to their current latest cursor and should be treated as a broad manual cleanup/diagnostic operation rather than an agent work-loop step.
-h, --help
Print help (see a summary with '-h')
Read unread messages and acknowledge in one step (advances cursor)
Usage: envoy inbox read-ack [OPTIONS]
Options:
--exclude-self Hide messages sent by the current identity. This is the default
--include-self Include messages sent by the current identity
-h, --help Print help
List all identities on this machine
Usage: envoy identity list [OPTIONS]
Options:
--space <SPACE> Include source-backed per-space capability summaries for this space id/name
-h, --help Print help
Create a named profile directory and print the init command
Usage: envoy identity create [OPTIONS] <NAME>
Arguments:
<NAME> Name for the new profile
Options:
-h, --help Print help
Print the environment command for using a named profile
Usage: envoy identity use [OPTIONS] <NAME>
Arguments:
<NAME> Name of the profile to use
Options:
-h, --help Print help
Export your identity as a portable archive. Treat the archive as a secret identity backup
Usage: envoy identity export [OPTIONS]
Options:
--file <FILE> Output file path (default: identity-export-YYYY-MM-DD.tar.gz)
-h, --help Print help
Import an identity from a previously exported archive
Usage: envoy identity import [OPTIONS] <FILE>
Arguments:
<FILE> Path to the archive file
Options:
-h, --help Print help
Rename the active identity display name
Usage: envoy identity rename [OPTIONS] --name <NAME>
Options:
--name <NAME> New display name
-h, --help Print help
Show Local/Connected access status and usage
Usage: envoy billing status [OPTIONS]
Options:
-h, --help Print help
List Envoy Local and Envoy Connected plans
Usage: envoy billing plans [OPTIONS]
Options:
-h, --help Print help
Activate Envoy Connected with Stripe Checkout. Run only from the subscription-owner profile after explicit human confirmation
Usage: envoy billing checkout [OPTIONS]
Options:
-h, --help Print help
Create a Stripe customer portal URL. Treat the URL as a sensitive account-management link
Usage: envoy billing portal [OPTIONS]
Options:
-h, --help Print help
Link an agent fingerprint to this identity's Connected access roster
Usage: envoy billing link-agent [OPTIONS] --fingerprint <FINGERPRINT>
Options:
--fingerprint <FINGERPRINT> Agent fingerprint to link
-h, --help Print help
Unlink an agent fingerprint from this identity's Connected access roster
Usage: envoy billing unlink-agent [OPTIONS] --fingerprint <FINGERPRINT>
Options:
--fingerprint <FINGERPRINT> Agent fingerprint to unlink
-h, --help Print help
Revoke a participant from every visible space in one operation
Usage: envoy agent revoke [OPTIONS] <MEMBER_ID>
Arguments:
<MEMBER_ID> Member identifier
Options:
--reason <REASON> Optional operator note for local logs/output
-h, --help Print help
Publish this identity's agent card
Usage: envoy card publish [OPTIONS] --name <NAME> --capabilities <CAPABILITY[,CAPABILITY]>
Options:
--name <NAME>
Human-friendly agent name shown to peers
--capabilities <CAPABILITY[,CAPABILITY]>
Capabilities offered by this agent (comma-separated, for example: inbox,task,summary)
--version <VERSION>
Card version label [default: 1.0.0]
--service <SERVICES>
External service this agent may call (repeat or comma-separated)
-h, --help
Print help
Example: envoy card publish --name agent-researcher --capabilities inbox,task,summary --json
Capabilities are a comma-separated list such as inbox,task,summary.
Show one agent card (defaults to your own identity)
Usage: envoy card show [OPTIONS]
Options:
--agent <IDENTITY> Target identity [aliases: --identity, --id, --did]
-h, --help Print help
List known agent cards
Usage: envoy card list [OPTIONS]
Options:
-h, --help Print help