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. This page walks the whole way in, and says plainly which steps work today.
What you need
Section titled “What you need”- A terminal on Linux or macOS. On Windows, use WSL2.
- Node.js 20 or later.
- For real work: a QuoxCORE. Either one you already run, or one set up on this machine with Docker.
1. Install
Section titled “1. Install”npm i -g quoxcli2. Say hello
Section titled “2. Say hello”quoxThe Q draws itself in, says hello, and the first time only, you see a short notice: who we are, the Terms and Privacy links, the licence, and that the CLI sends no telemetry. See First run.
3a. No QuoxCORE yet
Section titled “3a. No QuoxCORE yet”Quox 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 up a QuoxCORE here in Docker.
3b. You already have a QuoxCORE
Section titled “3b. You already have a QuoxCORE”Point Quox at it and sign in:
/connect server https://quox.example.comYou go straight to the conversation.
4. Just type
Section titled “4. Just type”Say what you want. Quox hands it to the right agent and shows each step as it happens. Anything risky waits for your yes (approvals in the terminal are in preview), and governed actions leave a receipt. The Conversation page has the keys.
Not ready for any of this? quox --demo plays a simulated session with demo data, and nothing real runs.
- Quickstart: your first useful questions.
- What is running: see your agents at a glance.
- Troubleshooting: when something does not go to plan.