Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Cargo Install From GitHub

Install the Nervix server, the interactive CLI, and the NSPL formatter directly from the Nervix GitHub repository:

cargo install --locked \
  --git https://github.com/nervix-io/nervix.git \
  nervix-server nervix-cli nervix-nspl-format

This builds the binaries from source and installs them into Cargo’s binary directory, which is $HOME/.cargo/bin by default. Ensure that directory is on your PATH.

The build requires Rust 1.99 or newer and the native build tools required by Nervix’s dependencies. The initial build can take several minutes.

Confirm that the commands are available:

nervix-server --help
nervix-cli --help
nervix-nspl-format --help

Pin A Git Revision

The unpinned command installs the current default branch. For a reproducible installation, select a reviewed commit:

cargo install --locked \
  --git https://github.com/nervix-io/nervix.git \
  --rev <commit-sha> \
  nervix-server nervix-cli nervix-nspl-format

Run the same command with a different revision to upgrade. Add --force if Cargo reports that the selected packages are already installed.

To remove both binaries:

cargo uninstall nervix-server nervix-cli nervix-nspl-format