Skip to content
ricochet

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.

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

Check that it works:

Terminal window
ricochet --version

On macOS, you can also install with Homebrew:

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

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:

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

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

Terminal window
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.

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:

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

To remove the stored credentials for a server:

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

Go to your project folder and run:

Terminal window
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.

Later deploys reuse the settings in your _ricochet.toml:

Terminal window
ricochet deploy