Skip to content

Single commands

Documented Checked against the CLI's current help and source. Not run end to end. Last checked on quoxcli 0.6.1, 2026-11-10.

All commands

These 29 commands stand alone, with no subcommands.

Authenticate with QuoxCORE

Usage: quox login [options]

OptionWhat it does
--email <email>email address
--password <password>password (prefer --password-stdin: argv is visible in process lists)
--password-stdinread the password from stdin (one line): no secret in argv or shell history
--mfa-code <code>TOTP code for MFA
--org <orgId>organization to log into
--residentauthenticate as a resident agent using the on-disk Ed25519 identity, no password, no human
--resident-profile <path>path to the resident bootstrap profile (default: ~/.config/quox/resident-profile.json)

End current session

Usage: quox logout [options]

Show current user and session info

Usage: quox whoami [options]

Create a new user account

Usage: quox signup [options]

OptionWhat it does
--email <email>email address
--password <password>password (prefer --password-stdin: argv is visible in process lists)
--password-stdinread the password from stdin (one line), no secret in argv or shell history
--name <name>display name

Check health of all QuoxCORE services (alias for service health)

Usage: quox health [options] [name]

Show platform health and status overview

Usage: quox status [options]

Run platform health diagnostics

Usage: quox doctor [options]

Connect to a Quox server on another machine: probe it, trust its certificate for one profile, sign in

Usage: quox connect [options] <url>

OptionWhat it does
--profile <name>profile to create or update (default: named from the address; -p also works)
--trust-certtrust the server’s own certificate for this profile without asking (its fingerprint is still printed)
--fingerprint <sha256>trust the server’s own certificate only if its SHA256 fingerprint is exactly this (colons optional); implies --trust-cert for that one certificate
--email <email>sign in with this email without a prompt (use with --password-stdin to run with no terminal)
--password-stdinread the password from stdin, one line (never an argument)

Update quox to the latest version (npm, git checkout, or this box’s shared CLI); also quox --update

Usage: quox update [options]

OptionWhat it does
--checkshow what an update would do and change nothing
-y, --yesupdate without asking (needed in a non-interactive shell)

Open a quox:// URI in the dashboard or show CLI equivalent

Usage: quox open [options] <uri>

OptionWhat it does
--clishow CLI command instead of opening browser

Look up an envelope, inbox item, objective, run, WARD receipt or agent by id (read only)

Usage: quox peek [options] <id>

Ask a read-only side question: no tools, not saved to any conversation

Usage: quox aside [options] <question...>

OptionWhat it does
--agent <id>who answers (default quox)

Play the Quox motion gallery: the Q intro, portal, particle, the Dragon’s Eye, the status Q, ring, reveals and the living dragon (no server needed)

Usage: quox motion [options] [scenes...]

OptionWhat it does
--narrowuse the 40-column layout (the compact Q)
--slowplay three times slower
--monono colour (also honoured: NO_COLOR)

Show the welcome screen again (read only; changes no setup or config)

Usage: quox welcome [options]

Chat with CommanderQ or any agent, streaming by default

Usage: quox chat [options] [message]

OptionWhat it does
--agent <name>route to a specific agent (e.g. sentinel, cipher, nova)
--no-streamdisable streaming output (one-shot request/response)
--conversation <id>continue a conversation (session id)
--continuecontinue the last conversation for this profile and directory
--resume <turn>fetch a chat turn that was still running (its id is printed if a turn outlives the wait)
--traceprint the turn’s protocol events (per-layer AOCL, traces, summary) to stderr as they arrive
--dragon <mode>dragon companion for dragon-backed agents: on, greeting or off (default from /dragon companion; art is bundled; QUOX_DRAGONLAB overrides it)
--dragon-module <path>opt in to a trusted local dragon companion module (streaming, single-message mode)

Check chat service status

Usage: quox chat-status [options]

Run Claude Code (same arguments as claude) in a tmux session that survives sleep and drops

Usage: quox claude [options] [-- claude-args...]

Run Codex (same arguments as codex) in a tmux session that survives sleep and drops

Run quox codex --help for usage.

Run any program in a governed tmux session: quox wrap <program> [args…]

Usage: quox wrap <program> [args...]

Who is doing what: one line per active worker, grouped working / waiting on you / idle; filter: sessions, slots, agents

Usage: quox active [options] [filter]

OptionWhat it does
--jsonprint the summary as JSON
--allshow every worker (default: top 10 per group)
--linesthe older one-line-per-worker layout with state and age columns

What this Quox can do for your org: ready, needs setup, not available, planned

Usage: quox capabilities [options] [name]

List the “did you know” tips the terminal shows (/tip); --json for the registry as data

Usage: quox tips [options] [query...]

OptionWhat it does
--jsonprint the registry as JSON

Org agent inventory (the agent CMDB): agents, models, tool/credential grants, delegation, unused-grant drift

Usage: quox inventory [options]

OptionWhat it does
--days <n>observed-usage window for the unused-grant column (default 30)
--unusedALSO compute the org-wide unused-grant pass (SLOW: minutes at org scale; for one agent use quox reach unused <agentId>)
--driftdiff against the last stored snapshot and store this rollup as the new baseline (witnessed as quox.reach.inventory_drift)

LUCID situation report: what needs you, every area, what changed, what LUCID cannot see

Usage: quox sitrep [options]

OptionWhat it does
--agentcompact, id-rich form for agents
--jsonthe full structured situation
--spokensentences only, as read on the phone
--markdownchat-ready Markdown for Discord, Matrix and slots (fits one message)

File a one-liner complaint as a GitHub issue (via the GRIPE agent)

Usage: quox gripe [options] <complaint...>

OptionWhat it does
--repo <owner/name>target repo (GRIPE defaults sensibly when omitted)
--label <label>issue label, e.g. bug, idea, fleet
--publicconfirm filing to a PUBLIC repo (asks y/N; refused if text has internal hostnames/paths)
--yesskip the confirmation step and let GRIPE file it directly

Open the web dashboard signed in (one-time link, 10 minutes). Pages: sessions, approvals, agents, lucid, inbox, seo, settings

Usage: quox dashboard [options] [page]

Guided, idempotent, resumable wizard to onboard a customer site as a governed Quox tenant

Usage: quox onboard [options] <host>

OptionWhat it does
--name <customerName>the org display name
--repo <owner/name>the customer GitHub repo for auto-filed security issues
--target <hostOrIp>the scan target (defaults to <host>)
--environment-tier <tier>dev | staging | production (default: “dev”)
--schedule-cron <expr>cron cadence for the recurring scan (default: “0 2 * * 3”)
--tool <name>capability tool to schedule (default: “vuln_scan”)
--yesrun non-interactively: do every automatable step and print gate instructions without pausing

Launch the classic menu TUI (bare quox opens the conversation)

Usage: quox tui [options] [screen]

OptionWhat it does
--governedRun the TUI in a Quox governed tmux session (survives sleep and drops)
--name <name>Session name for --governed (reattaches if it is already running)
--no-tmuxWith --governed: skip tmux

Generate shell completions (bash, zsh, fish)

Usage: quox completion [options] <shell>