Projects, services & domains

These commands are the terminal side of the dashboard's project screens: they create and inspect projects, manage the services inside a compose stack, and attach custom domains. Everything here talks to your instance's /api under the hood, so the same rules apply as anywhere else in the CLI.

openship init

Links the current directory to a project by writing .openship/project.json. Later commands (like openship deploy) read that file so you don't have to pass a project every time. With no --project, it lists your projects and prompts you to pick one.

# Interactive picker
openship init

# Link a specific project non-interactively
openship init --project proj_123 --environment production

openship project

Project lifecycle: list, inspect, create, delete, plus environment variables, git linkage, power state, sleep mode, cloud transfer, and logs. Alias: openship projects.

Subcommands

create

openship project create --name "My App" --slug my-app \
  --git-owner acme --git-repo my-app --git-branch main --framework nextjs

delete

Tears down containers, routes, and (optionally) volumes, then removes the project row. Prompts for confirmation unless you pass -y.

openship project delete proj_123 --wipe-volumes -y

env

Read or update a project's environment variables. set is a merge: it upserts the pairs you pass and deletes the keys you --unset, leaving everything else untouched. See the environment variables guide for how these flow into builds and runtime.

# List production vars
openship project env get proj_123 --environment production

# Upsert two secret vars and remove another (other keys are left untouched)
openship project env set proj_123 \
  --set DATABASE_URL=postgres://… --set API_TOKEN=sk-… --secret \
  --unset OLD_KEY

git

Manage the GitHub link and push-to-deploy. After linking a repo, auto-deploy turns on redeploy-on-push; webhook-domain selects which verified project domain receives webhook deliveries. See the auto-deploy guide for the full flow.

openship project git link proj_123 --owner acme --repo my-app --branch main
openship project git auto-deploy proj_123 --enable
openship project git branch proj_123 develop
openship project git webhook-domain proj_123 app.example.com   # or: --clear

Pass exactly one of --enable / --disable. git webhook-domain takes an optional [domain] argument or a --clear flag to unset it.

connect

Attaches a custom domain and prints the DNS records to add. Verification then runs automatically once the records resolve.

openship project connect proj_123 app.example.com --include-www

enable / disable

Power a project on or off without deleting it.

openship project disable proj_123
openship project enable proj_123

sleep-mode

Controls whether the project sleeps when idle. See the sleep mode & resources guide.

openship project sleep-mode proj_123 auto_sleep   # or: always_on

transfer

Moves a project between your self-hosted instance and Openship Cloud. Only available on a self-hosted instance; see the cloud connect & migration guide.

openship project transfer proj_123 to-cloud        # or: to-self-hosted

logs / server-logs

logs shows the container's runtime output; server-logs shows edge HTTP request logs (OpenResty). Both print recent lines by default, or stream with -f. More context in the logs & monitoring guide.

openship project logs proj_123 --tail 100 -f
openship project server-logs proj_123 --limit 200 --domain app.example.com

openship service

Manage the services inside a compose stack (a multi-service project). Alias: openship services. Every subcommand targets a stack with -p, --project <id|slug|name> and then a service by its name or svc_… id. For the bigger picture, see the multi-service compose guide.

Subcommands

create

openship service create -p my-stack db \
  --image postgres:16 --port 5432:5432 --env POSTGRES_PASSWORD=secret

openship service create -p my-stack web \
  --build ./web --dockerfile Dockerfile --port 3000:3000 \
  --depends-on db --expose --exposed-port 3000 --domain my-web

sync

Reconciles the stack against a compose file: services present in the file are created or updated, and services not in the file are removed. Parsing is delegated to Docker Compose, so docker (Compose v2) must be installed locally.

openship service sync -p my-stack ./docker-compose.yml -y

delete

openship service delete -p my-stack db -y

drift

When an upstream compose change touches a value you edited in the dashboard, the service is flagged with pending drift. Resolve it by taking the upstream values (accept) or keeping your edits (keep).

openship service drift accept -p my-stack web
openship service drift keep   -p my-stack web

env

Read or set a service's environment variables, scoped to one environment. Unlike project env, the service set command targets a single environment and merges into it by default; --replace swaps the whole set.

openship service env get -p my-stack web --env production
openship service env set -p my-stack web LOG_LEVEL=debug FEATURE_X=on --env production

logs

openship service logs -p my-stack web --tail 200 -f

openship domain

Manage custom domains, DNS verification, and SSL certificates. This is the terminal side of a project's Domains tab; the same operations are documented as HTTP endpoints in the Domains API reference, and the full walkthrough lives in the custom domains guide.

Subcommands

Typical flow

# 1. See the records a hostname will need
openship domain preview app.example.com

# 2. Attach it to a project (prints the exact records to add)
openship domain add app.example.com -p proj_123 --primary

# 3. After the DNS records propagate, verify
openship domain verify <domainId>