Install

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, but not yet proven end to end on a clean machine. See Start here.

Install

You need Node.js 20 or later.

npm install -g quoxcli

Then run:

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:

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:

• Quickest: install as root.

  sudo npm install -g quoxcli

• No sudo: give npm a folder in your home, and put it on your PATH.

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

  On zsh, use ~/.zshrc instead of ~/.bashrc. A Node version manager such as nvm also avoids the problem.

• Without installing: run it straight from npm.

  npx -p quoxcli quox

Platforms

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

Next

First run, then the Quickstart.