CLI command reference

Use openship <command> --help to check the version installed on your machine. <value> is required; [value] is optional. Aliases appear beside the command name.

Global options

Option	Meaning
`-V, --version`	output the version number
`--json`	Machine-readable JSON output (stdout data only)
`--context <name>`	Use a saved connection for this command without changing the default
`--api-url <url>`	Use a remote API for this command; authenticate with OPENSHIP_TOKEN
`--local`	Use this machine's installation with its private administrator credential
`--organization <id>`	Use a fixed organization scope for SDK resource commands (remote only)
`--native-config <file>`	Run SDK commands using an explicitly trusted JavaScript configuration
`-h, --help`	display help for command

Put global options before the command, for example openship --json project list. See native mode before using --native-config.

Connect

Command	Purpose
`openship login`	Connect to Cloud or self-hosted Openship with a Personal Access Token
`openship logout`	Remove the stored Openship token
`openship context`	Manage connection contexts (list/use/add/rm)
`openship token`	Manage personal access tokens
`openship access`	Manage workspaces, members, invitations and resource grants
`openship credential`	Manage stored registry and DNS credentials; reads return masked secrets
`openship github`	Connect GitHub, browse repositories and manage deployment sources
`openship api`	Make an authenticated request to any Openship API route (like `gh api`)

Deploy

Command	Purpose
`openship init`	Link the current directory to an Openship project (.openship/project.json)
`openship config`	Author and validate openship.json (declarative deploy config)
`openship deploy`	Trigger a deployment for the current project
`openship deployment`	Manage deployments (list, inspect, redeploy, rollback, …)
`openship logs`	View or stream a deployment's logs

Applications

Command	Purpose
`openship project`	Manage Openship projects
`openship app`	Browse, install, and configure catalog apps
`openship service`	Manage the services in a compose stack (a multi-service project)
`openship domain`	Manage custom domains, DNS verification, and SSL certificates
`openship dns`	Manage DNS providers and zone access

Operations

Command	Purpose
`openship monitoring`	Inspect issues and workload health using the platform's monitoring operations
`openship notification`	Manage notification channels, subscriptions and deliveries
`openship webhook`	Manage incoming deploy and job webhooks
`openship audit`	Inspect audit events and retention settings
`openship analytics`	Read project traffic, deployments and runtime resource measurements
`openship settings`	Manage user preferences on the selected Openship instance

Cloud

Command	Purpose
`openship billing`	Manage Cloud plans, server subscriptions, usage and payment checkouts

Infrastructure

Command	Purpose
`openship job`	Manage self-hosted jobs, schedules, and run logs
`openship server`	Manage Cloud and self-hosted deployment servers
`openship backup`	Manage backups: policies, runs, restores, destinations
`openship edge`	Install and manage the OpenResty edge (reverse proxy, TLS, per-route rules)
`openship mail`	Self-hosted mail server (iRedMail) setup and admin [self-host]
`openship migration`	Discover, import, move and copy Docker workloads between authorized servers, including Cloud
`openship system`	Instance settings, onboarding, migration, and data transfer

Local installation

Command	Purpose
`openship up`	Start Openship as a persistent service (boot + auto-restart); --foreground to run attached
`openship stop`	Stop Openship (started by `openship up`) — it won't restart or return on reboot
`openship status`	Show the local Openship service (installed/running, ports) and the active context's API health
`openship doctor`	Check database + services health and repair a corrupt local database
`openship open`	Open the Openship dashboard in your browser
`openship install`	Download and install the Openship desktop app for this OS
`openship update`	Update the Openship CLI + bundled server to the latest release
`openship uninstall`	Remove Openship from this machine: stop it, delete its data (database, certs, edge config), its images, and ~/.openship. Deployed apps are left running.
`openship reset-admin-password`	Reset the local admin login on THIS machine (no sign-in required)

Shell

Command	Purpose
`openship completion`	Generate shell completion scripts

On this page