Skip to main content
skill CX Codex

openship-deploy — Claude Code skill: what it does, how to install

openship-deploy — a skill for running and maintaining a self-hosted OpenShip instance from the CLI: app deploys, domains, backups, upgrades.

Apache-2.0 ★ 1,216 updated 2026-10-24

Install into Claude Code · Plugin marketplace All methods and platforms ↓
/plugin marketplace add fcakyon/claude-codex-settings
/plugin install openship-skills@claude-settings
Open on GitHub

What openship-deploy does

The skill kicks in when someone asks to deploy with OpenShip, operate a self-hosted instance, or debug a failed deployment. It works through the CLI, starting with openship --version and openship context list so the agent picks the right context instead of assuming it already points at the user's server. From there it writes an openship.json config with the companion openship-config skill, validates it with openship --json config validate, and runs the actual deploy from a repository or folder.

After deploying, it checks rollout status, service health, logs and the public URL, and has separate paths for domain setup, rollback to a prior version, and persistent storage for data that needs to survive a redeploy. Maintaining the instance itself (updates, backups, migrating the control plane) is handled through its own set of references.

In v0.8.0 the server ssh command is a stub even though it shows up in --help, so a working help output doesn't confirm an operation actually runs.

What it helps with

  • deploy an app from a repo through the OpenShip CLI
  • check status and logs after a deployment
  • set up domains and SSL for a service
  • roll back to a previous release or rebuild one from scratch
  • back up and restore data on a self-hosted instance

Example prompts for the agent

  • Deploy this repo with OpenShip and show me the public URL once it's live
  • Figure out why the last OpenShip deployment failed and pull the logs
  • Set up a custom domain for this service in OpenShip and confirm the certificate issued

How to install openship-deploy

1Plugin marketplace

/plugin marketplace add fcakyon/claude-codex-settings
/plugin install openship-skills@claude-settings

This installs the whole openship-skills plugin with all its skills

2Skills CLI (Vercel)

npx skills add fcakyon/claude-codex-settings --skill openship-deploy -a claude-code

3Manually: put the files in place

~/.claude/skills/openship-deploy/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/openship-deploy/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about openship-deploy

How do I install openship-deploy in Claude Code?

Run /plugin marketplace add fcakyon/claude-codex-settings, then /plugin install openship-skills@claude-settings.

What does openship-deploy do?

It drives app deployments through the OpenShip CLI and handles maintenance of a self-hosted instance: domains, storage, backups, and upgrades.

Does it require an existing OpenShip server?

It's built around an already-running self-hosted instance and an explicitly selected CLI context; cloud or desktop flows are only used when asked for directly.

Source text

SKILL.md · Apache-2.0
---
name: openship-deploy
description: This 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.
---

# Deploy and operate OpenShip

Prefer the CLI and an existing self-hosted instance. Use a cloud or desktop workflow when the user requests it. Keep application deployments separate from installing or upgrading the OpenShip control plane.

## Choose the instance and command

- Check `openship --version` and `openship context list`. Select the intended self-hosted context before a remote operation. Never assume the active context points to the user's server.
- Use native commands with the global `--json` flag. Read [CLI access](references/cli/access.mdx) for context and authentication details, and [automation](references/cli/automation.mdx) for CI logins and scripts that pass explicit project IDs. Do not print stored tokens.
- Check the installed command's `--help`. Use `openship api` for routes without a working command, after checking the matching implementation. In v0.8.0, `server ssh` is a stub despite appearing in help. A successful help command does not prove an operation works.
- [upstream.json](references/upstream.json) records the bundled release, exact source URLs, and hashes. If the installed CLI or server differs, verify the relevant source at that version before relying on a flag or API contract.

## Deploy an application

1. Inspect the repository, existing project link, build entry point, service topology, persistent volumes, and current domain ownership. Use [projects and services](references/cli/projects.mdx) for commands.
2. Use the companion `openship-config` skill to author a small `openship.json`. When only this ZIP is installed, use the [official config guide](https://openship.io/docs/guides/openship-json). Keep repeatable build and routing choices in the repository. Keep actual credentials in the instance's environment settings.
3. Run `openship --json config validate`, then use [deployment commands](references/cli/deploy.mdx) for the appropriate repository or folder deploy. A valid file does not prove its image builds or that the destination has sufficient capacity.
4. Check deployment completion, the active deployment, service health, logs, and the public URL. Report the deployed revision and any checks still pending. Use [edge and monitoring](references/cli/edge.mdx) and [logs](references/guides/logs-monitoring.mdx) for diagnosis, and [build failures](references/troubleshooting/deployments.mdx) when the deploy goes red.

Read only the guide needed for the operation:

- [Self-hosted GitHub App](references/guides/self-hosted-github-app.mdx): repository authorization and automatic deployment.
- [Domains](references/guides/custom-domains.mdx): ownership, DNS, ports, and HTTPS. Reconcile existing ownership before moving a hostname. [Domain and SSL failures](references/troubleshooting/domains-ssl.mdx) covers certificates that do not issue.
- [Rollback and redeploy](references/guides/rollback-redeploy.mdx): return to a previous version or rebuild one from scratch.
- [Persistent storage](references/guides/persistent-storage.mdx): volumes and data that must survive redeployment.

## Maintain the self-hosted instance

Use [self-host infrastructure](references/cli/self-host.mdx) for servers and backups, and [running OpenShip](references/cli/run.mdx) for lifecycle commands. Inspect how the instance was installed and whether it has a custom updater before selecting an upgrade command.

- [Updates](references/guides/updating.mdx): CLI and server lifecycle.
- [Backups and restore](references/guides/backups-restore.mdx): protection and recovery of application data.
- [Instance migration](references/guides/migrate-control-plane.mdx): control-plane export and import.

Use the user's existing authorization for the requested operation. Preparing a deployment is not authorization to replace a running instance or restore over its data.

© fcakyon · Apache-2.0 · fcakyon/claude-codex-settings

Similar skills

All skills for DevOps and infrastructure →

From the same set113

The whole set →
seo-audit The seo-audit skill for Claude Code and Codex audits pages for search visibility and investigates ranking problems. It checks crawl and index signals, page elements, content, and the order of follow-up checks. CX Codex +1 ★ 1,216repo stars review-overleaf review-overleaf — a skill for Claude Code and Codex that pulls unresolved reviewer comments from an Overleaf project, locates each in your local LaTeX repository, and proposes edits. CX Codex +1 ★ 1,216repo stars setup setup — a skill for Claude Code and Codex that configures and refreshes Overleaf session tokens for overleaf-skills. Runs when requests return 401 unauthorized or expired sessions. CX Codex +1 ★ 1,216repo stars update-readme update-readme — a command for Claude Code and Codex rebuilds the plugin sections in README.md. It reads the plugin folders and marketplace data. CX Codex +1 ★ 1,216repo stars list-performance-function-references list-performance-function-references instructs the AI agent to keep object references stable in virtualized lists. It prevents full list re-renders by moving state derivation into child items. CX Codex +1 ★ 1,216repo stars server-hoist-static-io The server-hoist-static-io rule for Claude Code and Codex moves static asset I/O to module scope, loading files once instead of on every server-function request. CX Codex +1 ★ 1,216repo stars slides slides assembles PowerPoint decks with PptxGenJS, layout helpers, PNG rendering, and overflow detection for slide content. CX Codex +1 ★ 1,216repo stars ui-menus ui-menus — a rule for Claude Code and Codex that switches menu generation from custom JS components to native platform elements via zeego. Triggered when creating dropdowns or context menus. CX Codex +1 ★ 1,216repo stars

Project sponsors

Companies that keep this analytics open