QuoxCLI · run & scale · the Quox command line

Your infrastructure, from the command line.

The full CLI for QuoxCORE. 76 command groups and 384 commands, reaching hundreds of registered routes across 5 services. Auth, agents, fleet, memory, chat and backups, all from your terminal. Below: quox driving a live instance on its own.

Get started Read the docs$cd cli && npm install && npm link

Command groups 76Commands 384Services 5Output modes 4

In plain words

What it is, where it lives, when to reach for it

What is it: A command line program, quox, that controls your QuoxCORE platform from the terminal.
Where do I use it: In your terminal, on any machine that can reach your QuoxCORE instance over the network.
When would I use it: When you want to script the platform, or check something without opening the dashboard.
How do I use it: Run quox login to connect to your instance, then quox status for a platform overview.

QuoxCORE is the free, self-hosted platform underneath this. What is QuoxCORE

adam@quox — quox — zshLIVE

quox <resource> <action> [options]--json · --quiet · --org on every command

The problem

Stop switching between browser tabs and curl.

Managing a multi-service platform through a web UI works for exploration, but operators need speed. Every API call through curl means building headers, constructing URLs, managing tokens and parsing raw JSON. QuoxCLI wraps every QuoxCORE endpoint into composable commands with automatic authentication, service routing and formatted output. It is the operator’s interface.

One tool for all 5 microservices
Automatic JWT refresh and service-aware routing
Pipe-friendly output for shell scripting
Multi-profile support for local, staging and production

76 command groups

One CLI over the whole platform

76 command groups and 384 commands, reaching hundreds of registered routes across 5 services. The ten themes below are how they are organised, not a smaller surface.

quox<resource> <action> [options]
--json · --quiet · --org
on every command76 groups
384 commands
5 services

Auth & config
14 commands
JWT authentication with multi-profile support. Switch between local, staging and production environments.
login · logout · whoami · config profile
Organisations
42 commands
Full org management including teams, departments, members, divisions and audit trails.
org list · org members · org divisions
Agents & tools
65 commands
CRUD operations for agents, tools, workflows and assistants. Activate, deactivate, assign tool packs.
agent list · tool catalog · tool install
Fleet ops
48 commands
Real-time fleet monitoring, agent health, tool execution and live dashboards in your terminal.
fleet status · fleet watch · fleet exec
Memory & search
39 commands
Manage memories, entities and conversations. Full-text search across your knowledge graph.
memory search · entity relate · conversation
Chat
27 commands
Chat with CommanderQ directly from your terminal. Streaming responses with spinner indicators.
chat send · chat stream
Backups & files
31 commands
Backup management with verify and restore, file upload via multipart, and download with progress.
backup create · file upload · file download
Admin & HITL
71 commands
Platform administration, API key management, inbox approvals, workflow runs and retention policies.
admin keys · inbox respond · run resume
Integrations
33 commands
Integration lifecycle, data consent management, and AEE audit envelope protocol access.
integration test · consent grant · aee query
Watch & monitor
14 commands
Real-time terminal dashboards for fleet and service health. Auto-refreshing with colour-coded status.
watch fleet · watch services · service health

Quick start

Three commands to full control

QuoxCLI ships as a standalone ESM package inside the QuoxCORE repository. Install once, link it, and the quox binary is on your path.

Step 01
Install
Built on native fetch with zero HTTP client dependencies. Commander.js handles command parsing, chalk handles colours, and cli-table3 renders formatted output.
$cd cli && npm install && npm link
Step 02
Log in
Interactive JWT login with MFA. Tokens refresh automatically on 401, and profiles switch you between local, staging and production.
$quox login
Step 03
Operate
Every command follows the pattern quox <resource> <action>. Global flags --json, --quiet and --org work on every command.
$quox fleet status

Requires Node.js 20+ · ships with every QuoxCORE installation · full CLI reference

5 services

One CLI, five microservices

QuoxCORE runs 5 microservices on different ports. The CLI client automatically routes each command to the correct service, so you never think about ports or base URLs.

Automation

Format output for any workflow

Every command supports four output modes. Tables for interactive work, JSON for scripting, CSV for analysis, and quiet mode for shell pipelines.

--output tableColour-coded tables with status indicators. Default for human operators.

--jsonRaw JSON for piping to jq, scripting, and automation workflows.quox agent list --json | jq '.[].name'

--output csvComma-separated output for spreadsheets and data analysis tools.quox fleet status --output csv > fleet.csv

-qIDs only. Perfect for xargs pipelines and shell scripting.quox backup list -q | xargs -I{} quox backup verify {}

GitHub Actions example

# .github/workflows/deploy.yml
steps:
  - name: Pre-deploy backup
    env:
      QUOX_TOKEN: ${{ secrets.QUOX_API_KEY }}
      QUOX_URL: https://quox.example.com
    run: |
      quox backup create \
        --label "pre-deploy-$GITHUB_SHA"
      quox fleet status --json \
        | jq '.agents[] | select(.status != "healthy")'
      quox service health --json

API key auth via QUOX_TOKEN (prefix msk_) for CI/CD
QUOX_URL and QUOX_PROFILE overrides for zero-config automation
Exit codes: 0 success, 2 usage, 3 auth, 5 not found, 7 network
Live checks: watch -n 30 quox fleet summary --json

Capabilities

Built for operators

The details that make a CLI liveable, all switched on by default.

Multi-profile auth

JWT login with automatic token refresh on 401. Switch between local, staging and production with a single command.

Service-aware routing

Automatically routes requests to the correct microservice port: auth on 3101, collector on 9848, memory on 3103, files on 3102.

Smart retry

Exponential backoff on 429, 502 and 503 errors. Three attempts with 1s, 3s and 9s delays. Automatic token refresh on authentication failures.

Output formatting

Every command supports table, JSON, CSV and quiet output modes. Pipe JSON to jq, use quiet mode for xargs pipelines.

Shell completions

Tab completion for bash, zsh and fish. Every command, subcommand and flag is autocompleted as you type.

Plugin system

Drop plugins into ~/.quox/plugins/ and they are loaded automatically. Extend the CLI with custom commands for your workflow.

Env var overrides

Set QUOX_TOKEN for CI/CD pipelines, QUOX_URL for custom endpoints, QUOX_PROFILE for profile selection. Zero-config automation.

Full audit trail

Access AEE audit envelopes, query conversations, and export memory data. Everything your agents do is one command away.

Secure by default

Config stored at ~/.config/quox/ with 0600 permissions. Tokens never logged. API key auth via x-api-key header for CI.

Watch & monitor

The terminal, live inside QuoxCORE.

QuoxCLI’s watch commands render real-time, auto-refreshing dashboards for fleet and service health, with colour-coded status. Here it is running inside the QuoxCORE dashboard.

QuoxCLI's terminal and TUI running inside the QuoxCORE dashboard

Where it stands

What's proven, what's still beta

This maturity map covers the interactive TUI shown above. The scripting commands underneath it are already used in production today.

Live and proven

Core TUI foundations, launch, keep-alive views, active-gated polling, responsive sizing, are stable and unit-tested
The screens reuse the same endpoints the quox CLI commands already exercise in production

Beta and partial

Every data screen, Fleet, Agents, Chat, Objectives, Inbox, Vault, Governance, Health, is beta: unit-tested against mocked clients, not yet exercised end to end against an authenticated live stack
Live token streaming in the Chat screen specifically has not been verified against a running box
Vault credential rotation still needs the plain quox vault rotate command; it is not wired into the TUI

Known gaps

A known bug: inbox respond --action reject currently resumes the workflow as approved, not denied, until a one-line server fix lands
No mouse support, by design: this is a keyboard-first interface
DetailPanel focus is not wired into every view yet

Run & scale

QuoxCLI is built into QuoxCORE

Every QuoxCORE installation includes the CLI. Your entire platform is one quox command away.

Get started Get QuoxCORE CLI reference

CLI reference API reference Quickstart Architecture

What it is, where it lives, when to reach for it

Stop switching between browser tabs and curl.

One CLI over the whole platform

Auth & config

Organisations

Agents & tools

Fleet ops

Memory & search

Chat

Backups & files

Admin & HITL

Integrations