README.md

Rivet CLI

Installation

macOS & Linux & WSL

Install latest version

curl -fsSL https://github.com/rivet-gg/cli/main/install/unix.sh | sh

Install specific version

We recommend specifying the CLI version in CI environments. This also allows you to install prerelease versions of the CLI.

export RIVET_CLI_VERSION="v1.0.0"
curl -fsSL https://github.com/rivet-gg/cli/${RIVET_CLI_VERSION}/install/unix.sh | sh

The export keyword is important. The variable RIVET_CLI_VERSION needs to be accessible inside the install script.

Windows (cmd)

Install latest version

powershell -Command "iwr https://github.com/rivet-gg/cli/main/install/windows.ps1 -useb | iex"

Install specific version

We recommend specifying the CLI version in CI environments. This also allows you to install prerelease versions of the CLI.

powershell -Command "$env:RIVET_CLI_VERSION='v1.0.0'; iwr https://github.com/rivet-gg/cli/$env:RIVET_CLI_VERSION/install/windows.ps1 -useb | iex"

Windows (PowerShell)

Install latest version

iwr https://github.com/rivet-gg/cli/main/install/windows.ps1 -useb | iex

Install specific version

We recommend specifying the CLI version in CI environments. This also allows you to install prerelease versions of the CLI.

$env:RIVET_CLI_VERSION='v1.0.0'
iwr https://github.com/rivet-gg/cli/$env:RIVET_CLI_VERSION/install/windows.ps1 -useb | iex

Build from source (cargo install)

cargo install --git=https://github.com/rivet-gg/toolchain rivet-cli

Build from source (cargo build)

git clone https://github.com/rivet-gg/toolchain
cd packages/cli
cargo build

The executable will be available at target/debug/rivet.

Documentation

All commands in the Rivet CLI are documented with the --help flag.

$ rivet --help

Usage: rivet <COMMAND>

Commands:
  init     Login to a game
  login    Login to a game
  logout   Logout from a game
  dev      Run the development server
  deploy   Build & upload the game server & backend
  config   Manage Rivet configuration
  clean    Remove artifacts that Rivet generates
  create   Add functionality to backend
  db       Manage Postgres database
  sdk      Manage the Rivet SDK
  backend  Manage the backend
  module
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version