openship-config — скилл для Claude Code: проектирует openship.json
Скилл openship-config, который готовит репозиторий к деплою на OpenShip: осматривает проект и создаёт openship.json с минимально необходимыми настройками. Пригодится перед первым запуском конфигурации или когда валидатор ругается.
Apache-2.0 ★ 1 216 обновлён 2026-10-24
/plugin marketplace add fcakyon/claude-codex-settings
/plugin install openship-skills@claude-settingsЧто делает openship-config
Скилл работает по официальному рабочему процессу OpenShip: сначала осматривает репозиторий, затем объявляет только нужные переопределения, а остальное оставляет автоопределению. Смотрит на скрипты в package.json, lock-файлы, настройки фреймворка, Dockerfile, compose-файлы и существующий openship.json, если он уже есть.
Файл начинают с openship config init только когда его нет. Если конфиг уже существует, скилл сохраняет его и добавляет лишь то, что нужно переопределить. Поле $schema остаётся привязанным к https://openship.io/openship.schema.json. После правок запускается openship --json config validate той версией CLI, которая установлена. Ошибки чинятся, предупреждения просматриваются: редактор может ругаться на ключи, которые рантайм спокойно игнорирует.
openship.json описывает желаемую конфигурацию, но не доказывает, что домен переехал или деплой прошёл. Для запуска и живой проверки есть отдельный скилл openship-deploy. Секреты в коммите не хранятся: флаг secret: true управляет хранением после загрузки, а не шифрует значение в Git-файле. Примеры учётных данных из документации в репозиторий копировать нельзя.
Какие задачи решает
- создать
openship.jsonпод структуру конкретного репозитория - разобраться, какие поля можно оставить автоопределению
- исправить ошибки
openship config validate - настроить compose-сервисы, порты, зависимости и постоянные тома
- понять, где хранятся секреты и что делает
secret: true
Примеры запросов агенту
- Создай
openship.jsonдля этого репозитория - Проверь, что конфиг OpenShip валиден, и исправь ошибки
- Объясни, почему валидатор ругается на
openship config validate
Как установить openship-config
1Через маркетплейс плагинов
/plugin marketplace add fcakyon/claude-codex-settings/plugin install openship-skills@claude-settingsКоманда ставит плагин openship-skills целиком, со всеми его скиллами
2Через Skills CLI (Vercel)
npx skills add fcakyon/claude-codex-settings --skill openship-config -a claude-code3Вручную: положить файлы
~/.claude/skills/openship-config/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/openship-config/
1Через Skills CLI (Vercel)
npx skills add fcakyon/claude-codex-settings --skill openship-config -a codex2Вручную: положить файлы
.agents/skills/openship-config/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add fcakyon/claude-codex-settings --skill openship-config -a cursor2Вручную: положить файлы
.cursor/skills/openship-config/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install fcakyon/claude-codex-settings plugins/openship-skills/skills/openship-config2Вручную: положить файлы
.github/skills/openship-config/SKILL.md1Через Skills CLI (Vercel)
npx skills add fcakyon/claude-codex-settings --skill openship-config -a gemini-cli2Командой платформы
gemini skills install https://github.com/fcakyon/claude-codex-settings --path plugins/openship-skills/skills/openship-configВручную: положить файлы
.devin/skills/openship-config/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Claude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы об openship-config
Как установить openship-config в Claude Code?
Через маркетплейс: сначала /plugin marketplace add fcakyon/claude-codex-settings, затем /plugin install openship-skills@claude-settings. Либо одной командой npx skills add fcakyon/claude-codex-settings --skill openship-config -a claude-code — файл попадёт в ~/.claude/skills/openship-config/SKILL.md.
Что делает скилл openship-config?
Осматривает репозиторий и проектирует openship.json: выбирает приложение или compose-сервисы, добавляет только переопределения поверх автоопределения и прогоняет openship --json config validate. Существующий конфиг он не переписывает с нуля.
Чем openship-config отличается от openship-deploy?
Этот скилл только проектирует и валидирует конфигурацию. Запуск деплоя и проверка, что домен реально переехал, — задача скилла openship-deploy. Один готовит файл, другой применяет его.
Исходный текст
SKILL.md · Apache-2.0
---
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.
---
# Design openship.json
Use OpenShip's upstream configuration workflow: inspect the repo, declare only necessary overrides, then validate. Auto-detection supplies omitted fields. Prefer self-hosted deployment unless the user selects cloud.
## Design the configuration
1. Inspect package scripts, lockfiles, framework settings, Dockerfiles, compose files, workspace layout, and an existing `openship.json`.
2. Choose a single app, compose services, or detected monorepo apps. Do not combine those shapes casually. `monorepo.apps` overrides detected apps by root directory. It does not discover new applications.
3. Read [fields](references/fields.md) for names and meanings and the bundled [JSON schema](references/openship.schema.json) for editor validation. Use [compose guidance](references/compose-multi-service.mdx) for service topology, ports, dependencies, and persistent volumes.
4. Start with `openship config init` only when the file is absent. Preserve an existing config and add only values that need to override detection. Keep its `$schema` set to `https://openship.io/openship.schema.json`.
5. Run `openship --json config validate` using the deployment's CLI version. Fix errors and review warnings: unknown keys can be ignored by the runtime even though the editor schema rejects them.
A minimal server config can be:
```json
{
"$schema": "https://openship.io/openship.schema.json",
"port": 3000,
"runtime": "docker",
"domains": ["app.example.com"]
}
```
## Self-hosted details
- Self-hosted defaults to unlimited resources in the bundled release. Declare caps only when intended. Service-level caps override project caps field by field. Check target capacity separately from local config validation.
- Use named persistent volumes for state that must survive an application deploy. Expose only the services intended to receive public traffic.
- Keep actual secret values out of committed JSON. `secret: true` controls storage handling after ingestion. It does not encrypt a credential in a Git file. Read [environment variables](references/environment-variables.mdx) for instance-managed values.
- `openship.json` expresses desired configuration. It does not prove an existing domain has moved or the running deployment has changed. The companion `openship-deploy` skill handles deployment and live verification.
## Source and version
The workflow and [field reference](references/fields.md) derive from the official upstream config skill. [upstream.json](references/upstream.json) records the release and links to its CLI validator, runtime parser, types, parser tests, and deployment preparation code. Consult those sources when docs disagree or a behavior depends on the installed version. The parser and actual deployment implementation decide runtime behavior. The JSON schema serves editor validation.
Read the [configuration guide](references/openship-json.mdx) for additional examples. Do not copy example credentials into a repository.
© fcakyon · Apache-2.0 · fcakyon/claude-codex-settings