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/deploy.mdx
View on GitHub---
title: Deploy and manage releases
description: Deploy a linked project or local folder, follow logs, and control releases.
---
First [connect to an installation](https://openship.io/docs/cli/access) or configure [native mode](https://openship.io/docs/cli/native).
## Deploy a Git project
From your repository, link an existing Openship project whose source is configured:
```bash
openship init --project proj_123
openship deploy --watch
```
Use `--project` to select a project without changing the local link. Select a branch, commit,
variable set, or registered server when needed:
```bash
openship deploy --project proj_123 --branch main --env production --watch
openship deploy --project proj_123 --server srv_123 --watch
```
For a preview, first create or select a **non-production project environment** with
`openship project environment create <project-id> Preview --type preview`,
then deploy its project ID. That row owns its own routes, runtime and active release:
```bash
openship deploy --project proj_preview --env preview --watch
```
`--env` selects stored variables within that project. It does not create a preview runtime or switch
project IDs. Preview variables are refused on a production target before deployment starts.
The explicit `--env` option overrides the default saved by `init --environment`. When using a directory
link, its saved default is used next; otherwise the fallback is `production`. An explicit `--project`
does not inherit a different project's linked branch or variable set.
## Deploy a folder
Upload the current directory explicitly, including from a Git checkout:
```bash
openship deploy --folder --name my-site --watch
```
The CLI stages the directory through the shared SDK source workflow. Outside Git, `--name` also
opts into a folder upload for existing scripts. A project ID alone never opts into uploading the
current directory. Use `--project <id>` to redeploy from outside the checkout; the stored branch is
used unless `--branch` is supplied.
`--branch`, `--commit`, `--smart-route`, and `--refresh` select the Git path and cannot be combined
with `--folder`. `--service-ids` works for both paths. Archive staging must remain outside the source
tree: the system temporary directory and its ancestors are refused. Select your project directory,
or set `TMPDIR` outside the source tree.
Native directory deployment requires the directory to be inside `policy.sourceRoots`. See
[folder deployment](https://openship.io/docs/guides/deploy-local-folder) for packaging behavior.
## Select what changes
| Option | Behavior |
| --- | --- |
| `--force-all` | Rebuild all enabled services. |
| `--service-ids svc_a,svc_b` | Select services to deploy. |
| `--smart-route` | Use source changes to select affected services. |
| `--refresh` | Reapply environment configuration without pulling source or rebuilding. |
See the [deploy reference](https://openship.io/docs/cli/reference/deploy) for every option.
## Inspect progress
```bash
openship deployment list --project proj_123
openship deployment get dep_123
openship logs dep_123 --follow
openship deployment wait dep_123 --timeout 600000
```
Without `--watch`, deployment submission returns an ID that you can inspect later. A submitted build
is not yet a successful release. Follow the final status and any requested decisions.
Watching or waiting returns a failed exit status for failed releases and pending decisions. Inspect a
decision with `deployment pending`, then use `deployment respond --action <offered-action>` and wait
again. The CLI never chooses a decision for you. `--watch`, `logs --follow` and `deployment wait` have a
ten-minute default deadline, adjustable with `--timeout` in milliseconds. A timeout stops observation;
it does not cancel the deployment.
`project server-logs <id> --follow` follows request logs using the SDK's authorized self-hosted or
Cloud stream. Unavailable streaming exits nonzero; omit `--follow` to request a recent snapshot.
## Control a release
```bash
openship deployment cancel dep_123
openship deployment redeploy dep_123 --use-existing-commit
openship deployment rollback dep_previous
```
Rollback availability depends on retained artifacts or rebuild support. `pin` retains a deployment's
rollback artifacts; `keep` and `reject` settle releases waiting for a decision.
Use the [deployment command reference](https://openship.io/docs/cli/reference/deployment) for controls and
[rollback guide](https://openship.io/docs/guides/rollback-redeploy) for recovery behavior.
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: 319k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 319k | 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: 196k | Updated | Claude CodeCodex | Verified | Install |