CLI Reference

The Openship CLI runs the platform locally and manages projects, deployments, domains, and more from your terminal.

Installation

$ curl -fsSL https://get.openship.io | sh

Or with any package manager:

npm i -g openship      # or: pnpm add -g openship / yarn global add openship / bun add -g openship

Install + start Openship as a persistent background service — bundled API + embedded database, plus the dashboard (lazy-downloaded on first run). It starts on boot and auto-restarts until openship stop. Local access needs no login (loopback). Uses systemd (Linux), launchd (macOS), or a Scheduled Task (Windows, best-effort).

openship up                       # install + start the service (API :4000, dashboard :3001)
openship up --foreground          # run attached in this terminal instead (one-off)
openship up --no-ui               # API only, no dashboard
openship up --dry-run             # print the service definition without installing
openship up --port 4000 --dashboard-port 3001 --data-dir ~/.openship/data

`openship stop`

Stop the service started by openship up — it won't restart or return on reboot.

openship stop

`openship install`

Download and install the desktop app (a self-contained GUI bundling API + dashboard + database) for your OS from GitHub releases, verified against its checksum.

openship install                  # latest, verified, then launch
openship install --version v0.1.9 --no-launch

`openship open`

Open the dashboard in your browser (local by default, --cloud for the hosted app).

openship open
openship open --cloud
openship open --path /settings

Authenticate against a remote or cloud instance with a Personal Access Token (create one in dashboard Settings). Not needed for local openship up (loopback is zero-auth).

openship login --api-url https://your-server --token <PAT>
openship logout

`openship status` / `doctor`

openship status     # active context's API health + deploy mode
openship doctor     # diagnose config, context/token, API reachability, runtime

Projects & deployments

`openship init`

Link the current directory to an existing project — writes .openship/project.json so later commands know which project to act on (no flag needed). It does not run or install anything; start the platform with openship up first (or connect to a remote/cloud instance), then link.

cd your-project
openship init                     # pick a project interactively
openship init --project proj_… --environment production

`openship deploy`

Trigger a deployment for the linked (or --project) project.

openship deploy                       # deploy the linked project
openship deploy --env preview         # production | preview (default: production)
openship deploy --branch main --commit <sha>
openship deploy --smart-route         # rebuild only services changed since the active deploy

`openship project`

openship project list                         # list projects
openship project get <id>
openship project create --name my-app
openship project env <id> …                   # manage env vars
openship project connect <id> example.com     # connect a custom domain
openship project enable|disable <id>
openship project logs <id>                     # runtime (container) logs

`openship service`

Manage the services in a compose (multi-service) project — env, drift, and lifecycle. openship service --help lists subcommands.

`openship deployment`

openship deployment list --project <id>
openship deployment inspect <deploymentId>
openship deployment redeploy <deploymentId>
openship deployment rollback <deploymentId>   # roll back to a prior deployment
openship deployment cancel <deploymentId>

`openship logs`

openship logs <deploymentId>          # view or stream a deployment's logs

Infrastructure

openship domain — custom domains, DNS verification, SSL certificates.
openship server — manage self-hosted SSH servers (install Docker/git/OpenResty/certbot, etc.).
openship backup — backup policies, runs, restores, and destinations.
openship mail — self-hosted mail server (iRedMail) setup and admin.

Advanced

openship context (ctx) — manage connection contexts (list/use/add/rm) for switching between local, remote, and cloud instances.
openship token — manage personal access tokens.
openship system — instance settings, onboarding, migration, and data transfer.
openship api <path> — make an authenticated request to any API route (like gh api).

Run openship <command> --help for full flags on any command.