fcakyon/claude-codex-settings / plugins/openship-skills/skills/openship-config
openship-config
VerifiedThis 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.
| File | Kind | Size |
|---|---|---|
| LICENSE | other | 11.1 KB |
| SKILL.md | skill md | 3.1 KB |
| references/compose-multi-service.mdx | markdown | 21.5 KB |
| references/environment-variables.mdx | markdown | 18.0 KB |
| references/fields.md | markdown | 7.9 KB |
| references/openship-json.mdx | markdown | 3.6 KB |
| references/openship.schema.json | config | 16.2 KB |
| references/upstream.json | config | 4.0 KB |
references/openship.schema.json
View on GitHub{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://openship.io/openship.schema.json",
"title": "Openship deploy config",
"description": "openship.json — declarative deploy config for Openship. Auto-detection runs first; every field present here overrides it. Absent fields keep the detected value.",
"type": "object",
"additionalProperties": false,
"properties": {
"$schema": { "type": "string" },
"autoDeployPaths": {
"type": "object",
"description": "Push-only repo-relative path overrides. include replaces automatic workspace selection; exclude removes matching changes. Root build configuration and forced deploys always run.",
"additionalProperties": false,
"properties": {
"include": {
"type": "array",
"maxItems": 50,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Repo-relative paths supporting * and **."
},
"exclude": {
"type": "array",
"maxItems": 50,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"description": "Repo-relative paths supporting * and **."
}
}
},
"framework": {
"description": "Stack/framework slug. Overrides auto-detection.",
"enum": [
"nextjs",
"farmjs",
"nuxt",
"sveltekit",
"remix",
"astro",
"vite",
"angular",
"gatsby",
"cra",
"vue",
"react",
"express",
"fastify",
"hono",
"nestjs",
"koa",
"adonis",
"elysia",
"go",
"gin",
"fiber",
"echo",
"rust",
"actix",
"axum",
"rocket",
"python",
"django",
"flask",
"fastapi",
"rails",
"sinatra",
"laravel",
"symfony",
"springboot",
"quarkus",
"kotlin",
"dotnet",
"blazor",
"phoenix",
"node",
"static",
"docker",
"docker-compose",
"unknown",
"webmail"
]
},
"packageManager": {
"description": "Package manager used for install/build.",
"enum": [
"npm",
"yarn",
"pnpm",
"bun",
"go",
"cargo",
"pip",
"poetry",
"pipenv",
"uv",
"bundler",
"composer",
"maven",
"gradle",
"dotnet",
"mix"
]
},
"rootDirectory": {
"description": "Directory the app lives in, relative to the repo root (e.g. \"./\", \"apps/web\").",
"type": "string"
},
"composePath": {
"description": "Compose file kept outside the detected root — either the file itself (\"deploy/stack.yml\", which also covers non-standard filenames) or the directory holding it (\"deploy/docker-compose\"). Makes the project a compose deploy; service \"build\" contexts resolve relative to that directory, as compose does.",
"type": "string"
},
"installCommand": { "description": "Command that installs dependencies.", "type": "string" },
"buildCommand": { "description": "Command that builds the app.", "type": "string" },
"startCommand": {
"description": "Command that starts the server in production.",
"type": "string"
},
"releaseCommands": {
"description": "Commands run ONCE per deploy, after the build and before the new version goes live, typically database migrations. A non-zero exit fails the deploy and the previous version keeps serving. On Docker they run in a throwaway container, so only effects outside it persist: the database, or a mounted volume. Warm caches in the start command instead. Laravel: [\"php artisan migrate --force\"]. Rails: [\"bundle exec rails db:prepare\"]. Single-app projects only for now. Omit for no release phase (the default).",
"type": "array",
"items": { "type": "string" }
},
"outputDirectory": {
"description": "Directory the build writes to (e.g. \".next\", \"dist\").",
"type": "string"
},
"buildImage": {
"description": "Docker image used for the build (e.g. \"node:22\").",
"type": "string"
},
"runtimeVersion": {
"type": "string",
"pattern": "^[0-9]+(?:\\.[0-9]+){0,2}(?![\\s\\S])",
"maxLength": 32,
"description": "Runtime version. Supported versions and matching images depend on the selected stack; omission preserves detected defaults."
},
"runtimeImage": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Optional production base image for generated Docker builds. It must satisfy the selected runtime and recipe; omit for the managed default."
},
"productionPaths": {
"description": "Paths shipped to the runtime as the production artifact.",
"type": "array",
"items": { "type": "string" }
},
"volumes": {
"description": "Paths kept across deploys. A bare path is relative to the app (\"storage\"); a full mount also works (\"uploads:/app/storage\", \"/srv/data:/app/storage\"). Omit to inherit the framework's defaults; [] turns persistence off.",
"type": "array",
"items": { "type": "string" }
},
"runtime": {
"description": "Runtime isolation for a single app. Services/docker projects are always \"docker\".",
"enum": ["bare", "docker"]
},
"productionMode": {
"description": "How the app is served. \"static\" ⇒ no server (files only).",
"enum": ["host", "static", "standalone"]
},
"port": {
"description": "Port the server listens on.",
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"optimize": {
"description": "Laravel only. Opt-in cache warming for the web role (default false). true prefixes the web command with \"php artisan optimize && \" to warm Laravel's config/route/event/view caches. Web role only; an absent or false flag keeps the web command byte-identical. Warms per-request throughput, not cold start. Runs at startup only — config:cache freezes the env present when it runs, so never place it in buildCommand or releaseCommands.",
"type": "boolean"
},
"env": {
"description": "Environment variables. A string is a plain value; { \"value\", \"secret\" } marks a secret.",
"type": "object",
"additionalProperties": {
"oneOf": [
{ "type": "string" },
{
"type": "object",
"additionalProperties": false,
"required": ["value"],
"properties": {
"value": { "type": "string" },
"secret": { "type": "boolean" }
}
}
]
}
},
"domains": {
"description": "Public domains. A string is a hostname (a bare label = free subdomain; a dotted name = custom).",
"type": "array",
"items": {
"oneOf": [
{ "type": "string" },
{
"type": "object",
"additionalProperties": false,
"required": ["domain"],
"properties": {
"domain": { "type": "string" },
"port": { "type": "integer", "minimum": 1, "maximum": 65535 },
"targetPath": { "type": "string" },
"type": { "enum": ["free", "custom"] }
}
}
]
}
},
"routes": {
"description": "Reverse-proxy routing rules compiled to OpenResty at deploy.",
"type": "object",
"additionalProperties": false,
"properties": {
"rewrites": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["source", "destination"],
"properties": {
"source": { "type": "string" },
"destination": { "type": "string" }
}
}
},
"redirects": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["source", "destination"],
"properties": {
"source": { "type": "string" },
"destination": { "type": "string" },
"permanent": { "type": "boolean" },
"statusCode": { "type": "integer", "minimum": 300, "maximum": 399 }
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["source", "headers"],
"properties": {
"source": { "type": "string" },
"headers": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["key", "value"],
"properties": {
"key": { "type": "string" },
"value": { "type": "string" }
}
}
}
}
}
},
"cleanUrls": { "type": "boolean" },
"trailingSlash": { "type": "boolean" }
}
},
"resources": {
"description": "CPU/memory limits for this project's containers: a named tier OR explicit values (which becomes the custom tier). Self-hosted defaults to unlimited (the machine is the ceiling) and validates a non-zero value against the target machine's real capacity; cloud workspaces are metered and must be sized. 0 = no limit.",
"type": "object",
"additionalProperties": false,
"properties": {
"tier": { "enum": ["unlimited", "micro", "low", "medium", "high"] },
"cpuCores": { "type": "number", "minimum": 0, "maximum": 1024 },
"memoryMb": { "type": "integer", "minimum": 0, "maximum": 4194304 },
"diskMb": { "type": "integer", "minimum": 0, "maximum": 204800 }
}
},
"services": {
"description": "Compose services. Declaring services makes this a multi-service project.",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["name"],
"properties": {
"name": { "type": "string" },
"image": { "type": "string" },
"build": { "type": "string" },
"dockerfile": { "type": "string" },
"buildArgs": {
"description": "Per-service Docker build arguments. null inherits the same-named value from top-level env; string values override it. Do not put secrets directly in buildArgs.",
"type": "object",
"propertyNames": { "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" },
"additionalProperties": { "type": ["string", "null"] }
},
"ports": { "type": "array", "items": { "type": "string" } },
"volumes": { "type": "array", "items": { "type": "string" } },
"dependsOn": { "type": "array", "items": { "type": "string" } },
"env": {
"type": "object",
"additionalProperties": {
"oneOf": [
{ "type": "string" },
{
"type": "object",
"additionalProperties": false,
"required": ["value"],
"properties": {
"value": { "type": "string" },
"secret": { "type": "boolean" }
}
}
]
}
},
"command": { "type": "string" },
"restart": { "enum": ["no", "always", "on-failure", "unless-stopped"] },
"exposed": { "type": "boolean" },
"exposedPort": { "type": "string" },
"domain": { "type": "string" },
"healthcheck": {
"type": "object",
"additionalProperties": false,
"properties": {
"test": {
"oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }]
},
"interval": { "type": "string" },
"timeout": { "type": "string" },
"retries": { "type": "integer", "minimum": 0, "maximum": 100 },
"startPeriod": { "type": "string" },
"disable": { "type": "boolean" }
}
},
"resources": {
"description": "Per-service cpu/memory caps, overriding the top-level resources field by field. Parity with compose mem_limit / deploy.resources.limits, which Openship also reads off the compose file. 0 = no limit. swapDisabled runs the container without swap and requires a positive memory limit (own or inherited).",
"type": "object",
"additionalProperties": false,
"properties": {
"tier": { "enum": ["unlimited", "micro", "low", "medium", "high"] },
"cpuCores": { "type": "number", "minimum": 0, "maximum": 1024 },
"memoryMb": { "type": "integer", "minimum": 0, "maximum": 4194304 },
"diskMb": { "type": "integer", "minimum": 0, "maximum": 204800 },
"swapDisabled": { "type": "boolean" }
}
}
}
}
},
"monorepo": {
"description": "Monorepo workspace + per-sub-app build overrides (matched to detected apps by rootDirectory).",
"type": "object",
"additionalProperties": false,
"properties": {
"workspace": {
"type": "object",
"additionalProperties": false,
"required": ["packageManager"],
"properties": {
"packageManager": { "type": "string" },
"prepareCommand": { "type": "string" }
}
},
"apps": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": ["name", "rootDirectory"],
"properties": {
"name": { "type": "string" },
"rootDirectory": { "type": "string" },
"framework": {
"enum": [
"nextjs",
"farmjs",
"nuxt",
"sveltekit",
"remix",
"astro",
"vite",
"angular",
"gatsby",
"cra",
"vue",
"react",
"express",
"fastify",
"hono",
"nestjs",
"koa",
"adonis",
"elysia",
"go",
"gin",
"fiber",
"echo",
"rust",
"actix",
"axum",
"rocket",
"python",
"django",
"flask",
"fastapi",
"rails",
"sinatra",
"laravel",
"symfony",
"springboot",
"quarkus",
"kotlin",
"dotnet",
"blazor",
"phoenix",
"node",
"static",
"docker",
"docker-compose",
"unknown",
"webmail"
]
},
"packageManager": {
"enum": [
"npm",
"yarn",
"pnpm",
"bun",
"go",
"cargo",
"pip",
"poetry",
"pipenv",
"uv",
"bundler",
"composer",
"maven",
"gradle",
"dotnet",
"mix"
]
},
"installCommand": { "type": "string" },
"buildCommand": { "type": "string" },
"startCommand": { "type": "string" },
"outputDirectory": { "type": "string" },
"buildImage": { "type": "string" },
"port": { "type": "integer", "minimum": 1, "maximum": 65535 }
}
}
}
}
}
}
}
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deployment | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |