launch-shadcn-registry
Skill1.2k starsChanged 4 months agoMITView on GitHub
Launch and promote a custom shadcn/ui registry end-to-end: validate registry.json, prepare the official shadcn-ui/ui directory PR, community directory PRs (registry.directory, shadcntemplates, birobirobiro/awesome-shadcn-ui, bytefer/awesome-shadcn-ui), and draft social posts for Reddit r/shadcn, X, Dev.to, and Hacker News. Use whenever the user says "launch my registry", "list on shadcn directory", "submit to awesome-shadcn-ui", "announce my shadcn registry", "registry.directory PR", or wants to promote a new @scope registry — even if they do not say "launch-shadcn-registry" explicitly.
- Commits and pushes
3 other projects use a version of this, 1 of them edited.
Adopted by
Most recently taken up by
- shadcn-labs/pdfcnword for word, first seen Oct 8, 2026
- shadcn-labs/skillsedited, first seen Sep 25, 2026
- shadcn-labs/agentcnword for word, first seen Jul 4, 2026
Other versions3 projects use a version of this.
Word for word · 2
- shadcn-labs/pdfcn★ 3.2k100% same
- shadcn-labs/agentcn★ 506100% same
Edited · 1
- shadcn-labs/skills★ 2544% same
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository7 other files it gives its agents.
- .agents/skills/vercel-react-view-transitions/AGENTS.mdAGENTS.md
- inkSkill
- opentuiSkill
- skill-creatorSkill
- vercel-react-view-transitionsSkill
- web-hapticsSkill
- writing-great-skillsSkill
The file
We split this skill into the rules it gives an agent
12 rules. About 0 are common, 9 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈9
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 60
Read references/preflight.md and run validation before generating any PRs.
- Very specific: line 99
Use feat(registry): add <scope> for official shadcn-ui/ui (matches PR #10896).
- Very specific: line 103
Use gh for all GitHub operations.
- Distinctive: line 144
Read platform references and produce ready-to-paste drafts (user posts manually):
- Distinctive: line 159
After PRs are open or merged:
- Distinctive: line 163
After official merge, suggest updating social drafts to mention "now listed in the shadcn registry directory"
- Distinctive: line 164
If a PR is rejected, read maintainer feedback and adjust description or registry format — do not resubmit unchanged
- Distinctive: line 168
Never submit to directories before preflight passes
- Distinctive: line 169
Never claim listings are live until PRs are merged
- Distinctive: line 170
Never auto-post to Reddit, X, Dev.to, or HN — drafts only
- Very specific: line 171
Keep official directory.json entry at the end of the array (append only)
- Distinctive: line 184
Ask: "Open PRs to all 5 repos?"
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Launch shadcn Registry
Orchestrate listing and announcing a custom shadcn/ui registry across official and community directories, then draft platform-specific social posts.
Before You Start
Confirm the user wants a full launch or a subset (e.g. official directory only, or social drafts only). Default to the full workflow unless they narrow scope.
Collect or infer a registry profile. If missing fields, ask before generating artifacts. Use templates/registry-profile.example.json as the shape; validate against templates/registry-profile.schema.json.
Required profile fields:
| Field | Purpose |
scope | Registry scope, e.g. @ogimagecn |
name | Display name |
homepage | Marketing/docs URL |
registryBaseUrl | Base URL for JSON files (no trailing slash) |
componentUrlPattern | URL pattern with {name} placeholder, e.g. https://example.com/r/{name}.json |
description | One sentence (≤160 chars) for directories |
descriptionLong | 2–3 sentences for awesome lists and social |
githubUrl | Source repo |
githubUsername | For avatar URLs and filenames |
distribution | open-source or premium |
categories | Tags for shadcntemplates / awesome lists |
installExample | e.g. npx shadcn@latest add @scope/component-name |
logo | Inline SVG string for official directory (optional but recommended) |
registryIndexPath | Path to registry index relative to registryBaseUrl, defaults to /registry.json (optional) |
sampleComponents | Array of component slugs to validate during preflight, e.g. ["og-image"] (optional) |
features | Bullet points for shadcntemplates and social posts (optional) |
Workflow Overview
Copy this checklist and track progress:
Launch Progress:
- [ ] Phase 1: Preflight validation
- [ ] Phase 2: Generate directory artifacts
- [ ] Phase 3: Open GitHub PRs (user approval per PR)
- [ ] Phase 4: Draft social posts
- [ ] Phase 5: Post-launch follow-upPhase 1: Preflight
Read references/preflight.md and run validation before generating any PRs.
bash scripts/validate-registry.sh <registryBaseUrl> [sample-component-name]Fix all blockers before continuing. Common failures:
registry.jsonnot public or wrong path- Component JSON 404
- Duplicate
@scopein official directory descriptiontoo long or marketing-heavy for official listing
Fetch the official directory to check duplicates:
curl -fsSL https://raw.githubusercontent.com/shadcn-ui/ui/main/apps/v4/registry/directory.json | grep -i "<scope>"Phase 2: Generate Artifacts
From the registry profile, generate all submission files. Read the relevant reference only for targets the user wants:
| Target | Reference | Output |
| Official shadcn-ui/ui | references/shadcn-ui-official.md | JSON entry + PR body |
| registry.directory | references/registry-directory.md | JSON entry + PR body |
| shadcntemplates | references/shadcntemplates.md | content/{author}-{name}.md |
| birobirobiro awesome | references/awesome-birobirobiro.md | README table row |
| bytefer awesome | references/awesome-bytefer.md | README table row |
Present artifacts grouped by repo. Include:
- Exact file path to create or edit
- Full content to add (not diffs alone)
- Suggested PR title and body
PR title convention
Use feat(registry): add <scope> for official shadcn-ui/ui (matches PR #10896). Use docs: add <name> to <section> for awesome lists and feat: add <name> registry for registry.directory.
Phase 3: Open GitHub PRs
Use gh for all GitHub operations. Ask the user before creating each PR unless they explicitly asked to open all PRs.
Standard fork-and-PR flow per repo:
# Example: official shadcn-ui/ui
gh repo fork shadcn-ui/ui --clone=false
git clone https://github.com/<user>/ui.git /tmp/ui-registry-pr
cd /tmp/ui-registry-pr
git remote add upstream https://github.com/shadcn-ui/ui.git
git fetch upstream && git checkout -b feat/<scope>-directory upstream/main
# edit apps/v4/registry/directory.json — append entry at end of array
git add apps/v4/registry/directory.json
git commit -m "feat(registry): add <scope>"
git push -u origin HEAD
gh pr create --repo shadcn-ui/ui --title "feat(registry): add <scope>" --body "$(cat <<'EOF'
## Summary
Adds <scope> to the community registry directory.
- **Registry URL**: `<componentUrlPattern>`
- **Homepage**: <homepage>
- **Description**: <description>
## Test plan
- [ ] `curl <registryBaseUrl>/registry.json` returns valid JSON
- [ ] `npx shadcn@latest add <installExample>` installs successfully
EOF
)"Recommended PR order:
- Official
shadcn-ui/ui(highest leverage; may take maintainer review) rbadillap/registry.directoryshadcnblocks/shadcntemplatesbirobirobiro/awesome-shadcn-uiandbytefer/awesome-shadcn-ui(can be parallel)
Track PR URLs in the launch checklist. Do not draft social posts as "published" until the registry is live and at least one directory listing is merged or submitted.
Phase 4: Social Drafts
Read platform references and produce ready-to-paste drafts (user posts manually):
| Platform | Reference |
| Reddit r/shadcn | references/social/reddit.md |
| X | references/social/x.md |
| Dev.to | references/social/devto.md |
| Hacker News | references/social/hackernews.md |
Tailor each draft from the registry profile. Include the install command, homepage, and GitHub link. Avoid hype; lead with the concrete problem the registry solves.
Timing: Draft social posts after preflight passes. Suggest posting after the official directory PR is merged (or at minimum after registry.json is live).
Phase 5: Post-Launch
After PRs are open or merged:
- Share PR links with the user in a summary table (repo, PR URL, status)
- Remind user to respond to review comments within 48h
- After official merge, suggest updating social drafts to mention "now listed in the shadcn registry directory"
- If a PR is rejected, read maintainer feedback and adjust description or registry format — do not resubmit unchanged
Rules
- Never submit to directories before preflight passes
- Never claim listings are live until PRs are merged
- Never auto-post to Reddit, X, Dev.to, or HN — drafts only
- Keep official
directory.jsonentry at the end of the array (append only) - One registry profile drives all artifacts — do not invent different descriptions per platform without user approval
- For premium registries on shadcntemplates, note the one-free / $100 multi-premium policy; do not promise approval
Example
User: "Launch @ogimagecn — https://ogimagecn.vercel.app"
Agent:
- Build profile from site +
curl https://ogimagecn.vercel.app/r/registry.json - Run
validate-registry.sh https://ogimagecn.vercel.app og-image - Generate JSON for official directory, registry.directory, shadcntemplates markdown, awesome list rows
- Ask: "Open PRs to all 5 repos?"
- On approval, create PRs via
gh - Deliver Reddit, X, Dev.to, and HN drafts
Additional Resources
- Registry profile schema: templates/registry-profile.schema.json
- Example profile: templates/registry-profile.example.json
- Validation script: scripts/validate-registry.sh
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

