Install
Requires Node.js >= 20.
npm install -g @shipstatic/ship
Authenticate
ship config
Enter your API key when prompted. Get one at https://my.shipstatic.com/settings
Alternative: set the SHIP_API_KEY environment variable or pass --api-key per command.
Workflow 1 — Deploy
ship ./dist
ship ./dist --label production --label v1.0
ship ./dist --json # Returns {"deployment": "<id>", "url": "https://..."}
Workflow 2 — Reserve a Domain
# Pre-flight check
ship domains validate www.example.com
# Reserve (no deployment linked yet)
ship domains set www.example.com
# Or reserve an internal subdomain (instant, no DNS)
ship domains set my-site
Internal domains (my-site.shipstatic.com) are free and instant. Custom domains require DNS configuration — the CLI prints the required records.
Apex domains are not supported. Always use a subdomain: www.example.com, not example.com.
Workflow 3 — Link Domain to Deployment
# Link domain to a deployment
ship domains set www.example.com <deployment-id>
# Switch to a different deployment (instant rollback)
ship domains set www.example.com <other-deployment-id>
# For custom domains: verify DNS after configuring records
ship domains verify www.example.com
Reference
# Deployments
ship deployments list
ship deployments get <id>
ship deployments set <id> --label production
ship deployments remove <id>
# Domains
ship domains list
ship domains get <name>
ship domains validate <name>
ship domains verify <name>
ship domains remove <name>
# Account
ship whoami
ship ping
Use --json on any command for machine-readable output.