Files
omniclaw-skills/README.md
2026-04-24 01:12:20 -07:00

95 lines
1.9 KiB
Markdown

# OmniClaw Skills Registry
OmniClaw Skills Registry is the source repository for reusable AI-agent skills and API operation guides published by OmniClaw.
It is designed for three consumers:
- Humans browsing API documentation and skill usage guides.
- Codex or other AI agents installing skills into their local skill directory.
- The OmniClaw release website rendering a searchable public catalog from `registry/manifest.json`.
## Repository Layout
```text
skills/
<skill-name>/
SKILL.md
agents/openai.yaml
references/
scripts/
skill.registry.json
apis/
<product>/
<api>.zh.md
<api>.en.md
registry/
manifest.schema.json
manifest.json
packages/
<skill-name>-<version>.tar.gz
tools/
build-registry.mjs
validate.mjs
install.sh
```
## Install A Skill
Default install target is `${CODEX_HOME:-$HOME/.codex}/skills`.
```bash
curl -fsSL https://git.omniclaw.store/zsb/omniclaw-skills/raw/branch/main/tools/install.sh \
| bash -s -- sub2api-gpt-image-2
```
Alternative with git clone:
```bash
git clone https://git.omniclaw.store/zsb/omniclaw-skills.git
cd omniclaw-skills
./tools/install.sh sub2api-gpt-image-2
```
Restart Codex after installing new skills.
## Current Skills
- `sub2api-gpt-image-2`: Generate, edit, stream, and troubleshoot GPT Image 2 calls through sub2api/OpenAI-compatible APIs.
## Development
Validate everything:
```bash
node tools/validate.mjs
```
Rebuild manifest and skill packages:
```bash
node tools/build-registry.mjs
```
The build script writes:
- `registry/manifest.json`
- `packages/<skill-name>-<version>.tar.gz`
Commit generated registry and packages so the release website and remote installers can consume stable artifacts directly.
## Publishing Contract
Every skill must include:
- `SKILL.md`
- `skill.registry.json`
- `agents/openai.yaml`
Every API guide should provide both:
- `*.zh.md`
- `*.en.md`
Do not commit real API keys, OAuth tokens, generated images, or private runtime logs.