Run and maintain Openship
Start a local installation, inspect it, and manage its lifecycle.
Use these commands on the machine that runs Openship. To manage an existing remote installation, configure a connection context instead.
Start
openshipOn a fresh machine, choose Install Openship on this machine for the interactive setup. The same
menu also connects to Cloud or an existing self-hosted installation. On an installed machine,
openship opens the local control panel or resumes an interrupted setup.
For direct startup:
openship up
openship status
openship openup installs or starts a persistent service. status reports local service state and the active
context's API health. open opens the dashboard. Use openship up --foreground for an attached process.
See all startup options, including Docker Compose configuration.
The installation owner can use openship --local project list without creating or pasting a token.
Local resource commands authenticate with the installation's protected credential; the public API
still requires authentication. See local and remote access.
Stop and update
openship stop
openship updatestop disables the service so it stays stopped across reboot. update updates the CLI and bundled
server. Read updating Openship before updating a production installation.
Diagnose a problem
openship doctorThe doctor reference describes health and repair options. Local admin account recovery uses reset-admin-password.
Installation commands compared
| Command | Purpose |
|---|---|
npm install -g openship | Install the CLI globally. |
npm install openship | Add Ship SDK and the CLI to a Node project. SDK imports are available in 0.8.0 and later. |
openship install | Download and install the desktop application. |
openship install cache | Inspect or manage cached installation downloads. |
openship up | Start the Openship API and dashboard as a local service. |
openship uninstall | Remove local installation state and data; deployed apps are left running. |
See installation for platform requirements and command options before removing or repairing an installation.