Openship CLI
Deploy applications and manage Openship from your terminal.
Use the CLI to deploy code, inspect releases, and manage Openship Cloud or a remote self-hosted installation from any machine with Node.js and access to that API. A local Openship server or Docker installation is not required for remote commands.
Install
npm install -g openship
openship --helpNode.js 22 or later is required. A local npm install openship also provides the command through npx.
The reference follows this repository; use --help to check your installed version. SDK imports and
native mode are available in openship 0.8.0 and later. Newly added commands require a release containing them.
Connect and deploy
Run openship for a guided choice of Cloud, a remote self-hosted installation, or
installing on this machine. To connect directly:
openship login \
--api-url https://ship.example.com \
--context production
openship project list
openship init --project proj_123
openship deploy --watchlogin opens the token settings page and asks for a personal access token. init links the current
directory to a project. deploy --watch submits a deployment and follows its progress.
Use openship login --cloud for Openship Cloud. On the server that runs Openship, the installation
owner can use openship --local project list with automatic local authentication.
Choose a workflow
Use openship job (alias jobs) to manage scheduled jobs, manual runs, and logs.
Connect and authenticate
Manage contexts, tokens, and direct HTTP requests.
Manage Openship Cloud
Deploy from any machine, choose managed servers, and manage subscriptions.
Deploy and inspect releases
Deploy folders or Git projects, read logs, and roll back.
Manage applications
Work with projects, services, domains, and catalog apps.
Monitor and automate
Inspect health and issues, configure notifications, and manage webhooks and audit events.
Operate infrastructure
Manage servers, backups, mail, and installation settings.
Use native SDK mode
Run supported commands against an explicitly configured native installation.
Complete command reference
Every command, subcommand, argument, and option, grouped by task.
Scripts and application code
Use openship --json project list for machine-readable command output. See automation
for CI setup and exit handling. To call the same operations directly from JavaScript or TypeScript,
use the Node.js SDK.