|
| 1 | +# Command Code mods registry |
| 2 | + |
| 3 | +[`registry.json`](./registry.json) in this folder is the community registry behind the |
| 4 | +[mods hub](https://commandcode.ai/mods). The hub reads it live, so a merged PR here lists |
| 5 | +your mod within minutes — no website deploy. |
| 6 | + |
| 7 | +Two ways a mod gets listed: |
| 8 | + |
| 9 | +1. **Publish to npm with the `cmd-mod` keyword** — it is discovered automatically, no PR needed. |
| 10 | +2. **Open a PR against `registry.json`** — for git-only mods, or to add richer metadata. This is that path. |
| 11 | + |
| 12 | +## Add your mod |
| 13 | + |
| 14 | +Append one entry to the `mods` array in [`registry.json`](./registry.json). Editors validate it |
| 15 | +against [`registry.schema.json`](./registry.schema.json). |
| 16 | + |
| 17 | +```json |
| 18 | +{ |
| 19 | + "name": "cmd-mod-standup", |
| 20 | + "source": "owner/cmd-mod-standup", |
| 21 | + "description": "Adds a /standup command that summarizes what changed in git today.", |
| 22 | + "author": { "name": "Jane Dev", "github": "janedev" }, |
| 23 | + "repo": "https://github.com/owner/cmd-mod-standup", |
| 24 | + "npm": "cmd-mod-standup", |
| 25 | + "kinds": ["command"], |
| 26 | + "tags": ["git", "productivity"] |
| 27 | +} |
| 28 | +``` |
| 29 | + |
| 30 | +### Fields |
| 31 | + |
| 32 | +| Field | Required | Notes | |
| 33 | +|-------|:---:|-------| |
| 34 | +| `name` | yes | unique, lowercase `[a-z0-9._-]` — the hub's identity for the row | |
| 35 | +| `source` | yes | what `cmd mods add <source> -g` installs: an npm name, `owner/repo`, or a `git:` URL | |
| 36 | +| `description` | yes | 1–240 chars; the card summary | |
| 37 | +| `author` | yes | `{ "name": "…" }` required; optional `github` / `url` link the name | |
| 38 | +| `kinds` | yes | one or more of `tool` `command` `hook` `provider` `renderer` `flag` | |
| 39 | +| `repo` | no | a GitHub URL also enables the star count | |
| 40 | +| `npm` | no | links the entry to its npm package for live download counts | |
| 41 | +| `tags` | no | lowercase slugs, searchable | |
| 42 | +| `addedAt` | no | `YYYY-MM-DD`, used for the "Newest" sort | |
| 43 | + |
| 44 | +`official` and the top-level `hidden` list are maintainer-only — leave them out of your PR. |
| 45 | + |
| 46 | +Keep the array valid JSON (no trailing commas) and one mod per PR where you can, so review stays quick. |
0 commit comments