|
| 1 | +# Sealos Skills |
| 2 | + |
| 3 | +Deploy projects to [Sealos Cloud](https://sealos.io) from your AI agent. |
| 4 | + |
| 5 | +Sealos Skills is a plugin-first skill pack centered on Sealos Cloud development and deployment. It helps an AI agent inspect a project, prepare missing deployment artifacts, connect Sealos Cloud databases for development, build or reuse a container image, ship the app to Sealos Cloud, and view deployed resources in a local read-only canvas. |
| 6 | + |
| 7 | +The recommended way to use it is as an agent plugin installed with [`npx plugins`](https://www.npmjs.com/package/plugins). The same root `skills/` directory also remains compatible with `skills.sh` and context-only extension hosts such as Gemini CLI and Qwen Code. |
| 8 | + |
| 9 | +## Quick Start |
| 10 | + |
| 11 | +### Recommended: install as a plugin |
| 12 | + |
| 13 | +Install the Sealos plugin into Codex: |
| 14 | + |
| 15 | +```bash |
| 16 | +npx plugins add https://github.com/labring/sealos-skills --target codex |
| 17 | +``` |
| 18 | + |
| 19 | +Install the Sealos plugin into Claude Code: |
| 20 | + |
| 21 | +```bash |
| 22 | +npx plugins add https://github.com/labring/sealos-skills --target claude-code |
| 23 | +``` |
| 24 | + |
| 25 | +If you only use one detected agent tool on the machine, you can let `plugins` choose the target: |
| 26 | + |
| 27 | +```bash |
| 28 | +npx plugins add https://github.com/labring/sealos-skills |
| 29 | +``` |
| 30 | + |
| 31 | +After installation, use the plugin from your agent: |
| 32 | + |
| 33 | +- **Codex CLI:** type `$sealos` |
| 34 | +- **Codex App:** click the **+** button in the lower-left corner of the chat input, choose **Plugins**, then choose **Sealos** |
| 35 | +- **Claude Code:** type `/sealos` |
| 36 | + |
| 37 | + |
| 38 | + |
| 39 | +Plugin examples: |
| 40 | + |
| 41 | +```text |
| 42 | +$sealos deploy this repo to Sealos Cloud |
| 43 | +$sealos deploy /path/to/project |
| 44 | +$sealos deploy https://github.com/labring-sigs/kite |
| 45 | +$sealos create a cloud Postgres database for this repo and wire DATABASE_URL |
| 46 | +``` |
| 47 | + |
| 48 | +For Claude Code, use the same requests with `/sealos`: |
| 49 | + |
| 50 | +```text |
| 51 | +/sealos deploy this repo to Sealos Cloud |
| 52 | +/sealos deploy /path/to/project |
| 53 | +/sealos deploy https://github.com/labring-sigs/kite |
| 54 | +/sealos create a cloud Postgres database for this repo and wire DATABASE_URL |
| 55 | +``` |
| 56 | + |
| 57 | +In Codex App, select **Sealos** from **Plugins**, then describe what you want to deploy. |
| 58 | + |
| 59 | +### Other supported AI tools |
| 60 | + |
| 61 | +| Tool | Install | Usage | |
| 62 | +| --- | --- | --- | |
| 63 | +| Codex CLI / Codex App | `npx plugins add https://github.com/labring/sealos-skills --target codex` | `$sealos` in Codex CLI, or **+** → **Plugins** → **Sealos** in Codex App | |
| 64 | +| Claude Code | `npx plugins add https://github.com/labring/sealos-skills --target claude-code` | `/sealos` | |
| 65 | +| Claude Code marketplace flow | `/plugin marketplace add labring/sealos-skills` | `/sealos` | |
| 66 | +| OpenClaw / ClawHub | `clawhub install labring/sealos-skills` | Host command exposure depends on the ClawHub runtime | |
| 67 | +| CodeBuddy | `/plugin marketplace add labring/sealos-skills` | Host command exposure depends on the CodeBuddy runtime | |
| 68 | +| Gemini CLI | `gemini extensions install https://github.com/labring/sealos-skills` | Context-only extension; ask Gemini to use Sealos Skills | |
| 69 | +| Qwen Code | `qwen extensions install https://github.com/labring/sealos-skills` | Context-only extension; ask Qwen to use Sealos Skills | |
| 70 | +| Amp / Kimi / generic repo importers | Import `https://github.com/labring/sealos-skills.git` | Host-dependent | |
| 71 | + |
| 72 | +Gemini CLI and Qwen Code manifests provide repository context through `CLAUDE.md`; they do not claim slash-command support. |
| 73 | + |
| 74 | +### Alternative: install as a `skills.sh` skill pack |
| 75 | + |
| 76 | +If your agent uses `skills.sh` directly, install the same skills pack with: |
| 77 | + |
| 78 | +```bash |
| 79 | +npx skills add labring/sealos-skills |
| 80 | +``` |
| 81 | + |
| 82 | +Then run the deploy skill directly: |
| 83 | + |
| 84 | +```text |
| 85 | +/sealos-deploy |
| 86 | +/sealos-deploy /path/to/project |
| 87 | +/sealos-deploy https://github.com/labring-sigs/kite |
| 88 | +``` |
| 89 | + |
| 90 | +After a project has been deployed, run a local Sealos resource canvas UI: |
| 91 | + |
| 92 | +```text |
| 93 | +/sealos-canvas |
| 94 | +``` |
| 95 | + |
| 96 | +`/sealos-deploy` is the direct `skills.sh` skill entry. Plugin usage should go through `$sealos` in Codex or `/sealos` in Claude Code. |
| 97 | + |
| 98 | +## Why Use the Plugin |
| 99 | + |
| 100 | +Prefer the plugin install for Codex and Claude Code because it: |
| 101 | + |
| 102 | +- installs all Sealos skills as one managed package |
| 103 | +- exposes the same skills across supported agent tools |
| 104 | +- keeps the plugin metadata, logo, prompts, commands, and capabilities together |
| 105 | +- avoids maintaining a separate packaged copy of the skills |
| 106 | + |
| 107 | +## Plugin Distribution |
| 108 | + |
| 109 | +The Codex integration follows [OpenAI's Codex plugin build guide](https://developers.openai.com/codex/plugins/build): |
| 110 | + |
| 111 | +- `.codex-plugin/plugin.json` contains plugin identity, discovery metadata, interface copy, default prompts, brand metadata, and asset paths relative to the repository root. |
| 112 | +- `.agents/plugins/marketplace.json` registers this repo-local plugin for local Codex marketplace testing. |
| 113 | +- `distribution/platforms.json` records platform support claims and evidence. |
| 114 | +- `marketplaces/README.md` owns marketplace rules and prevents command-support overclaims. |
| 115 | +- `scripts/validate-codex-plugin.py` validates the Codex manifest, repo marketplace, platform registry, and asset paths. |
| 116 | +- `skills/**/SKILL.md` remains the only skill source; do not add a second packaged copy of the skills. |
| 117 | + |
| 118 | +Validate plugin metadata before publishing or pushing manifest changes: |
| 119 | + |
| 120 | +```bash |
| 121 | +python3 scripts/validate-codex-plugin.py |
| 122 | +python3 -m json.tool .codex-plugin/plugin.json >/dev/null |
| 123 | +python3 -m json.tool .agents/plugins/marketplace.json >/dev/null |
| 124 | +python3 -m json.tool distribution/platforms.json >/dev/null |
| 125 | +``` |
| 126 | + |
| 127 | +## How Setup Works |
| 128 | + |
| 129 | +You only need a plugin-compatible or `skills.sh` compatible AI agent and a project to deploy. |
| 130 | + |
| 131 | +During the deploy and database flows, Sealos Skills will: |
| 132 | + |
| 133 | +- check whether tools such as Docker and `kubectl` are available |
| 134 | +- guide the user through Sealos login when needed |
| 135 | +- use `sealos-cli` for Sealos Cloud database creation, connection details, and database operations |
| 136 | +- use or help prepare a container registry path such as Docker Hub or GHCR |
| 137 | + |
| 138 | +For an actual deployment, you will still need a Sealos Cloud account and access to a container registry, but these do not need to be fully set up before the skill starts. For database work, you need a Sealos Cloud account and a workspace that can create database resources. |
| 139 | + |
| 140 | +## What Sealos Deploy Handles |
| 141 | + |
| 142 | +On a typical deploy, the agent will: |
| 143 | + |
| 144 | +- assess the project structure and runtime needs |
| 145 | +- reuse an existing image or build one when needed |
| 146 | +- generate a Sealos template |
| 147 | +- deploy and verify rollout |
| 148 | + |
| 149 | +Later runs can switch to an in-place update flow when an existing deployment is detected. |
| 150 | + |
| 151 | +## What Sealos Database Handles |
| 152 | + |
| 153 | +For a local project or Devbox that needs a cloud database, the agent will: |
| 154 | + |
| 155 | +- detect database signals such as `DATABASE_URL`, Prisma, Drizzle, MongoDB, MySQL, or Redis |
| 156 | +- use `sealos-cli database` to list, create, inspect, and connect Sealos Cloud databases |
| 157 | +- write only the required local env key without exposing secrets in chat |
| 158 | +- verify the app's real database path through migrations, introspection, or startup checks |
| 159 | +- manage public access only after confirmation |
| 160 | + |
| 161 | +## What Sealos Canvas Handles |
| 162 | + |
| 163 | +For a repository already deployed by `/sealos-deploy`, the agent will: |
| 164 | + |
| 165 | +1. Read `.sealos/state.json` to locate the deployed app. |
| 166 | +2. Query the Sealos namespace with read-only `kubectl get` commands. |
| 167 | +3. Start a temporary `127.0.0.1` canvas UI. |
| 168 | +4. Output and open the local UI address for inspection. |
| 169 | + |
| 170 | +If the project has not been deployed yet, `/sealos-canvas` stops and tells the user to run `/sealos-deploy` first. |
| 171 | + |
| 172 | +## Included Skills |
| 173 | + |
| 174 | +The plugin and `skills.sh` pack expose the same skill source: |
| 175 | + |
| 176 | +- `sealos-deploy` — deploy a local or GitHub project to Sealos Cloud |
| 177 | +- `sealos-database` — create, connect, and operate Sealos Cloud databases for development |
| 178 | +- `sealos-canvas` — view deployed Sealos resources in a local read-only canvas UI |
| 179 | +- `sealos-app-builder` — build Sealos Desktop apps with SDK integration |
| 180 | +- `cloud-native-readiness` — assess deployment readiness |
| 181 | +- `dockerfile-skill` — generate production-ready Dockerfiles |
| 182 | +- `docker-to-sealos` — convert Docker Compose services into Sealos templates |
| 183 | + |
| 184 | +## Repository |
| 185 | + |
| 186 | +[`skills/`](./skills) is the single source of truth for Sealos deploy, Sealos canvas, and the supporting skills used during the deploy flow. The same root-level skills directory serves `skills.sh` installs and every plugin or extension manifest in this repository. |
| 187 | + |
| 188 | +Important distribution files: |
| 189 | + |
| 190 | +- [`.codex-plugin/plugin.json`](./.codex-plugin/plugin.json) — Codex plugin manifest |
| 191 | +- [`.agents/plugins/marketplace.json`](./.agents/plugins/marketplace.json) — local Codex marketplace entry |
| 192 | +- [`.claude-plugin/plugin.json`](./.claude-plugin/plugin.json) — Claude Code-compatible plugin manifest |
| 193 | +- [`marketplace.json`](./marketplace.json) and [`.claude-plugin/marketplace.json`](./.claude-plugin/marketplace.json) — Claude-compatible marketplace entries |
| 194 | +- [`.codebuddy-plugin/marketplace.json`](./.codebuddy-plugin/marketplace.json) — CodeBuddy marketplace entry |
| 195 | +- [`gemini-extension.json`](./gemini-extension.json) — Gemini CLI context extension |
| 196 | +- [`qwen-extension.json`](./qwen-extension.json) — Qwen Code context extension |
| 197 | +- [`openclaw.plugin.json`](./openclaw.plugin.json) — OpenClaw / ClawHub bundle pointer |
| 198 | +- [`commands/sealos.md`](./commands/sealos.md) — `/sealos` plugin command entry for compatible hosts |
| 199 | +- [`distribution/platforms.json`](./distribution/platforms.json) — platform support registry |
| 200 | +- [`marketplaces/README.md`](./marketplaces/README.md) — marketplace rules and support-claim ownership |
| 201 | +- [`scripts/validate-codex-plugin.py`](./scripts/validate-codex-plugin.py) — Codex plugin validation |
| 202 | + |
| 203 | +Do not add a second packaged copy of the skills. Root `skills/**` is the only skill source for all installation paths. |
| 204 | + |
| 205 | +## License |
| 206 | + |
| 207 | +MIT |
0 commit comments