cli

Installation

Linux, macOS, Windows (Git Bash/WSL):

curl -fsSL https://raw.githubusercontent.com/ricochet-rs/cli/main/install.sh | sh

Windows (PowerShell/CMD):

curl.exe -fsSL https://raw.githubusercontent.com/ricochet-rs/cli/main/install.ps1 -o install.ps1; .\install.ps1; Remove-Item install.ps1

Warning

The default install dir is $HOME/bin for your current user, which is not in $PATH by default. You need to add this directory to your $PATH environment variable or otherwise always use the full path to the binary.

Or using Git Bash/WSL:

curl -fsSL https://raw.githubusercontent.com/ricochet-rs/cli/main/install.sh | sh

Tip

If you're on macOS, you might want to use our homebrew tap instead.

The installer will automatically detect your OS and architecture and download the appropriate binary from the release artifacts.

Note

We will add support for scoop and chocolatey in the future.

Customization

You can customize the installation with environment variables:

Bash/sh:

# Install a specific version
RICOCHET_VERSION=0.2.0 curl -fsSL https://raw.githubusercontent.com/ricochet-rs/cli/main/install.sh | sh

# Install to a custom directory
RICOCHET_INSTALL_DIR=$HOME/.local/bin curl -fsSL https://raw.githubusercontent.com/ricochet-rs/cli/main/install.sh | sh

PowerShell:

# Install a specific version
$env:RICOCHET_VERSION="0.2.0"; curl.exe -fsSL https://raw.githubusercontent.com/ricochet-rs/cli/main/install.ps1 -o install.ps1; .\install.ps1; Remove-Item install.ps1

# Install to a custom directory
$env:RICOCHET_INSTALL_DIR="$HOME\.local\bin"; curl.exe -fsSL https://raw.githubusercontent.com/ricochet-rs/cli/main/install.ps1 -o install.ps1; .\install.ps1; Remove-Item install.ps1

Commands

See the full documentation at docs/cli-commands.md.

Development

Documentation

The CLI documentation is automatically generated from the command-line help.

just docs