Openship Config

What it does

When your agent uses it

• Asks to create openship.json
• Configure an OpenShip deployment
• Make a repo deployable on OpenShip
• Fix openship config validate errors

Example prompts

• “create openship.json”
• “configure an OpenShip deployment”
• “make a repo deployable on OpenShip”
• “/openship-config”

Requirements

• Docker

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

1. 1Inspect package scripts, lockfiles, framework settings, Dockerfiles, compose files, workspace layout, and an existing openship.json.
2. 2Choose a single app, compose services, or detected monorepo apps. Do not combine those shapes casually. monorepo.apps overrides detected…
3. 3Read fields for names and meanings and the bundled JSON schema for editor validation. Use compose guidance for service topology, ports…
4. 4Start with openship config init only when the file is absent. Preserve an existing config and add only values that need to override…
5. 5Run openship --json config validate using the deployment's CLI version. Fix errors and review warnings: unknown keys can be ignored by the…

What it can do on your machine

Read from SKILL.md and the folder at commit 7a519d8. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  No scripts in the folder and no shell commands in SKILL.md (its code samples are json).

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  Hosts in commands or code, which the agent is likely to contact:

  • openship.io

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Openship Config loads about 803 tokens when it runs, and up to ~17k if it reads all its reference files. Until then it costs about 51 tokens; SKILL.md has 361 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~51

When it runs · the whole SKILL.md, loaded when a task matches

~803

With references · SKILL.md plus every file in references/, read only if the agent opens them

~17k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from fcakyon/claude-codex-settings at commit 7a519d8, republished under its Apache-2.0 licence (© fcakyon). 361 words, ~803 tokens.

name

openship-config

description

This skill should be used when the user asks to "create openship.json", "configure an OpenShip deployment", "make a repo deployable on OpenShip", or fix "openship config validate" errors.

{
  "$schema": "https://openship.io/openship.schema.json",
  "port": 3000,
  "runtime": "docker",
  "domains": ["app.example.com"]
}

© fcakyon, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 7 other files (references) in plugins/openship-skills/skills/openship-config of fcakyon/claude-codex-settings.

• SKILL.md
• LICENSE
• references/compose-multi-service.mdx
• references/environment-variables.mdx
• references/fields.md
• references/openship-json.mdx
• references/openship.schema.json
• references/upstream.json

Open the folder on GitHubat commit 7a519d8