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/index.mdx
View on GitHub---
title: Openship CLI
description: 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
```bash
npm install -g openship
openship --help
```
Node.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](https://openship.io/docs/cli/run). To connect directly:
```bash
openship login \
--api-url https://ship.example.com \
--context production
openship project list
openship init --project proj_123
openship deploy --watch
```
`login` 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](https://openship.io/docs/guides/jobs), manual runs, and logs.
<Cards>
<Card title="Connect and authenticate" href="https://openship.io/docs/cli/access" description="Manage contexts, tokens, and direct HTTP requests." />
<Card title="Manage Openship Cloud" href="https://openship.io/docs/cli/cloud" description="Deploy from any machine, choose managed servers, and manage subscriptions." />
<Card title="Deploy and inspect releases" href="https://openship.io/docs/cli/deploy" description="Deploy folders or Git projects, read logs, and roll back." />
<Card title="Manage applications" href="https://openship.io/docs/cli/projects" description="Work with projects, services, domains, and catalog apps." />
<Card title="Monitor and automate" href="https://openship.io/docs/cli/operations" description="Inspect health and issues, configure notifications, and manage webhooks and audit events." />
<Card title="Operate infrastructure" href="https://openship.io/docs/cli/self-host" description="Manage servers, backups, mail, and installation settings." />
<Card title="Use native SDK mode" href="https://openship.io/docs/cli/native" description="Run supported commands against an explicitly configured native installation." />
<Card title="Complete command reference" href="https://openship.io/docs/cli/reference" description="Every command, subcommand, argument, and option, grouped by task." />
</Cards>
## Scripts and application code
Use `openship --json project list` for machine-readable command output. See [automation](https://openship.io/docs/cli/automation)
for CI setup and exit handling. To call the same operations directly from JavaScript or TypeScript,
use the [Node.js SDK](https://openship.io/docs/api/sdk).
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: 322k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 322k | 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 |