SkillAgentSearch skills...

openship-config

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.

Install / Use

npx skills add fcakyon/claude-codex-settings --skill openship-config

Installs into whichever agent you are using.

About this skill
📄

SKILL.md

Installable skill definition

Quality Score

80/100

Category

Automation

Supported Platforms

Universal

Our assessment of openship-config

openship-config scores 80/100 on our quality scale, 2428th of 2,758 Automation skills we index.

Its SKILL.md is 3.1 KB long, split into 4 sections with 1 code example: a solid amount of guidance for an agent.

With 1,153 GitHub stars, it is one of the more widely adopted skills in the catalogue.

Substance
26/30
Structure
12/20
Description
15/15
Adoption
13/20
Freshness
15/15

Maintenance, license and trust

  • The repository was last updated about 2 months ago, so openship-config is actively maintained.
  • It is released under the Apache-2.0 license, a permissive license that allows use, modification and commercial use with attribution.
  • Its trust signals score 100/100, with no cautions. These come from repository metadata, not a code audit — read the skill file before letting an agent act on it.

Safety scan

No issues found

Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands.

Automated pattern scan on 2026-11-22. It catches known dangerous patterns, not every risk — read a skill before letting an agent act on it.

openship-config compared with similar skills

All 4 of these similar skills score higher than openship-config; compare them before choosing.

SkillScoreStarsUpdatedFormat
openship-config (this skill)by fcakyon801.2k59d agoSKILL.md
taste-skillby Leonxlnx100120.0ktodayCLAUDE.md
Agent-Reachby Panniantong100114.0ktodayCLAUDE.md
rufloby ruvnet10082.3ktodayCLAUDE.md
Claude-Code-Game-Studiosby Donchitos10040.6k12d agoCLAUDE.md

Frequently asked questions

How do I install openship-config?
Run npx skills add fcakyon/claude-codex-settings --skill openship-config. The install tabs above show the steps for each supported agent.
Which AI agents does openship-config work with?
It is written for Universal, as a SKILL.md file. Other agents that read the same format can often use it too.
Is openship-config safe to use?
Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. It is Apache-2.0-licensed and scores 100/100 on trust signals. Skills are instructions an agent will follow, so read the file before installing it and do not approve commands you do not understand.
Is openship-config still maintained?
The repository was last updated about 2 months ago, so openship-config is actively maintained.

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 for names and meanings and the bundled JSON schema for editor validation. Use compose guidance 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:

{
  "$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 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 derive from the official upstream config skill. 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 for additional examples. Do not copy example credentials into a repository.

Related Skills

View on GitHub
GitHub Stars1.2k
CategoryAutomation
Updated1mo ago
Forks110

Languages

Python

Trust signals

100/100

From repository metadata: license, adoption, age and documentation. Not a code audit — see the Safety scan above for what the skill file itself contains.

No cautions
openship-config — Universal Skill: Install & Safety Check | SkillAgent