手引/Guides

Registry Workflow

How to create and publish a community registry so your skills are discoverable via kenji search.

1. Create a public GitHub repository

Create a public GitHub repository for your registry.

Recommended naming: user/kenji-registry

The repo name does not affect how Kenji indexes it. Any public repo name works. What matters is the directory structure inside the repo.

2. Add metadata files

Create JSON files following the registry structure:

skills/user/react-review.json
stacks/user/frontend-stack.json

Note

Registry repositories contain only metadata JSON files — not the actual skill Markdown files. The repo field in each JSON points to where the content lives.

3. Example skill JSON

{
  "name": "react-review",
  "description": "Review React components for structure and maintainability",
  "repo": "user/react-review-skill",
  "tags": ["react", "review"],
  "entry": "SKILL.md"
}

4. Submit the registry

$ kenji registry add user/kenji-registry

Kenji validates the structure and adds it to the network. Once accepted, your skills appear in search results immediately.

5. Keeping your registry up to date

After submitting your registry, you can update it freely — edit descriptions, rename files, change tags, or add new skills. Kenji will pick up changes automatically.

First add: When you run kenji registry add, the cache is immediately busted and rebuilt. Your skills appear in search results right away — no waiting.

Subsequent edits: Changes to your registry files on GitHub (edits, renames, new entries) are reflected within 30 minutes. This is the cache refresh window — no action is required on your part.

Note

If you rename a skill folder or file, the old namespace/name slug will return a 404 until the cache refreshes. The new slug becomes available at the same time.

6. Verify

$ kenji search react-review

$ kenji install user/react-review