openship-config
Installation
SKILL.md
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
- Inspect package scripts, lockfiles, framework settings, Dockerfiles, compose files, workspace layout, and an existing
openship.json. - Choose a single app, compose services, or detected monorepo apps. Do not combine those shapes casually.
monorepo.appsoverrides detected apps by root directory. It does not discover new applications. - Read fields for names and meanings and the bundled JSON schema for editor validation. Use compose guidance for service topology, ports, dependencies, and persistent volumes.
- Start with
openship config initonly when the file is absent. Preserve an existing config and add only values that need to override detection. Keep its$schemaset tohttps://openship.io/openship.schema.json. - Run
openship --json config validateusing 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: