Skip to content

Quickstart

Documented Checked against the CLI's current help and source. Not run end to end. CLI 0.3.1, checked 2026-10-16.

Already have the CLI installed and a QuoxCORE you can reach? This is the two-minute version. Starting from nothing, or no QuoxCORE yet? Use Start here instead: it is the one full path.

Each command is labelled: your terminal is your normal shell, inside quox is typed in the quox conversation.

your terminal
quox

Then tell it where your QuoxCORE is:

inside quox
/connect server https://quox.example.com

It asks for your email and password, then you are in the conversation.

Prefer the shell, or scripting it? quox login is the same sign-in without opening the conversation. Pipe the password in so it never lands in your shell history:

your terminal
printf '%s' "$QUOX_PASSWORD" | quox login --email [email protected] --password-stdin

Check who you are signed in as:

your terminal
quox whoami

If your QuoxCORE uses a self-signed certificate, see Troubleshooting.

Type what you want in the conversation. Quox routes it to the right agent and shows each step as it happens. Try a read-only question first:

inside quox
what is running?

Ask for an action that changes something. When an agent needs a human, an approval card appears. With an empty draft, press a to approve or d to deny.

Actions Quox takes end with a receipt line. That is the evidence record for what happened. Receipts are witnessed by the platform, and a line can show as pending until the witness record lands. Inside quox, /help shows what your version supports:

inside quox
/help