Start here
Quox is a small command, quox, that you talk to in plain words. Behind it sits QuoxCORE, the engine your agents run in, on your own machine or a server you control.
What you get
Section titled “What you get”- An agent that works while you are away. Build it once, give it a job and a schedule, and it wakes on its own, does the job and posts what it found. See it run.
- Answers from the agent’s own record. Ask Quox what your agent reported and the answer comes from the agent’s own run, with the numbers tied to the run that produced them. See the answer.
Five steps to your first answer
Section titled “Five steps to your first answer”Every command says where to type it:
- your terminal (blue,
$): your normal shell. - inside quox (amber,
›): typed after you have startedquox, in its conversation.
You need a terminal on Linux, macOS or Windows, and Node.js 20 or later.
On Windows?
On Windows, use WSL2.
1. Install
Section titled “1. Install”npm i -g quoxcliNo Node yet? A fresh Linux box usually has none: install Node first. If npm says permission denied (EACCES, common on Linux), do not reach for sudo: see the no-sudo options. More detail is on Install.
2. Run it
Section titled “2. Run it”quoxThe Q draws itself in and says hello. The first time only, you see a short notice. Press Enter to continue. More on First run.
What is in the first-run notice?
Who we are, the Terms and Privacy links, the licence, and that the CLI sends no telemetry.
3. Connect to a QuoxCORE
Section titled “3. Connect to a QuoxCORE”QuoxCORE is the engine your agents run in. Pick the one that fits you.
A. You already have a QuoxCORE
Section titled “A. You already have a QuoxCORE”Inside quox, /connect server points it at your server and signs you in:
/connect server https://quox.example.comIt asks for your email and password, then you are in the conversation. Replace the address with your own.
No account on that server yet? Ask whoever runs it to add you (quox org members add). You will see the invitation with quox invites.
B. You want one set up
Section titled “B. You want one set up”If you have not connected Quox to a QuoxCORE yet, it opens Getting started, a setup guide. It is scripted: no AI is running yet, and it says so. It asks what you would like help with, tells you in one line what Quox will do for that, and offers to set one up on this machine for you. The first install takes tens of minutes. Details are on First run and Install.
How the guided setup works, and what works today
The guide sets up QuoxCORE on this machine in Docker. The guide, its machine checks and the guided install are built, and the whole flow has been run end to end on a clean machine: it checks the box, sets up QuoxCORE in Docker, brings the services up healthy, and signs you in. The first run builds the images from source, so the first install takes tens of minutes.
C. Just looking
Section titled “C. Just looking”Back in your terminal, not inside quox:
quox --demoThis plays a simulated session with demo data. No server is contacted and nothing real runs. Steps 4 and 5 below need a real QuoxCORE, so come back after A or B.
4. Ask your first question
Section titled “4. Ask your first question”Inside quox, ask something that only reads:
what is running?Quox hands it to the right agent and shows each step as it happens. Nothing here changes anything. Anything risky would wait for your yes (approvals in the terminal are in preview). The answer depends on what your QuoxCORE is running, so yours will differ from anyone else’s.
You can also look at the roster under the status line:
/roster all5. Inspect the result
Section titled “5. Inspect the result”Actions Quox takes end with a receipt line, which can show as pending at first. To expand the last turn’s policy checks, inside quox:
/aoclWhat are AEE, AOCL and WARD?
By default Quox shows compact lines for three records as they happen: the envelope (AEE), the policy checks (AOCL) and the witness record (WARD). A receipt line can show as pending until the witness record lands.
To check a receipt yourself against the witness chain, follow Check a receipt yourself. To read the roster in full, see What is running.
Already set up?
Section titled “Already set up?”The Quickstart is the two-minute version. If something does not go to plan, see Troubleshooting. For the keys, see The conversation.