agentleFS
shadcn-labsshadcn-labs/skills/skills/launch-shadcn-registry/SKILL.md

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

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
  1. Common:

    Read references/preflight.md and run validation before generating any PRs.

    line 62
  2. Very specific:

    Use feat(registry): add <scope> for official shadcn-ui/ui.

    line 103
  3. Very specific:

    Use gh for GitHub operations.

    line 107
  4. Distinctive:

    Read the platform references and produce ready-to-paste drafts.

    line 150
  5. Common:

    After PRs are open or merged:

    line 165
  6. Common:

    After the official merge, update social drafts to mention that the registry is now listed in the shadcn registry directory

    line 169
  7. Distinctive:

    If a pull request is rejected, read the maintainer feedback and revise the description or registry format before resubmitting

    line 170
  8. Distinctive:

    Use one registry profile for every submission.

    line 177

“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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

中文版: 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:

FieldPurpose
scopeRegistry scope such as @ogimagecn
nameDisplay name
homepagePublic project or documentation URL
registryBaseUrlBase URL for JSON files with no trailing slash
componentUrlPatternURL pattern with a {name} placeholder, such as https://example.com/r/{name}.json
descriptionOne directory sentence of no more than 160 characters
descriptionLongTwo or three sentences for awesome lists and social posts
githubUrlSource repo
githubUsernameFor avatar URLs and filenames
distributionopen-source or premium
categoriesTags for shadcntemplates and awesome lists
installExampleFull install command such as npx shadcn@latest add @scope/component-name
logoOptional inline SVG string; recommended for the official directory
registryIndexPathOptional registry index path relative to registryBaseUrl; defaults to /registry.json
sampleComponentsOptional component slugs to validate during preflight, such as ["og-image"]
featuresOptional points for shadcntemplates and social posts
mcpUrlOptional MCP endpoint on the registry domain, such as https://example.com/mcp; required for awesome-ai-devtools
freeTierOptional free-tier sentence with concrete limits; required for free-for-dev
pricingUrlOptional 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-up

Phase 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.json not public or wrong path
  • Component JSON 404
  • Duplicate @scope in official directory
  • description too 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.

TargetReferenceOutput
Official shadcn-ui/uireferences/shadcn-ui-official.mdJSON entry + PR body
registry.directoryreferences/registry-directory.mdJSON entry + PR body
shadcntemplatesreferences/shadcntemplates.mdcontent/{author}-{name}.md
birobirobiro awesomereferences/awesome-birobirobiro.mdREADME table row
bytefer awesomereferences/awesome-bytefer.mdREADME table row
free-for-devreferences/free-for-dev.mdREADME bullet, gated on a hosted SaaS free tier
awesome-ai-devtoolsreferences/awesome-ai-devtools.mdREADME bullet, MCP server only with domain-derived mcpUrl

Present artifacts grouped by repo. Include:

  1. Exact file path to create or edit
  2. Full content to add rather than a partial diff
  3. 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:

  1. Official shadcn-ui/ui, the most visible listing and the one most likely to need maintainer review
  2. rbadillap/registry.directory
  3. shadcnblocks/shadcntemplates
  4. birobirobiro/awesome-shadcn-ui and bytefer/awesome-shadcn-ui, which can run in parallel
  5. jamesmurdza/awesome-ai-devtools, only when the registry ships a verified MCP server on its own domain
  6. ripienaar/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.

PlatformReference
Reddit r/shadcnreferences/social/reddit.md
Xreferences/social/x.md
Dev.toreferences/social/devto.md
Hacker Newsreferences/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:

  1. Share the repository, pull request URL, and status for every submission
  2. Remind the user to respond to review comments within 48 hours
  3. After the official merge, update social drafts to mention that the registry is now listed in the shadcn registry directory
  4. 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.json entry 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-devtools when the registry has no MCP server, and skip free-for-dev when 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

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.