Install

This page is step 1 and 2 of Start here in detail. If you are new, start there and come back for the details.

Prerequisite

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 and has been run end to end on a clean machine, up to healthy services and a signed-in session. The first run builds from source, so the first install takes tens of minutes. See Start here.

Get Node

Quox needs Node.js 20 or later. Check what you have:

your terminal Copy

$ node --version

If that says command not found or a version below 20 (a fresh Linux box usually has no Node at all), install a current one:

• nvm (any OS, no sudo, recommended): see nvm for its install line, then nvm install 22. Global npm installs then go into your home folder and need no special rights.

• Debian or Ubuntu (NodeSource):

  your terminal Copy

  $ curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -$ sudo apt-get install -y nodejs

• macOS (Homebrew): brew install node

Install

With Node from nvm, this is all you need:

your terminal Copy

$ npm install -g quoxcli

If your Node came from a system package, see If npm says permission denied first.

Then run:

your terminal Copy

$ 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:

your terminal Copy

$ quox --version

If npm says permission denied

On Linux with Node from your distribution or NodeSource, npm installs global packages into a system folder, so npm install -g as a normal user fails with EACCES. Pick one of these:

• Best: use a Node version manager such as nvm (see Get Node above). It keeps global packages in your home folder.

• Or give npm a folder in your home, and put it on your PATH:

  your terminal Copy

  $ mkdir -p ~/.npm-global$ npm config set prefix ~/.npm-global$ echo 'export PATH="$HOME/.npm-global/bin:$PATH"' >> ~/.bashrc$ source ~/.bashrc$ npm install -g quoxcli

  On zsh, use ~/.zshrc instead of ~/.bashrc.

• Without installing: run it straight from npm.

  your terminal Copy

  $ npx -p quoxcli quox

Avoid sudo npm install -g: it runs the package’s install scripts as root and leaves root-owned files in your npm folders.

Platforms

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

Next

Back to Start here, step 2, or on to First run.