CLI Overview

Installation

macOS / Linux
Windows

Install the CLI with a single command:

curl -fsSL https://www.crewship.dev/install.sh | bash

This automatically detects your platform and installs the binary to ~/.local/bin.

Run this command in PowerShell:

Invoke-WebRequest -Uri "https://api.crewship.dev/cli/releases/latest/download?platform=windows-x64" -OutFile "$env:LOCALAPPDATA\Programs\crewship.exe"

Then add the install location to your PATH:

$path = [Environment]::GetEnvironmentVariable("Path", "User")
if ($path -notlike "*$env:LOCALAPPDATA\Programs*") {
    [Environment]::SetEnvironmentVariable("Path", "$path;$env:LOCALAPPDATA\Programs", "User")
}

Restart your terminal for the PATH change to take effect.

Verify the installation:

crewship --version

Authentication

Before using most commands, authenticate with your Crewship account:

crewship login

This opens a browser for authentication. Your credentials are stored securely in ~/.crewship/credentials.json.

Authentication commands

Command	Description
`crewship login`	Authenticate with Crewship
`crewship logout`	Remove stored credentials
`crewship whoami`	Show current authenticated user

Command Reference

Project Setup

Command	Description
`crewship init`	Initialize a crewship.toml config

Deployment

Command	Description
`crewship deploy`	Deploy your crew to production
`crewship deployment list`	List all deployments
`crewship deployment delete`	Delete a deployment
`crewship version list`	List versions for a deployment
`crewship version delete`	Delete a version

Environment

Command	Description
`crewship env set`	Set environment variables
`crewship env list`	List all environment variables
`crewship env get`	Get a specific variable
`crewship env rm`	Remove environment variables

Execution

Command	Description
`crewship invoke`	Run your deployed crew

Updates

Command	Description
`crewship upgrade`	Update crewship to the latest version

Global Options

These options are available for all commands:

crewship [command] --help     # Show help for a command
crewship [command] --version  # Show CLI version
crewship [command] --debug    # Enable debug output

Multi-Deployment Support

For projects with multiple deployments in a single crewship.toml, use --name / -n to target a specific deployment:

crewship deploy --name research-agent
crewship invoke --name writer-agent --input '{"topic": "AI"}'
crewship env set --name research-agent OPENAI_API_KEY=sk-...

See the crewship.toml reference for configuration details.

Configuration

The CLI looks for configuration in this order:

Command-line flags
Environment variables (CREWSHIP_*)
Project config (crewship.toml)
User config (~/.crewship/config.json)

Environment Variables

Variable	Description
`CREWSHIP_API_URL`	Override API endpoint (for development)
`CREWSHIP_TOKEN`	API token for CI/CD (instead of interactive login)

CI/CD Usage

For automated deployments, use an API token instead of interactive login:

# Set token as environment variable
export CREWSHIP_TOKEN=your_api_token

# Deploy (no login required)
crewship deploy

Generate API tokens in the Console under Settings → API Keys.

Exit Codes

Code	Meaning
`0`	Success
`1`	General error
`2`	Invalid arguments
`3`	Authentication required
`4`	Network error

Next Steps

Initialize

Set up your project

Deploy

Deploy your crew

Deployments

List and delete deployments

Versions

List and delete versions

Environment

Manage secrets

Invoke

Run your crew

Getting Started

CLI Reference

Configuration

Guides

Installation

Authentication

Authentication commands

Command Reference

Project Setup

Deployment

Environment

Execution

Updates

Global Options

Multi-Deployment Support

Configuration

Environment Variables

CI/CD Usage

Exit Codes

Next Steps

Initialize

Deploy

Deployments

Versions

Environment

Invoke

​Installation

​Authentication

​Authentication commands

​Command Reference

​Project Setup

​Deployment

​Environment

​Execution

​Updates

​Global Options

​Multi-Deployment Support

​Configuration

​Environment Variables

​CI/CD Usage

​Exit Codes

​Next Steps

Initialize

Deploy

Deployments

Versions

Environment

Invoke

Installation

Authentication

Authentication commands

Command Reference

Project Setup

Deployment

Environment

Execution

Updates

Global Options

Multi-Deployment Support

Configuration

Environment Variables

CI/CD Usage

Exit Codes

Next Steps