project

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship project

Manage Openship projects

openship project|projects [options] [command]

Subcommand	Purpose
`list\|ls`	List projects in the active organization
`get <id>`	Show a single project
`rename <id> <name>`	Change a project's display name
`release-image [options] <id>`	Track and deploy a versioned prebuilt container image
`create [options]`	Create a project
`delete\|rm [options] <id>`	Delete a project (tears down all resources)
`env`	Manage project environment variables
`git`	Manage git linkage and auto-deploy
`connect [options] <id> <domain>`	Connect a custom domain to a project
`enable <id>`	Start a stopped project
`disable <id>`	Stop a running project
`sleep-mode <id> <mode>`	Set the project sleep mode
`transfer <id> <direction>`	Promote a project to Openship Cloud, or bring it back (self-hosted only)
`logs [options] <id>`	Show or stream runtime (container) logs
`server-logs [options] <id>`	Show or stream HTTP request logs (edge/OpenResty)
`cluster`	Configure cluster placement and scale a deployed workload
`database`	Manage project databases, replicas, backups and application connections
`volume`	Manage replicated project volumes and recoverable backups
`options [options] <id> [file]`	Change supported project options using the shared input schema
`clear-build-cache [options] <id>`	Clear the host build cache used by this project; other projects on that host share it
`deployments [options] <id>`	Read full project deployment records with pagination
`clone-token`	Manage this project's explicit clone credential
`local`	Manage folders on the Openship instance; use deploy --folder for this machine's files
`routing`	Manage project routing rules and retry route synchronization
`update <id> <file>`	Patch a project's build and runtime configuration
`environment\|environments`	Manage isolated project environments (each has its own project ID)
`resources`	Inspect and configure project CPU, memory, disk and build limits
`storage`	Inspect storage and bind an app's object storage connection
`connections`	Wire app outputs into a project's environment through the engine
`pending <id>`	Show pending deployment, routing and certificate actions
`incidents <id>`	Show this project's monitoring incidents
`drift <id>`	Compare source and deployment configuration
`rollback-capacity <id>`	Inspect retained rollback capacity
`info <id>`	Read project details and deployment configuration
`git-info <id>`	Read the configured repository and source state
`session <id>`	Find this project's active deployment session
`check-ports <id>`	Probe configured service ports on the deployment destination
`check-output <id>`	Inspect deployed static output on its actual destination
`edge-config <id>`	Read effective edge routing configuration

openship project check-output

Inspect deployed static output on its actual destination

openship project check-output [options] <id>

Argument	Meaning
`id`	Project ID

openship project check-ports

Probe configured service ports on the deployment destination

openship project check-ports [options] <id>

Argument	Meaning
`id`	Project ID

openship project clear-build-cache

Clear the host build cache used by this project; other projects on that host share it

openship project clear-build-cache [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`-y, --yes`	Confirm clearing the destination's shared build cache

openship project clone-token

Manage this project's explicit clone credential

openship project clone-token [options] [command]

Subcommand	Purpose
`get <id>`	Read credential presence without revealing its value
`set <id> <file>`	Save a project-specific clone token
`clear <id>`	Remove this project's explicit clone token

openship project clone-token clear

Remove this project's explicit clone token

openship project clone-token clear [options] <id>

Argument	Meaning
`id`	Project ID

openship project clone-token get

Read credential presence without revealing its value

openship project clone-token get [options] <id>

Argument	Meaning
`id`	Project ID

openship project clone-token set

Save a project-specific clone token

openship project clone-token set [options] <id> <file>

Argument	Meaning
`id`	Project ID
`file`	Token file, or - for stdin

openship project cluster

Configure cluster placement and scale a deployed workload

openship project cluster [options] [command]

Subcommand	Purpose
`get <project>`	Read placement, replicas and the revision required for changes
`set [options] <id> [file]`	Set or clear cluster placement with explicit stateless-workload acknowledgement
`scale [options] <project> <replicas>`	Scale the reviewed deployment; returns the new deployment ID to follow

openship project cluster get

Read placement, replicas and the revision required for changes

openship project cluster get [options] <project>

Argument	Meaning
`project`	Project ID

openship project cluster scale

Scale the reviewed deployment; returns the new deployment ID to follow

openship project cluster scale [options] <project> <replicas>

Argument	Meaning
`project`	Project ID
`replicas`	Desired replicas

Option	Meaning
`--deployment <id>`	Active deployment ID from cluster get
`--updated-at <timestamp>`	Exact updatedAt from cluster get

openship project cluster set

Set or clear cluster placement with explicit stateless-workload acknowledgement

openship project cluster set [options] <id> [file]

Argument	Meaning
`id`	Resource ID
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request
`-y, --yes`	Confirm this operation

openship project connect

Connect a custom domain to a project

openship project connect [options] <id> <domain>

Argument	Meaning
`id`	Project ID
`domain`	Custom domain hostname

Option	Meaning
`--include-www`	Also connect the www. variant

openship project create

Create a project

openship project create [options]

Option	Meaning
`--name <name>`	Project name (required unless supplied in --config)
`--config <file>`	Full project configuration as JSON, or - for stdin; flags override supplied fields
`--schema`	Print the complete create input schema without making a request
`--slug <slug>`	Free-subdomain slug (slug.opsh.io)
`--git-owner <owner>`	GitHub owner/org
`--git-repo <repo>`	GitHub repository name
`--git-branch <branch>`	Git branch to deploy
`--framework <framework>`	Stack/framework id
`--local-path <path>`	Source path on the controller host; use deploy --folder to upload from this machine
`--port <port>`	Container port
`--type <type>`	Project type: app \| docker \| services \| monorepo
`--server <id>`	Registered server ID (see `openship server list`)

openship project delete

Delete a project (tears down all resources)

openship project delete|rm [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--force`	Cancel active work and delete anyway
`--force-orphan`	Orphan resources that won't destroy, then drop the row
`--wipe-volumes`	Also destroy persistent volumes
`-y, --yes`	Skip the confirmation prompt

openship project deployments

Read full project deployment records with pagination

openship project deployments [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--page <number>`	Page number
`--limit <number>`	Page size
`--environment <name>`	Environment filter
`--status <status>`	Deployment status
`--search <text>`	Search deployments

openship project disable

Stop a running project

openship project disable [options] <id>

Argument	Meaning
`id`	Project ID

openship project drift

Compare source and deployment configuration

openship project drift [options] <id>

Argument	Meaning
`id`	Project ID

openship project edge-config

Read effective edge routing configuration

openship project edge-config [options] <id>

Argument	Meaning
`id`	Project ID

openship project enable

Start a stopped project

openship project enable [options] <id>

Argument	Meaning
`id`	Project ID

openship project env

Manage project environment variables

openship project env [options] [command]

Subcommand	Purpose
`get [options] <id>`	List env vars (secret values are masked by the API)
`set [options] <id> [pairs...]`	Merge env vars: upsert KEY=VALUE pairs and/or delete keys

openship project env get

List env vars (secret values are masked by the API)

openship project env get [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--environment <env>`	Filter by environment (production\|preview\|development)

openship project env set

Merge env vars: upsert KEY=VALUE pairs and/or delete keys

openship project env set [options] <id> [pairs...]

Argument	Meaning
`id`	Project ID
`pairs`	KEY=VALUE pairs to upsert (same as --set)

Option	Meaning
`--environment <env>`	Target environment (default: "production")
`--set <pair>`	KEY=VALUE to upsert (repeatable) (default: [])
`--unset <key>`	KEY to delete (repeatable) (default: [])
`--secret`	Mark every upserted value as a secret

openship project environment

Manage isolated project environments (each has its own project ID)

openship project environment|environments [options] [command]

Subcommand	Purpose
`list\|ls <id>`	List this project's environments and their project IDs
`create [options] <id> <name>`	Create an isolated environment; deploy and link the returned project ID

openship project environment create

Create an isolated environment; deploy and link the returned project ID

openship project environment create [options] <id> <name>

Argument	Meaning
`id`	Source project ID
`name`	Environment name

Option	Meaning
`--slug <slug>`	Environment slug
`--type <type>`	production \| preview \| development (default: "preview")
`--branch <branch>`	Git branch for the environment
`--source-mode <mode>`	How this environment tracks source (choices: "branch", "manual")

openship project environment list

List this project's environments and their project IDs

openship project environment list|ls [options] <id>

Argument	Meaning
`id`	Project ID

openship project get

Show a single project

openship project get [options] <id>

Argument	Meaning
`id`	Project ID

openship project git-info

Read the configured repository and source state

openship project git-info [options] <id>

Argument	Meaning
`id`	Project ID

openship project incidents

Show this project's monitoring incidents

openship project incidents [options] <id>

Argument	Meaning
`id`	Project ID

openship project info

Read project details and deployment configuration

openship project info [options] <id>

Argument	Meaning
`id`	Project ID

openship project list

List projects in the active organization

openship project list|ls [options]

openship project local

Manage folders on the Openship instance; use deploy --folder for this machine's files

openship project local [options] [command]

Subcommand	Purpose
`list`	List projects linked to folders on the controller
`scan <path>`	Inspect a folder accessible to the self-hosted controller
`import [options] [file]`	Register a folder on the controller as a project

openship project local import

openship project local import [options] [file]

Argument	Meaning
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request

openship project local list

List projects linked to folders on the controller

openship project local list [options]

openship project local scan

Inspect a folder accessible to the self-hosted controller

openship project local scan [options] <path>

Argument	Meaning
`path`	Absolute path on the controller

openship project logs

Show or stream runtime (container) logs

openship project logs [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--tail <n>`	Number of recent lines
`-f, --follow`	Stream logs until interrupted

openship project options

Change supported project options using the shared input schema

openship project options [options] <id> [file]

Argument	Meaning
`id`	Resource ID
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request

openship project pending

Show pending deployment, routing and certificate actions

openship project pending [options] <id>

Argument	Meaning
`id`	Project ID

openship project release-image

Track and deploy a versioned prebuilt container image

openship project release-image [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--image-template <reference>`	Image reference with {tag} or {version}, e.g. ghcr.io/acme/api:{tag}
`--github-repo <owner/repo>`	Resolve versions from GitHub Releases
`--version-url <https-url>`	HTTPS endpoint returning a version or tag
`--pin <version>`	Deploy a fixed version instead of the discovered latest release

openship project rename

Change a project's display name

openship project rename [options] <id> <name>

Argument	Meaning
`id`	Project ID
`name`	New display name

openship project resources

Inspect and configure project CPU, memory, disk and build limits

openship project resources [options] [command]

Subcommand	Purpose
`get <id>`	Show limits and available capacity from the engine
`set <id> <file>`	Change resource limits; the engine enforces destination capacity and Cloud policy

openship project resources get

Show limits and available capacity from the engine

openship project resources get [options] <id>

Argument	Meaning
`id`	Project ID

openship project resources set

Change resource limits; the engine enforces destination capacity and Cloud policy

openship project resources set [options] <id> <file>

Argument	Meaning
`id`	Project ID
`file`	JSON patch with production/build resource selections, sleepMode or port

openship project rollback-capacity

Inspect retained rollback capacity

openship project rollback-capacity [options] <id>

Argument	Meaning
`id`	Project ID

openship project server-logs

Show or stream HTTP request logs (edge/OpenResty)

openship project server-logs [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`--limit <n>`	Number of recent entries (max 200)
`--domain <domain>`	Restrict to a specific domain
`-f, --follow`	Stream request logs until interrupted

openship project session

Find this project's active deployment session

openship project session [options] <id>

Argument	Meaning
`id`	Project ID

openship project sleep-mode

Set the project sleep mode

openship project sleep-mode [options] <id> <mode>

Argument	Meaning
`id`	Project ID
`mode`	One of: auto_sleep, always_on

openship project storage

Inspect storage and bind an app's object storage connection

openship project storage [options] [command]

Subcommand	Purpose
`get <id>`	Show the storage binding, volumes and available providers
`bind <id> <file>`	Save an object storage binding; redeploy to apply its variables
`unbind [options] <id>`	Remove the object's storage binding from this project

openship project storage bind

Save an object storage binding; redeploy to apply its variables

openship project storage bind [options] <id> <file>

Argument	Meaning
`id`	Project ID
`file`	JSON storage binding: bucket and sourceProjectId, or external provider credentials

openship project storage get

Show the storage binding, volumes and available providers

openship project storage get [options] <id>

Argument	Meaning
`id`	Project ID

openship project storage unbind

Remove the object's storage binding from this project

openship project storage unbind [options] <id>

Argument	Meaning
`id`	Project ID

Option	Meaning
`-y, --yes`	Skip confirmation

openship project transfer

Promote a project to Openship Cloud, or bring it back (self-hosted only)

openship project transfer [options] <id> <direction>

Argument	Meaning
`id`	Project ID
`direction`	One of: to-cloud, to-self-hosted

openship project update

Patch a project's build and runtime configuration

openship project update [options] <id> <file>

Argument	Meaning
`id`	Project ID
`file`	JSON patch using the shared project update contract

On this page