CLI & SSH

CLI Tool

The caster CLI deploys a directory to Caster in one command:

caster ./my-site -key YOUR_API_KEY

Deploy to an existing site:

caster ./my-site -site a3f9c2e8 -key YOUR_API_KEY

Or set CASTER_KEY to skip the -key flag:

export CASTER_KEY=YOUR_API_KEY
caster ./my-site

Download

Download the binary for your platform:

After downloading, make it executable (Linux/macOS):

chmod +x caster-cli-*

SSH CLI

Caster also includes a full SSH CLI for managing your sites, deployments, and SSH keys from the terminal. Any command you can do in the web console, you can do over SSH.

Usage

ssh caster.zip <command> [args...]

Your SSH key must be registered with your account. If you've already deployed via git push, your key was registered automatically. Otherwise, add it from the SSH Keys page or via the API.

Commands

Account

# Show your account info (email, user ID)
ssh caster.zip whoami

Sites

# List all your sites
ssh caster.zip sites list

# Create a new site (auto-generates a unique ID)
ssh caster.zip sites create

# Show site details (URL, active deployment, status)
ssh caster.zip sites info a3f9c2e8

# Set a custom subdomain name
ssh caster.zip sites rename a3f9c2e8 my-project

# Delete a site (removes DNS records, git repo, and containers)
ssh caster.zip sites delete a3f9c2e8

Site identifiers can be the short ID (e.g., a3f9c2e8) or the custom name if one is set.

Deployments

# List deployments for a site
ssh caster.zip deployments list a3f9c2e8

# Show details for a specific deployment
ssh caster.zip deployments info a3f9c2e8 42

# View build logs for a deployment
ssh caster.zip deployments logs a3f9c2e8 42

SSH Keys

# List your registered SSH keys
ssh caster.zip keys list

# Add a new SSH key
ssh caster.zip keys add laptop ssh-ed25519 AAAA... you@laptop

# Remove an SSH key by ID
ssh caster.zip keys remove 3

Examples

Deploy with git (site is auto-created on push):

cd ~/my-project
git remote add caster git@caster.zip:anything.git
git push caster main
# Output: Site live at https://a3f9c2e8.caster.zip

# Check deployment status
ssh caster.zip deployments list a3f9c2e8

Set a custom name:

ssh caster.zip sites rename a3f9c2e8 my-project
# Now accessible at both a3f9c2e8.caster.zip and my-project.caster.zip

Help

Run help to see all available commands:

ssh caster.zip help