fcakyon/claude-codex-settings / plugins/openship-skills/skills/openship-deploy
openship-deploy
VerifiedThis skill should be used when the user asks to "deploy with OpenShip", "manage a self-hosted OpenShip instance", "debug an OpenShip deployment", or manage its domains, storage, backups, or upgrades through the CLI.
| File | Kind | Size |
|---|---|---|
| LICENSE | other | 11.1 KB |
| SKILL.md | skill md | 4.0 KB |
| references/cli/access.mdx | markdown | 7.6 KB |
| references/cli/automation.mdx | markdown | 3.4 KB |
| references/cli/deploy.mdx | markdown | 4.4 KB |
| references/cli/edge.mdx | markdown | 2.0 KB |
| references/cli/index.mdx | markdown | 3.2 KB |
| references/cli/projects.mdx | markdown | 5.1 KB |
| references/cli/run.mdx | markdown | 2.6 KB |
| references/cli/self-host.mdx | markdown | 4.7 KB |
| references/guides/backups-restore.mdx | markdown | 12.9 KB |
| references/guides/custom-domains.mdx | markdown | 22.3 KB |
| references/guides/logs-monitoring.mdx | markdown | 11.8 KB |
| references/guides/migrate-control-plane.mdx | markdown | 10.4 KB |
| references/guides/persistent-storage.mdx | markdown | 7.0 KB |
| references/guides/rollback-redeploy.mdx | markdown | 16.3 KB |
| references/guides/self-hosted-github-app.mdx | markdown | 6.6 KB |
| references/guides/updating.mdx | markdown | 8.1 KB |
| references/troubleshooting/deployments.mdx | markdown | 18.0 KB |
| references/troubleshooting/domains-ssl.mdx | markdown | 16.4 KB |
| references/upstream.json | config | 7.6 KB |
references/cli/run.mdx
View on GitHub---
title: Run and maintain Openship
description: 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](https://openship.io/docs/cli/access) instead.
## Start
```bash
openship
```
On 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:
```bash
openship up
openship status
openship open
```
`up` 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](https://openship.io/docs/cli/reference/up), 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](https://openship.io/docs/cli/access).
## Stop and update
```bash
openship stop
openship update
```
`stop` disables the service so it stays stopped across reboot. `update` updates the CLI and bundled
server. Read [updating Openship](https://openship.io/docs/guides/updating) before updating a production installation.
## Diagnose a problem
```bash
openship doctor
```
The [doctor reference](https://openship.io/docs/cli/reference/doctor) describes health and repair options. Local admin
account recovery uses [reset-admin-password](https://openship.io/docs/cli/reference/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](https://openship.io/docs/getting-started/installation) for platform requirements and
[command options](https://openship.io/docs/cli/reference#local-installation) before removing or repairing an installation.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 321k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |