Skip to content

Quick Start Guide

Get started with Rocketship in minutes! This guide will help you install Rocketship and run your first test.

Installation

First, install Temporal (required for the local engine):

brew install temporal

Then install the Rocketship CLI:

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

For detailed installation instructions for other platforms and optional aliases, see the Installation Guide.

Your First Test

Create a test file:

cat > simple-test.yaml << 'EOF'
name: "Simple Test Suite"
description: "A simple test suite!"
version: "v1.0.0"
tests:
  - name: "API Health Check"
    steps:
      - name: "Check API status"
        plugin: "http"
        config:
          method: "GET"
          url: "https://httpbin.org/status/200"
        assertions:
          - type: "status_code"
            expected: 200
EOF

Run the test:

rocketship run -af simple-test.yaml

The -a flag tells Rocketship to automatically start and stop the local server, and -f specifies the test file to run.

Test Run Management

Rocketship automatically tracks your test runs with context information, making it easy to organize and find results.

Adding Context to Your Runs

You can add context to your test runs for better organization:

# Run with project context
rocketship run -af simple-test.yaml \
  --project-id "my-app" \
  --source "cli-local" \
  --branch "main" \
  --trigger "manual"

# Add custom metadata
rocketship run -af simple-test.yaml \
  --project-id "my-app" \
  --metadata "env=staging" \
  --metadata "team=backend"

Viewing Test History

List your recent test runs:

# List all recent runs
rocketship list

# Filter by project
rocketship list --project-id "my-app"

# Filter by status
rocketship list --status FAILED

# Get detailed information about a specific run
rocketship get <run-id>

Next Steps