Installing the CLI

There are three ways to get the oxagen command. Install the Oxagen app unless you need the command without it, on a server or a CI runner for example.

The Oxagen app (recommended)Copy Anchor Link

The app installs oxagen and keeps it current. On first launch it links the command into ~/.local/bin on macOS and Linux, and onto your user PATH through a .cmd shim on Windows. It never asks for administrator rights.

Every version, with a SHA-256 for each file, is listed at downloads.oxagen.sh. Oxagen app covers the first launch on each platform, where the command lives, and how updates work.

A single executableCopy Anchor Link

Each version also publishes oxagen as one executable per platform, the same file the app links onto your PATH. It carries its own runtime, so it needs no Node.js. A .sha256 sits beside each file.

On macOS or Linux, run the install script:

curl -fsSL https://docs.oxagen.sh/install.sh | sh

The script downloads the file for your platform from latest/, checks its SHA-256, and installs it to ~/.local/bin. It never uses sudo. On Linux arm64, which has no executable yet, it installs from npm instead. To pin a version, run it as curl -fsSL https://docs.oxagen.sh/install.sh | OXAGEN_INSTALL_BASE=https://downloads.oxagen.sh/desktop/<version> sh.

To do the same steps by hand, download the file for your platform and its checksum, check it, and install it:

name=oxagen-aarch64-apple-darwin   # the file for your platform, from the table
curl -fsSLO "https://downloads.oxagen.sh/latest/$name"
curl -fsSLO "https://downloads.oxagen.sh/latest/$name.sha256"
shasum -a 256 -c "$name.sha256"     # on Linux: sha256sum -c "$name.sha256"
mkdir -p ~/.local/bin
install -m 755 "$name" ~/.local/bin/oxagen

latest/ always holds the newest version. To pin one, replace latest with desktop/<version>, for example https://downloads.oxagen.sh/desktop/2.1.5/oxagen-aarch64-apple-darwin. Each release page under Releases links its own files.

On Windows, download oxagen-x86_64-pc-windows-msvc.exe, rename it to oxagen.exe, and put it in a directory on your PATH.

If ~/.local/bin is not on your PATH, add export PATH="$HOME/.local/bin:$PATH" to your shell profile.

From npmCopy Anchor Link

The npm package needs Node.js 22.15 or newer. On Node.js 23, it needs 23.8 or newer:

npm install -g @oxagen/cli
oxagen --version

npm's latest version is the one production runs. Each production deploy publishes the CLI it shipped, numbered as a build of the next release, such as 2.1.4-12. A release publishes under its own number, such as 2.1.4. To install one version, name it: npm install -g @oxagen/cli@2.1.4.

Verify the installCopy Anchor Link

Whichever method you used, confirm the binary works and read the top-level help:

oxagen --version
oxagen --help

oxagen --help lists every command group. Append --help to any command (for example oxagen graph search --help) to see its flags.

Next stepCopy Anchor Link

With the binary in place, set up your Oxagen account and authenticate the CLI.