Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.22 KB

File metadata and controls

48 lines (33 loc) · 1.22 KB

Registry Source (GitHub)

This document captures how CLI registry commands resolve data from the GitHub repository:

Index source used by list and pull

Both commands read:

  • GET https://raw.githubusercontent.com/bergside/awesome-design-skills/main/skills/index.json

Expected shape:

{
  "paper": {
    "slug": "paper",
    "name": "Paper",
    "skillPath": "skills/paper/SKILL.md"
  }
}

The CLI maps each index entry to:

  • name -> display name
  • slug -> selection and pull key
  • previewUrl -> repository page (/tree/main/skills/<slug>)
  • hasSkillMd -> true when skillPath is non-empty

Pull behavior

For pull <slug>:

  1. Validate slug format locally.
  2. Read skills/index.json.
  3. Resolve index[slug].skillPath.
  4. Fetch markdown from raw GitHub URL:
    • GET https://raw.githubusercontent.com/bergside/awesome-design-skills/main/<skillPath>

On success, response is markdown text (text/markdown or plain text accepted).

Common failure reasons surfaced by CLI:

  • not_found (missing slug in index or missing markdown file)
  • invalid index JSON/shape
  • network/unreachable raw GitHub URLs