Skip to main content

​
Installation

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

CommandDescription
crewship loginAuthenticate with Crewship
crewship logoutRemove stored credentials
crewship whoamiShow current authenticated user

​
Command Reference

​
Project Setup

CommandDescription
crewship initInitialize a crewship.toml config

​
Deployment

CommandDescription
crewship deployDeploy your crew to production
crewship deployment listList all deployments
crewship deployment deleteDelete a deployment
crewship version listList versions for a deployment
crewship version deleteDelete a version

​
Environment

CommandDescription
crewship env setSet environment variables
crewship env listList all environment variables
crewship env getGet a specific variable
crewship env rmRemove environment variables

​
Execution

CommandDescription
crewship invokeRun your deployed crew

​
Updates

CommandDescription
crewship upgradeUpdate 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:
  1. Command-line flags
  2. Environment variables (CREWSHIP_*)
  3. Project config (crewship.toml)
  4. User config (~/.crewship/config.json)

​
Environment Variables

VariableDescription
CREWSHIP_API_URLOverride API endpoint (for development)
CREWSHIP_TOKENAPI 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

CodeMeaning
0Success
1General error
2Invalid arguments
3Authentication required
4Network 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