CLI Reference | Shipyard

Deploy in seconds with zero configuration

Automatic deployments from your branches

Environment variables encrypted at rest

Always stay on the latest version

Commands

shipyard login Required

Authenticate with your Shipyard account. Opens browser for OAuth flow.

$ shipyard login
Opening browser for authentication...
✓ Logged in as user@example.com

shipyard logout

Log out and remove stored credentials.

shipyard whoami

Display the currently logged in user.

shipyard deploy Most Used

Deploy the current project to production.

--preview Create a preview deployment instead of production

--prod Deploy directly to production (default)

--force Skip build cache and deploy fresh

$ shipyard deploy
Building project...
Uploading assets...
✓ Deployed to https://my-app.shipyard.dev

shipyard init

Initialize a new project in the current directory. Creates shipyard.json config.

shipyard logs

Stream real-time logs from your deployment.

--follow, -f Follow log output in real-time

--since Show logs since timestamp (e.g., 1h, 30m)

shipyard env

Manage environment variables for your project.

shipyard env list shipyard env add KEY=value shipyard env rm KEY shipyard env pull

shipyard domains

Manage custom domains for your project.

shipyard domains list shipyard domains add example.com shipyard domains rm example.com

Install the CLI and deploy your first project in under 3 minutes.

$ npm install -g shipyard && shipyard login