The ricochet CLI

The ricochet CLI is a Rust-based command-line tool that deploys and manages content on ricochet servers. Use its interactive prompts to create, update, and monitor your deployments.

Installation

Mac / Linux

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

Windows

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

Check that it works:

ricochet --version

Homebrew (macOS)

On macOS, you can also install with Homebrew:

brew tap ricochet-rs/homebrew-tap
brew install ricochet

Windows

Tip

A Scoop formula is planned but not yet available.

Manual Installation

Pre-built binaries are available for macOS, Linux, and Windows. Download one from:

https://s3.eu-central-003.backblazeb2.com/ricochet-cli/$VERSION/ricochet-$VERSION-$OS_ARCH.tar.gz

Use one of these $OS_ARCH values:

• aarch64 (Linux ARM64)
• x86_64 (Linux x86)
• windows.exe

Extract the archive and move the binary to a folder on your PATH:

tar -xzf ricochet-$VERSION-$OS_ARCH.tar.gz
mv ricochet-$VERSION-$OS_ARCH/ricochet /usr/local/bin/

Note

On Windows, run the .exe file directly after you extract it.

Authentication

Logging In

Run login and pass the server URL with the -S flag:

ricochet login -S https://try.ricochet.rs

Your browser opens so you can sign in. The CLI then stores your credentials locally and uses them for later commands.

Remote Sessions

Over SSH, in a dev container, or in a remote editor window, the browser can’t hand the key back to the CLI. Add --no-browser instead:

ricochet login -S https://try.ricochet.rs --no-browser

The CLI prints your server’s credentials page. Create an API key there and paste it at the prompt. In a script, pipe the key to stdin instead:

echo "$RICOCHET_KEY" | ricochet login -S https://try.ricochet.rs --no-browser

Multiple Instances

You can log in to more than one ricochet server. The CLI stores each server’s credentials apart, keyed by the server URL.

To switch servers, pass the -S flag with your command:

# Deploy to production
ricochet deploy -S https://ricochet.example.com

# Deploy to staging
ricochet deploy -S https://staging.ricochet.example.com

Tip

If you only use one server, set the RICOCHET_SERVER environment variable. Then you can skip -S on every command.

Logging Out

To remove the stored credentials for a server:

ricochet logout -S https://try.ricochet.rs

Deployment

Basic Deployment

Go to your project folder and run:

ricochet deploy

If there is no _ricochet.toml file, the CLI walks you through an interactive setup:

1. Choose a language: R, Julia, or Python

2. Select content type: Shiny, Plumber, Quarto, and so on

3. Specify the entrypoint: the file that starts your app, such as app.R

4. Name your content: the name shown in the ricochet UI

5. Set visibility: Private, Internal, or External

When you finish, the CLI creates a _ricochet.toml file in your project folder. See Using _ricochet.toml for all settings.

Redeploying

Later deploys reuse the settings in your _ricochet.toml:

ricochet deploy