Skip to main content

​
Onyx CLI

The recommended way to install Onyx is the guided installer built into the Onyx CLI:
The installer will:
  • Check your system resources and requirements (installing Docker on Linux if needed)
  • Let you choose between Lite and Standard deployment modes
  • Prompt for the version of Onyx to deploy
  • Set up the deployment configuration in ~/.config/onyx
  • Pull the Onyx containers, start them, and wait until every service is healthy
After installation, the same command group manages the deployment: onyx-cli deploy upgrade, status, logs, stop, and uninstall.

Deploy with the Onyx CLI

Full documentation for onyx-cli deploy and its lifecycle commands.

​
Installation Scripts

The installation scripts are thin wrappers around the CLI: they install onyx-cli if needed and run onyx-cli deploy install, producing the same deployment as the command above. Use them when you want a single copy-paste one-liner:
Or download the script and run it manually:

Linux / macOS (Bash)

Download install.sh and run it with bash install.sh.

Windows (PowerShell)

Download install.ps1 and run it with .\install.ps1 in PowerShell.
Older versions of the scripts were standalone and installed into a directory called onyx_data. The Onyx CLI detects those deployments and manages them in place — see migrating an existing deployment.

​
Next Steps

Set Up the Desktop App

Install the Onyx desktop application for a native experience on Windows, macOS, and Linux.

Deploy Onyx on AWS EC2

Follow our guide to deploy Onyx on an AWS EC2 instance.