Skip to content

Installation

Rocketship CLI is available for macOS, Linux, and Windows. Choose your platform below for installation instructions.

Prerequisites

If you want to run tests without needing to connect to a remote engine, you need to install Temporal which is required for the local engine:

brew install temporal  # macOS

For other platforms, please follow the Temporal installation guide.

macOS

Apple Silicon

curl -Lo /usr/local/bin/rocketship https://github.com/rocketship-ai/rocketship/releases/latest/download/rocketship-darwin-arm64 && chmod +x /usr/local/bin/rocketship

Intel

curl -Lo /usr/local/bin/rocketship https://github.com/rocketship-ai/rocketship/releases/latest/download/rocketship-darwin-amd64 && chmod +x /usr/local/bin/rocketship

Linux

AMD64

curl -Lo /usr/local/bin/rocketship https://github.com/rocketship-ai/rocketship/releases/latest/download/rocketship-linux-amd64 && chmod +x /usr/local/bin/rocketship

ARM64

curl -Lo /usr/local/bin/rocketship https://github.com/rocketship-ai/rocketship/releases/latest/download/rocketship-linux-arm64 && chmod +x /usr/local/bin/rocketship

Windows

  1. Download the latest Windows executable from our releases page
  2. Rename it to rocketship.exe
  3. Move it to a directory in your PATH (e.g., C:\Windows\System32\)

Docker

Rocketship is also available as a Docker image. It will run the tests you specify then exit:

docker pull rocketshipai/rocketship:latest

To run Rocketship using Docker:

docker run rocketshipai/rocketship:latest

Verifying Installation

To verify your installation, run:

rocketship version

Optional: Creating an Alias

If you prefer a shorter command, you can create an alias for the rocketship command. Here's how to do it on different platforms:

Unix-like Systems (macOS, Linux)

Add one of these to your shell's configuration file (.bashrc, .zshrc, etc.):

# Alias to "rs"
alias rs="rocketship"

Windows (PowerShell)

Add this to your PowerShell profile:

Set-Alias -Name rs -Value rocketship

Remember to restart your shell or run source ~/.bashrc (or equivalent) to apply the changes.

Next Steps