Skip to content
Preview. This site is a preview of cli.quox.ai and is not indexed. Some pages describe work that is not released yet.

Install

Quox is a client. It talks to a running QuoxCORE, so you need one before it does anything useful.

Today that means you bring your own QuoxCORE: you run it yourself, or someone in your organisation does. The source and setup notes are in the quoxcore repository. Quox also has a guided setup for when no QuoxCORE is found: it is built, but not yet proven end to end on a clean machine. See Start here.

You need Node.js 20 or later.

Terminal window
npm install -g quoxcli

Then run:

Terminal window
quox

Bare quox opens the conversation: type what you want, approve what needs approving. Every other command is quox <command>, and the older menu is quox tui. Quox is also available as quoxon.

Check the install:

Terminal window
quox --version

Linux and macOS are the targets. On Windows, use WSL2. Native Windows is untested.

First run, then the Quickstart.