launch-shadcn-registry
Skill25 starsChanged 52 days agoMITView on GitHub
Launch and promote a custom shadcn/ui registry. Validate registry.json, prepare or open directory pull requests, and draft posts for Reddit, X, Dev.to, and Hacker News. Use when the user wants to launch, list, submit, or announce a shadcn/ui registry, including requests about awesome-shadcn-ui, registry.directory, free-for-dev, awesome-ai-devtools (MCP), or a new @scope registry.
- Commits and pushes
3 other projects use a version of this, 3 of them edited.
Adopted by
Most recently taken up by
- Aniket-508/termcnedited, first seen Oct 9, 2026
- shadcn-labs/pdfcnedited, first seen Oct 8, 2026
- shadcn-labs/agentcnedited, first seen Jul 4, 2026
Other versions3 projects use a version of this.
Word for word · 0
None found.
Edited · 3
- shadcn-labs/pdfcn★ 3.2k48% same
- Aniket-508/termcn★ 1.2k48% same
- shadcn-labs/agentcn★ 50648% 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 repository9 other files it gives its agents.
- docs-i18n-zhSkill
- skill-creatorSkill
- unslopSkill
- writing-great-skillsSkill
- icon-set-auditSkill
- icon-set-extendSkill
- icon-set-generatorSkill
- mastra-file-agentsSkill
- tailwind-to-stylexSkill
The file
We split this skill into the rules it gives an agent
8 rules. 3 are common, 3 are distinctive, and 2 are very specific to this project.
3
Common
Most of the 3 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Common: line 62
Read references/preflight.md and run validation before generating any PRs.
- Very specific: line 103
Use feat(registry): add <scope> for official shadcn-ui/ui.
- Very specific: line 107
Use gh for GitHub operations.
- Distinctive: line 150
Read the platform references and produce ready-to-paste drafts.
- Common: line 165
After PRs are open or merged:
- Common: line 169
After the official merge, update social drafts to mention that the registry is now listed in the shadcn registry directory
- Distinctive: line 170
If a pull request is rejected, read the maintainer feedback and revise the description or registry format before resubmitting
- Distinctive: line 177
Use one registry profile for every submission.
“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
中文版: SKILL.zh-CN.md
Launch a shadcn registry
Prepare directory submissions for a custom shadcn/ui registry, then write posts that fit each platform.
Before you start
Confirm whether the user wants the full launch or only selected targets. Default to the full workflow unless they narrow the scope.
Collect or infer a registry profile. Ask for missing required fields before generating submissions. Use templates/registry-profile.example.json as the shape and validate it against templates/registry-profile.schema.json.
Required profile fields:
| Field | Purpose |
scope | Registry scope such as @ogimagecn |
name | Display name |
homepage | Public project or documentation URL |
registryBaseUrl | Base URL for JSON files with no trailing slash |
componentUrlPattern | URL pattern with a {name} placeholder, such as https://example.com/r/{name}.json |
description | One directory sentence of no more than 160 characters |
descriptionLong | Two or three sentences for awesome lists and social posts |
githubUrl | Source repo |
githubUsername | For avatar URLs and filenames |
distribution | open-source or premium |
categories | Tags for shadcntemplates and awesome lists |
installExample | Full install command such as npx shadcn@latest add @scope/component-name |
logo | Optional inline SVG string; recommended for the official directory |
registryIndexPath | Optional registry index path relative to registryBaseUrl; defaults to /registry.json |
sampleComponents | Optional component slugs to validate during preflight, such as ["og-image"] |
features | Optional points for shadcntemplates and social posts |
mcpUrl | Optional MCP endpoint on the registry domain, such as https://example.com/mcp; required for awesome-ai-devtools |
freeTier | Optional free-tier sentence with concrete limits; required for free-for-dev |
pricingUrl | Optional public pricing page URL; required for free-for-dev |
Workflow
Copy this checklist and track progress:
Launch Progress:
- [ ] Phase 1: Preflight validation
- [ ] Phase 2: Generate directory artifacts
- [ ] Phase 3: Open GitHub pull requests after user approval
- [ ] 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
Generate the requested submission files from the registry profile. Read only the references for those targets.
| 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 |
| free-for-dev | references/free-for-dev.md | README bullet, gated on a hosted SaaS free tier |
| awesome-ai-devtools | references/awesome-ai-devtools.md | README bullet, MCP server only with domain-derived mcpUrl |
Present artifacts grouped by repo. Include:
- Exact file path to create or edit
- Full content to add rather than a partial diff
- Suggested PR title and body
PR title convention
Use feat(registry): add <scope> for official shadcn-ui/ui. This matches PR #10896. Use docs: add <name> to <section> for awesome lists and feat: add <name> registry for registry.directory.
Phase 3: open GitHub pull requests
Use gh for GitHub operations. Ask before creating each pull request unless the user already asked to open all of them.
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
# append the entry to apps/v4/registry/directory.json
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
)"Open pull requests in this order unless the user chooses otherwise:
- Official
shadcn-ui/ui, the most visible listing and the one most likely to need maintainer review rbadillap/registry.directoryshadcnblocks/shadcntemplatesbirobirobiro/awesome-shadcn-uiandbytefer/awesome-shadcn-ui, which can run in paralleljamesmurdza/awesome-ai-devtools, only when the registry ships a verified MCP server on its own domainripienaar/free-for-dev, only when the registry domain offers a SaaS free tier; slowest review, submit last
Track pull request URLs in the launch checklist. Do not describe the registry as published until it is live and at least one directory submission is open or merged.
Phase 4: draft social posts
Read the platform references and produce ready-to-paste drafts. The user posts them 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.
Draft social posts after preflight passes. Suggest publishing them after the official directory pull request merges. At minimum, wait until registry.json is live.
Phase 5: follow up
After PRs are open or merged:
- Share the repository, pull request URL, and status for every submission
- Remind the user to respond to review comments within 48 hours
- After the official merge, update social drafts to mention that the registry is now listed in the shadcn registry directory
- If a pull request is rejected, read the maintainer feedback and revise the description or registry format before resubmitting
Rules
Guardrails not already implied by the phases above:
- Append the official
directory.jsonentry to the end of the array. - Use one registry profile for every submission. Do not invent conflicting descriptions without user approval.
- For premium registries on shadcntemplates, explain that the first listing is free and additional listings cost $100. Do not promise approval.
- Skip
awesome-ai-devtoolswhen the registry has no MCP server, and skipfree-for-devwhen it has no SaaS free tier. Say why instead of drafting. - Derive awesome-ai-devtools links from the registry domain (
profile.mcpUrl, default{homepage}/mcp) and verify the endpoint before drafting.
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.

