@baselane/packs 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +191 -0
- package/NOTICE +6 -0
- package/README.md +15 -0
- package/dist/ai-merge.d.ts +26 -0
- package/dist/ai-merge.js +165 -0
- package/dist/aliases.d.ts +7 -0
- package/dist/aliases.js +9 -0
- package/dist/compose-draft.d.ts +19 -0
- package/dist/compose-draft.js +170 -0
- package/dist/drift-detect.d.ts +8 -0
- package/dist/drift-detect.js +21 -0
- package/dist/index.d.ts +40 -0
- package/dist/index.js +21 -0
- package/dist/ingest.d.ts +25 -0
- package/dist/ingest.js +262 -0
- package/dist/load.d.ts +7 -0
- package/dist/load.js +29 -0
- package/dist/manifest.d.ts +71 -0
- package/dist/manifest.js +208 -0
- package/dist/materialize-harness.d.ts +15 -0
- package/dist/materialize-harness.js +48 -0
- package/dist/merge-region.d.ts +60 -0
- package/dist/merge-region.js +166 -0
- package/dist/overlap.d.ts +32 -0
- package/dist/overlap.js +49 -0
- package/dist/pack-from-fileset.d.ts +13 -0
- package/dist/pack-from-fileset.js +133 -0
- package/dist/render/adapters.d.ts +6 -0
- package/dist/render/adapters.js +43 -0
- package/dist/render/agents-md.d.ts +3 -0
- package/dist/render/agents-md.js +49 -0
- package/dist/render/bundle-union.d.ts +10 -0
- package/dist/render/bundle-union.js +87 -0
- package/dist/render/bundle.d.ts +3 -0
- package/dist/render/bundle.js +51 -0
- package/dist/render/capabilities.d.ts +19 -0
- package/dist/render/capabilities.js +86 -0
- package/dist/render/claude.d.ts +3 -0
- package/dist/render/claude.js +92 -0
- package/dist/render/design.d.ts +27 -0
- package/dist/render/design.js +443 -0
- package/dist/render/graph.d.ts +11 -0
- package/dist/render/graph.js +245 -0
- package/dist/render/memory.d.ts +35 -0
- package/dist/render/memory.js +353 -0
- package/dist/render/render-pack.d.ts +3 -0
- package/dist/render/render-pack.js +43 -0
- package/dist/render/repo-union.d.ts +14 -0
- package/dist/render/repo-union.js +94 -0
- package/dist/render/rollout-files.d.ts +18 -0
- package/dist/render/rollout-files.js +39 -0
- package/dist/render/system-map.d.ts +8 -0
- package/dist/render/system-map.js +73 -0
- package/dist/render/tasks.d.ts +32 -0
- package/dist/render/tasks.js +327 -0
- package/dist/render/wiki.d.ts +30 -0
- package/dist/render/wiki.js +288 -0
- package/dist/seed/graph-seed.d.ts +17 -0
- package/dist/seed/graph-seed.js +18 -0
- package/dist/seed/wiki-seed.d.ts +23 -0
- package/dist/seed/wiki-seed.js +133 -0
- package/dist/seed-skills.d.ts +18 -0
- package/dist/seed-skills.js +134 -0
- package/dist/types.d.ts +122 -0
- package/dist/types.js +1 -0
- package/dist/validate.d.ts +30 -0
- package/dist/validate.js +397 -0
- package/package.json +38 -0
- package/packs/database-review/pack.json +44 -0
- package/packs/database-review/rendered/.baselane/capabilities.json +10 -0
- package/packs/database-review/rendered/.baselane/system-map/README.md +18 -0
- package/packs/database-review/rendered/.claude/agents/database-reviewer.md +8 -0
- package/packs/database-review/rendered/.claude/commands/db-review.md +6 -0
- package/packs/database-review/rendered/.claude/commands/map.md +6 -0
- package/packs/database-review/rendered/.claude/settings.json +26 -0
- package/packs/database-review/rendered/.github/copilot-instructions.md +48 -0
- package/packs/database-review/rendered/AGENTS.md +66 -0
- package/packs/database-review/rendered/CLAUDE.md +9 -0
- package/packs/database-review/rendered/GEMINI.md +3 -0
- package/packs/disciplined-workflow/pack.json +63 -0
- package/packs/disciplined-workflow/rendered/.baselane/capabilities.json +10 -0
- package/packs/disciplined-workflow/rendered/.baselane/tasks/README.md +36 -0
- package/packs/disciplined-workflow/rendered/.claude/agents/plan-reviewer.md +8 -0
- package/packs/disciplined-workflow/rendered/.claude/agents/task-reviewer.md +8 -0
- package/packs/disciplined-workflow/rendered/.claude/commands/brainstorm.md +6 -0
- package/packs/disciplined-workflow/rendered/.claude/commands/execute-plan.md +6 -0
- package/packs/disciplined-workflow/rendered/.claude/commands/plan-work.md +6 -0
- package/packs/disciplined-workflow/rendered/.claude/commands/write-plan.md +6 -0
- package/packs/disciplined-workflow/rendered/.claude/settings.json +24 -0
- package/packs/disciplined-workflow/rendered/.github/copilot-instructions.md +24 -0
- package/packs/disciplined-workflow/rendered/AGENTS.md +43 -0
- package/packs/disciplined-workflow/rendered/CLAUDE.md +12 -0
- package/packs/disciplined-workflow/rendered/GEMINI.md +3 -0
- package/packs/frontend-design/pack.json +129 -0
- package/packs/frontend-design/rendered/.claude/skills/clone/SKILL.md +39 -0
- package/packs/frontend-design/rendered/.claude/skills/functional-ui/SKILL.md +78 -0
- package/packs/frontend-design/rendered/.claude/skills/gsap/SKILL.md +36 -0
- package/packs/frontend-design/rendered/.claude/skills/gsap/gsap-core.md +254 -0
- package/packs/frontend-design/rendered/.claude/skills/gsap/gsap-frameworks.md +266 -0
- package/packs/frontend-design/rendered/.claude/skills/gsap/gsap-performance.md +79 -0
- package/packs/frontend-design/rendered/.claude/skills/gsap/gsap-plugins.md +433 -0
- package/packs/frontend-design/rendered/.claude/skills/gsap/gsap-react.md +136 -0
- package/packs/frontend-design/rendered/.claude/skills/gsap/gsap-scrolltrigger.md +296 -0
- package/packs/frontend-design/rendered/.claude/skills/gsap/gsap-timeline.md +107 -0
- package/packs/frontend-design/rendered/.claude/skills/gsap/gsap-utils.md +284 -0
- package/packs/frontend-design/rendered/.claude/skills/marketing-ui/SKILL.md +36 -0
- package/packs/frontend-design/rendered/.claude/skills/shadcn/SKILL.md +267 -0
- package/packs/frontend-design/rendered/.claude/skills/shadcn/base-vs-radix.md +306 -0
- package/packs/frontend-design/rendered/.claude/skills/shadcn/cli.md +290 -0
- package/packs/frontend-design/rendered/.claude/skills/shadcn/composition.md +195 -0
- package/packs/frontend-design/rendered/.claude/skills/shadcn/customization.md +209 -0
- package/packs/frontend-design/rendered/.claude/skills/shadcn/forms.md +192 -0
- package/packs/frontend-design/rendered/.claude/skills/shadcn/icons.md +101 -0
- package/packs/frontend-design/rendered/.claude/skills/shadcn/mcp.md +105 -0
- package/packs/frontend-design/rendered/.claude/skills/shadcn/registry.md +277 -0
- package/packs/frontend-design/rendered/.claude/skills/shadcn/styling.md +162 -0
- package/packs/frontend-design/rendered/.github/copilot-instructions.md +474 -0
- package/packs/frontend-design/rendered/AGENTS.md +33 -0
- package/packs/frontend-design/rendered/CLAUDE.md +10 -0
- package/packs/frontend-design/rendered/GEMINI.md +456 -0
- package/packs/frontend-taste/pack.json +43 -0
- package/packs/frontend-taste/rendered/.baselane/capabilities.json +16 -0
- package/packs/frontend-taste/rendered/.claude/agents/taste-reviewer.md +8 -0
- package/packs/frontend-taste/rendered/.claude/commands/design-review.md +6 -0
- package/packs/frontend-taste/rendered/.claude/settings.json +15 -0
- package/packs/frontend-taste/rendered/.github/copilot-instructions.md +51 -0
- package/packs/frontend-taste/rendered/AGENTS.md +68 -0
- package/packs/frontend-taste/rendered/CLAUDE.md +8 -0
- package/packs/frontend-taste/rendered/DESIGN.md +72 -0
- package/packs/frontend-taste/rendered/GEMINI.md +3 -0
- package/packs/go-rules/pack.json +38 -0
- package/packs/go-rules/rendered/.claude/agents/go-reviewer.md +8 -0
- package/packs/go-rules/rendered/.claude/commands/go-review.md +6 -0
- package/packs/go-rules/rendered/.claude/settings.json +15 -0
- package/packs/go-rules/rendered/.github/copilot-instructions.md +44 -0
- package/packs/go-rules/rendered/AGENTS.md +54 -0
- package/packs/go-rules/rendered/CLAUDE.md +8 -0
- package/packs/go-rules/rendered/GEMINI.md +3 -0
- package/packs/python-rules/pack.json +38 -0
- package/packs/python-rules/rendered/.claude/agents/python-reviewer.md +8 -0
- package/packs/python-rules/rendered/.claude/commands/python-review.md +6 -0
- package/packs/python-rules/rendered/.claude/settings.json +15 -0
- package/packs/python-rules/rendered/.github/copilot-instructions.md +43 -0
- package/packs/python-rules/rendered/AGENTS.md +53 -0
- package/packs/python-rules/rendered/CLAUDE.md +8 -0
- package/packs/python-rules/rendered/GEMINI.md +3 -0
- package/packs/second-brain/pack.json +36 -0
- package/packs/second-brain/rendered/.baselane/capabilities.json +25 -0
- package/packs/second-brain/rendered/.baselane/memory/README.md +34 -0
- package/packs/second-brain/rendered/.baselane/wiki/README.md +62 -0
- package/packs/second-brain/rendered/.claude/agents/librarian.md +14 -0
- package/packs/second-brain/rendered/.claude/commands/remember.md +6 -0
- package/packs/second-brain/rendered/.claude/commands/wiki.md +6 -0
- package/packs/second-brain/rendered/.claude/settings.json +35 -0
- package/packs/second-brain/rendered/.github/copilot-instructions.md +24 -0
- package/packs/second-brain/rendered/AGENTS.md +41 -0
- package/packs/second-brain/rendered/CLAUDE.md +9 -0
- package/packs/second-brain/rendered/GEMINI.md +3 -0
- package/packs/security-review/pack.json +72 -0
- package/packs/security-review/rendered/.claude/agents/security-reviewer.md +8 -0
- package/packs/security-review/rendered/.claude/commands/security-audit.md +6 -0
- package/packs/security-review/rendered/.claude/commands/security-scan.md +6 -0
- package/packs/security-review/rendered/.claude/settings.json +35 -0
- package/packs/security-review/rendered/.claude/skills/security-audit/SKILL.md +44 -0
- package/packs/security-review/rendered/.claude/skills/validate-at-boundaries/SKILL.md +41 -0
- package/packs/security-review/rendered/.github/copilot-instructions.md +137 -0
- package/packs/security-review/rendered/AGENTS.md +66 -0
- package/packs/security-review/rendered/CLAUDE.md +11 -0
- package/packs/security-review/rendered/GEMINI.md +90 -0
- package/packs/software-engineer-harness/pack.json +98 -0
- package/packs/software-engineer-harness/rendered/.baselane/capabilities.json +15 -0
- package/packs/software-engineer-harness/rendered/.baselane/system-map/README.md +18 -0
- package/packs/software-engineer-harness/rendered/.baselane/tasks/README.md +36 -0
- package/packs/software-engineer-harness/rendered/.claude/agents/architect.md +8 -0
- package/packs/software-engineer-harness/rendered/.claude/agents/checker.md +8 -0
- package/packs/software-engineer-harness/rendered/.claude/agents/code-reviewer.md +8 -0
- package/packs/software-engineer-harness/rendered/.claude/agents/code-simplifier.md +8 -0
- package/packs/software-engineer-harness/rendered/.claude/agents/planner.md +8 -0
- package/packs/software-engineer-harness/rendered/.claude/agents/reviewer.md +8 -0
- package/packs/software-engineer-harness/rendered/.claude/commands/build-and-check.md +6 -0
- package/packs/software-engineer-harness/rendered/.claude/commands/map.md +6 -0
- package/packs/software-engineer-harness/rendered/.claude/commands/plan-change.md +6 -0
- package/packs/software-engineer-harness/rendered/.claude/commands/plan-work.md +6 -0
- package/packs/software-engineer-harness/rendered/.claude/commands/review-change.md +6 -0
- package/packs/software-engineer-harness/rendered/.claude/commands/tdd-task.md +6 -0
- package/packs/software-engineer-harness/rendered/.claude/settings.json +35 -0
- package/packs/software-engineer-harness/rendered/.github/copilot-instructions.md +37 -0
- package/packs/software-engineer-harness/rendered/AGENTS.md +58 -0
- package/packs/software-engineer-harness/rendered/CLAUDE.md +18 -0
- package/packs/software-engineer-harness/rendered/GEMINI.md +3 -0
- package/packs/systematic-debugging/pack.json +44 -0
- package/packs/systematic-debugging/rendered/.claude/agents/debugger.md +8 -0
- package/packs/systematic-debugging/rendered/.claude/commands/debug.md +6 -0
- package/packs/systematic-debugging/rendered/.claude/commands/root-cause.md +6 -0
- package/packs/systematic-debugging/rendered/.claude/settings.json +15 -0
- package/packs/systematic-debugging/rendered/.github/copilot-instructions.md +20 -0
- package/packs/systematic-debugging/rendered/AGENTS.md +31 -0
- package/packs/systematic-debugging/rendered/CLAUDE.md +9 -0
- package/packs/systematic-debugging/rendered/GEMINI.md +3 -0
- package/packs/token-efficiency-harness/pack.json +49 -0
- package/packs/token-efficiency-harness/rendered/.baselane/capabilities.json +10 -0
- package/packs/token-efficiency-harness/rendered/.baselane/memory/README.md +34 -0
- package/packs/token-efficiency-harness/rendered/.claude/agents/scout.md +8 -0
- package/packs/token-efficiency-harness/rendered/.claude/commands/handoff.md +6 -0
- package/packs/token-efficiency-harness/rendered/.claude/commands/remember.md +6 -0
- package/packs/token-efficiency-harness/rendered/.claude/commands/usage-audit.md +6 -0
- package/packs/token-efficiency-harness/rendered/.claude/settings.json +26 -0
- package/packs/token-efficiency-harness/rendered/.github/copilot-instructions.md +26 -0
- package/packs/token-efficiency-harness/rendered/AGENTS.md +44 -0
- package/packs/token-efficiency-harness/rendered/CLAUDE.md +10 -0
- package/packs/token-efficiency-harness/rendered/GEMINI.md +3 -0
- package/packs/typescript-rules/pack.json +46 -0
- package/packs/typescript-rules/rendered/.claude/agents/typescript-reviewer.md +8 -0
- package/packs/typescript-rules/rendered/.claude/commands/typescript-review.md +6 -0
- package/packs/typescript-rules/rendered/.claude/settings.json +15 -0
- package/packs/typescript-rules/rendered/.claude/skills/immutable-updates/SKILL.md +46 -0
- package/packs/typescript-rules/rendered/.github/copilot-instructions.md +89 -0
- package/packs/typescript-rules/rendered/AGENTS.md +55 -0
- package/packs/typescript-rules/rendered/CLAUDE.md +9 -0
- package/packs/typescript-rules/rendered/GEMINI.md +51 -0
- package/skills/algorithmic-art/LICENSE +202 -0
- package/skills/algorithmic-art/LICENSE.txt +202 -0
- package/skills/algorithmic-art/SKILL.md +405 -0
- package/skills/algorithmic-art/templates/generator_template.js +223 -0
- package/skills/algorithmic-art/templates/viewer.html +599 -0
- package/skills/brainstorming/LICENSE +21 -0
- package/skills/brainstorming/SKILL.md +159 -0
- package/skills/brainstorming/scripts/frame-template.html +213 -0
- package/skills/brainstorming/scripts/helper.js +167 -0
- package/skills/brainstorming/scripts/server.cjs +723 -0
- package/skills/brainstorming/scripts/start-server.sh +209 -0
- package/skills/brainstorming/scripts/stop-server.sh +120 -0
- package/skills/brainstorming/spec-document-reviewer-prompt.md +49 -0
- package/skills/brainstorming/visual-companion.md +291 -0
- package/skills/brand-guidelines/LICENSE +202 -0
- package/skills/brand-guidelines/LICENSE.txt +202 -0
- package/skills/brand-guidelines/SKILL.md +73 -0
- package/skills/canvas-design/LICENSE +202 -0
- package/skills/canvas-design/LICENSE.txt +202 -0
- package/skills/canvas-design/SKILL.md +130 -0
- package/skills/canvas-design/canvas-fonts/ArsenalSC-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/ArsenalSC-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/BigShoulders-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/BigShoulders-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/BigShoulders-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Boldonse-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/Boldonse-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/BricolageGrotesque-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/BricolageGrotesque-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/BricolageGrotesque-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/CrimsonPro-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/CrimsonPro-Italic.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/CrimsonPro-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/CrimsonPro-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/DMMono-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/DMMono-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/EricaOne-OFL.txt +94 -0
- package/skills/canvas-design/canvas-fonts/EricaOne-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/GeistMono-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/GeistMono-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/GeistMono-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Gloock-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/Gloock-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/IBMPlexMono-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/IBMPlexMono-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/IBMPlexMono-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/IBMPlexSerif-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/IBMPlexSerif-BoldItalic.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/IBMPlexSerif-Italic.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/IBMPlexSerif-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/InstrumentSans-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/InstrumentSans-BoldItalic.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/InstrumentSans-Italic.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/InstrumentSans-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/InstrumentSans-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/InstrumentSerif-Italic.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/InstrumentSerif-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Italiana-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/Italiana-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/JetBrainsMono-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/JetBrainsMono-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/JetBrainsMono-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Jura-Light.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Jura-Medium.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Jura-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/LibreBaskerville-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/LibreBaskerville-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Lora-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Lora-BoldItalic.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Lora-Italic.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Lora-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/Lora-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/NationalPark-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/NationalPark-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/NationalPark-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/NothingYouCouldDo-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/NothingYouCouldDo-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Outfit-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Outfit-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/Outfit-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/PixelifySans-Medium.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/PixelifySans-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/PoiretOne-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/PoiretOne-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/RedHatMono-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/RedHatMono-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/RedHatMono-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Silkscreen-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/Silkscreen-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/SmoochSans-Medium.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/SmoochSans-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/Tektur-Medium.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/Tektur-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/Tektur-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/WorkSans-Bold.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/WorkSans-BoldItalic.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/WorkSans-Italic.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/WorkSans-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/WorkSans-Regular.ttf +0 -0
- package/skills/canvas-design/canvas-fonts/YoungSerif-OFL.txt +93 -0
- package/skills/canvas-design/canvas-fonts/YoungSerif-Regular.ttf +0 -0
- package/skills/dispatching-parallel-agents/LICENSE +21 -0
- package/skills/dispatching-parallel-agents/SKILL.md +185 -0
- package/skills/executing-plans/LICENSE +21 -0
- package/skills/executing-plans/SKILL.md +70 -0
- package/skills/finishing-a-development-branch/LICENSE +21 -0
- package/skills/finishing-a-development-branch/SKILL.md +241 -0
- package/skills/first-party/README.md +32 -0
- package/skills/first-party/append-only-jsonl-stores/SKILL.md +50 -0
- package/skills/first-party/golden-snapshot-discipline/SKILL.md +45 -0
- package/skills/first-party/immutable-updates/SKILL.md +46 -0
- package/skills/first-party/manifest.json +10 -0
- package/skills/first-party/ts-extension-imports/SKILL.md +49 -0
- package/skills/first-party/validate-at-boundaries/SKILL.md +41 -0
- package/skills/first-party/zero-dependency-discipline/SKILL.md +41 -0
- package/skills/frontend-design/LICENSE +177 -0
- package/skills/frontend-design/LICENSE.txt +177 -0
- package/skills/frontend-design/SKILL.md +55 -0
- package/skills/internal-comms/LICENSE +202 -0
- package/skills/internal-comms/LICENSE.txt +202 -0
- package/skills/internal-comms/SKILL.md +32 -0
- package/skills/internal-comms/examples/3p-updates.md +47 -0
- package/skills/internal-comms/examples/company-newsletter.md +65 -0
- package/skills/internal-comms/examples/faq-answers.md +30 -0
- package/skills/internal-comms/examples/general-comms.md +16 -0
- package/skills/mcp-builder/LICENSE +202 -0
- package/skills/mcp-builder/LICENSE.txt +202 -0
- package/skills/mcp-builder/SKILL.md +236 -0
- package/skills/mcp-builder/reference/evaluation.md +602 -0
- package/skills/mcp-builder/reference/mcp_best_practices.md +249 -0
- package/skills/mcp-builder/reference/node_mcp_server.md +970 -0
- package/skills/mcp-builder/reference/python_mcp_server.md +719 -0
- package/skills/mcp-builder/scripts/connections.py +151 -0
- package/skills/mcp-builder/scripts/evaluation.py +373 -0
- package/skills/mcp-builder/scripts/example_evaluation.xml +22 -0
- package/skills/mcp-builder/scripts/requirements.txt +2 -0
- package/skills/receiving-code-review/LICENSE +21 -0
- package/skills/receiving-code-review/SKILL.md +213 -0
- package/skills/requesting-code-review/LICENSE +21 -0
- package/skills/requesting-code-review/SKILL.md +103 -0
- package/skills/requesting-code-review/code-reviewer.md +172 -0
- package/skills/seed-manifest.json +185 -0
- package/skills/skill-creator/LICENSE +202 -0
- package/skills/skill-creator/LICENSE.txt +202 -0
- package/skills/skill-creator/SKILL.md +485 -0
- package/skills/skill-creator/agents/analyzer.md +274 -0
- package/skills/skill-creator/agents/comparator.md +202 -0
- package/skills/skill-creator/agents/grader.md +223 -0
- package/skills/skill-creator/assets/eval_review.html +146 -0
- package/skills/skill-creator/eval-viewer/generate_review.py +471 -0
- package/skills/skill-creator/eval-viewer/viewer.html +1325 -0
- package/skills/skill-creator/references/schemas.md +430 -0
- package/skills/skill-creator/scripts/__init__.py +0 -0
- package/skills/skill-creator/scripts/aggregate_benchmark.py +401 -0
- package/skills/skill-creator/scripts/generate_report.py +326 -0
- package/skills/skill-creator/scripts/improve_description.py +247 -0
- package/skills/skill-creator/scripts/package_skill.py +136 -0
- package/skills/skill-creator/scripts/quick_validate.py +103 -0
- package/skills/skill-creator/scripts/run_eval.py +310 -0
- package/skills/skill-creator/scripts/run_loop.py +328 -0
- package/skills/skill-creator/scripts/utils.py +47 -0
- package/skills/slack-gif-creator/LICENSE +202 -0
- package/skills/slack-gif-creator/LICENSE.txt +202 -0
- package/skills/slack-gif-creator/SKILL.md +254 -0
- package/skills/slack-gif-creator/core/easing.py +234 -0
- package/skills/slack-gif-creator/core/frame_composer.py +176 -0
- package/skills/slack-gif-creator/core/gif_builder.py +269 -0
- package/skills/slack-gif-creator/core/validators.py +136 -0
- package/skills/slack-gif-creator/requirements.txt +4 -0
- package/skills/subagent-driven-development/LICENSE +21 -0
- package/skills/subagent-driven-development/SKILL.md +418 -0
- package/skills/subagent-driven-development/implementer-prompt.md +139 -0
- package/skills/subagent-driven-development/scripts/review-package +44 -0
- package/skills/subagent-driven-development/scripts/sdd-workspace +22 -0
- package/skills/subagent-driven-development/scripts/task-brief +40 -0
- package/skills/subagent-driven-development/task-reviewer-prompt.md +188 -0
- package/skills/systematic-debugging/CREATION-LOG.md +119 -0
- package/skills/systematic-debugging/LICENSE +21 -0
- package/skills/systematic-debugging/SKILL.md +296 -0
- package/skills/systematic-debugging/condition-based-waiting-example.ts +158 -0
- package/skills/systematic-debugging/condition-based-waiting.md +115 -0
- package/skills/systematic-debugging/defense-in-depth.md +122 -0
- package/skills/systematic-debugging/find-polluter.sh +63 -0
- package/skills/systematic-debugging/root-cause-tracing.md +169 -0
- package/skills/systematic-debugging/test-academic.md +14 -0
- package/skills/systematic-debugging/test-pressure-1.md +58 -0
- package/skills/systematic-debugging/test-pressure-2.md +68 -0
- package/skills/systematic-debugging/test-pressure-3.md +69 -0
- package/skills/test-driven-development/LICENSE +21 -0
- package/skills/test-driven-development/SKILL.md +371 -0
- package/skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/skills/theme-factory/LICENSE +202 -0
- package/skills/theme-factory/LICENSE.txt +202 -0
- package/skills/theme-factory/SKILL.md +59 -0
- package/skills/theme-factory/theme-showcase.pdf +0 -0
- package/skills/theme-factory/themes/arctic-frost.md +19 -0
- package/skills/theme-factory/themes/botanical-garden.md +19 -0
- package/skills/theme-factory/themes/desert-rose.md +19 -0
- package/skills/theme-factory/themes/forest-canopy.md +19 -0
- package/skills/theme-factory/themes/golden-hour.md +19 -0
- package/skills/theme-factory/themes/midnight-galaxy.md +19 -0
- package/skills/theme-factory/themes/modern-minimalist.md +19 -0
- package/skills/theme-factory/themes/ocean-depths.md +19 -0
- package/skills/theme-factory/themes/sunset-boulevard.md +19 -0
- package/skills/theme-factory/themes/tech-innovation.md +19 -0
- package/skills/using-git-worktrees/LICENSE +21 -0
- package/skills/using-git-worktrees/SKILL.md +202 -0
- package/skills/using-superpowers/LICENSE +21 -0
- package/skills/using-superpowers/SKILL.md +62 -0
- package/skills/using-superpowers/references/antigravity-tools.md +23 -0
- package/skills/using-superpowers/references/codex-tools.md +39 -0
- package/skills/using-superpowers/references/pi-tools.md +16 -0
- package/skills/verification-before-completion/LICENSE +21 -0
- package/skills/verification-before-completion/SKILL.md +139 -0
- package/skills/web-artifacts-builder/LICENSE +202 -0
- package/skills/web-artifacts-builder/LICENSE.txt +202 -0
- package/skills/web-artifacts-builder/SKILL.md +74 -0
- package/skills/web-artifacts-builder/scripts/bundle-artifact.sh +54 -0
- package/skills/web-artifacts-builder/scripts/init-artifact.sh +322 -0
- package/skills/web-artifacts-builder/scripts/shadcn-components.tar.gz +0 -0
- package/skills/webapp-testing/LICENSE +202 -0
- package/skills/webapp-testing/LICENSE.txt +202 -0
- package/skills/webapp-testing/SKILL.md +96 -0
- package/skills/webapp-testing/examples/console_logging.py +35 -0
- package/skills/webapp-testing/examples/element_discovery.py +40 -0
- package/skills/webapp-testing/examples/static_html_automation.py +33 -0
- package/skills/webapp-testing/scripts/with_server.py +106 -0
- package/skills/writing-plans/LICENSE +21 -0
- package/skills/writing-plans/SKILL.md +174 -0
- package/skills/writing-plans/plan-document-reviewer-prompt.md +49 -0
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# shadcn MCP Server
|
|
2
|
+
|
|
3
|
+
The CLI includes an MCP server that lets AI assistants search, browse, view, and install items from registries.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Setup
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
shadcn mcp # start the MCP server (stdio)
|
|
11
|
+
shadcn mcp init # write config for your editor
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Editor config files:
|
|
15
|
+
|
|
16
|
+
| Editor | Config file |
|
|
17
|
+
| ----------- | ------------------------------- |
|
|
18
|
+
| Claude Code | `.mcp.json` |
|
|
19
|
+
| Cursor | `.cursor/mcp.json` |
|
|
20
|
+
| VS Code | `.vscode/mcp.json` |
|
|
21
|
+
| OpenCode | `opencode.json` |
|
|
22
|
+
| Codex | `~/.codex/config.toml` (manual) |
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Tools
|
|
27
|
+
|
|
28
|
+
> **Tip:** MCP tools handle registry operations (search, view, install). For project configuration (aliases, framework, Tailwind version), use `npx shadcn@latest info` — there is no MCP equivalent.
|
|
29
|
+
|
|
30
|
+
### `shadcn:get_project_registries`
|
|
31
|
+
|
|
32
|
+
Returns registry names from `components.json`. Errors if no `components.json` exists.
|
|
33
|
+
|
|
34
|
+
**Input:** none
|
|
35
|
+
|
|
36
|
+
### `shadcn:list_items_in_registries`
|
|
37
|
+
|
|
38
|
+
Lists all items from one or more registries. Registries can be configured
|
|
39
|
+
namespaces such as `@acme`, public GitHub sources such as `owner/repo`, or
|
|
40
|
+
registry catalog URLs. Omit `registries` to list from every registry configured
|
|
41
|
+
in `components.json`.
|
|
42
|
+
|
|
43
|
+
**Input:** `registries` (string[], optional — omit for all configured), `types` (string[], optional — e.g. `["ui", "block"]`), `limit` (number, optional, defaults to 100), `offset` (number, optional)
|
|
44
|
+
|
|
45
|
+
### `shadcn:search_items_in_registries`
|
|
46
|
+
|
|
47
|
+
Fuzzy search across registries. Registries can be configured namespaces, public
|
|
48
|
+
GitHub sources, or registry catalog URLs. Omit `registries` to search every
|
|
49
|
+
registry configured in `components.json` — e.g. "find me a hero" across all
|
|
50
|
+
configured registries.
|
|
51
|
+
|
|
52
|
+
**Input:** `registries` (string[], optional — omit for all configured), `query` (string), `types` (string[], optional — e.g. `["ui", "block"]`), `limit` (number, optional, defaults to 100), `offset` (number, optional)
|
|
53
|
+
|
|
54
|
+
### `shadcn:view_items_in_registries`
|
|
55
|
+
|
|
56
|
+
View item details including full file contents.
|
|
57
|
+
|
|
58
|
+
**Input:** `items` (string[]) — e.g.
|
|
59
|
+
`["@shadcn/button", "@shadcn/card", "owner/repo/item"]`
|
|
60
|
+
|
|
61
|
+
### `shadcn:get_item_examples_from_registries`
|
|
62
|
+
|
|
63
|
+
Find usage examples and demos with source code. Omit `registries` to search
|
|
64
|
+
every registry configured in `components.json`.
|
|
65
|
+
|
|
66
|
+
**Input:** `registries` (string[], optional — omit for all configured), `query` (string) — e.g. `"accordion-demo"`, `"button example"`
|
|
67
|
+
|
|
68
|
+
### `shadcn:get_add_command_for_items`
|
|
69
|
+
|
|
70
|
+
Returns the CLI install command.
|
|
71
|
+
|
|
72
|
+
**Input:** `items` (string[]) — e.g. `["@shadcn/button"]`
|
|
73
|
+
|
|
74
|
+
### `shadcn:get_audit_checklist`
|
|
75
|
+
|
|
76
|
+
Returns a checklist for verifying components (imports, deps, lint, TypeScript).
|
|
77
|
+
|
|
78
|
+
**Input:** none
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Configuring Registries
|
|
83
|
+
|
|
84
|
+
Namespaced and authenticated registries are set in `components.json`. The
|
|
85
|
+
`@shadcn` registry is always built-in. Public GitHub registries can also be used
|
|
86
|
+
directly as `owner/repo` registry sources when the repository has a root
|
|
87
|
+
`registry.json`; they do not need `components.json` configuration.
|
|
88
|
+
|
|
89
|
+
```json
|
|
90
|
+
{
|
|
91
|
+
"registries": {
|
|
92
|
+
"@acme": "https://acme.com/r/{name}.json",
|
|
93
|
+
"@private": {
|
|
94
|
+
"url": "https://private.com/r/{name}.json",
|
|
95
|
+
"headers": { "Authorization": "Bearer ${MY_TOKEN}" }
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
- Names must start with `@`.
|
|
102
|
+
- URLs must contain `{name}`.
|
|
103
|
+
- `${VAR}` references are resolved from environment variables.
|
|
104
|
+
|
|
105
|
+
Community registry index: `https://ui.shadcn.com/r/registries.json`
|
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
# Registry Authoring and Addresses
|
|
2
|
+
|
|
3
|
+
Use this reference when the user wants to create, fix, publish, or reason about
|
|
4
|
+
a shadcn registry.
|
|
5
|
+
|
|
6
|
+
## Mental Model
|
|
7
|
+
|
|
8
|
+
A registry has two forms:
|
|
9
|
+
|
|
10
|
+
- **Source registry**: an authored `registry.json` in a project or repository.
|
|
11
|
+
It may use `include` and file paths that point at source files.
|
|
12
|
+
- **Built registry**: generated JSON files served to CLI consumers, usually
|
|
13
|
+
from `public/r`. Use `npx shadcn@latest build` to create this form.
|
|
14
|
+
|
|
15
|
+
The CLI installer consumes registry item payloads. A source registry is a way to
|
|
16
|
+
author those payloads from real files.
|
|
17
|
+
|
|
18
|
+
Registry items are not limited to React components. They can distribute
|
|
19
|
+
components, hooks, utilities, design tokens, pages, config files, docs, rules,
|
|
20
|
+
workflows, templates, MCP files, and other project files.
|
|
21
|
+
|
|
22
|
+
## Root `registry.json`
|
|
23
|
+
|
|
24
|
+
The root registry file should define registry metadata and either `items` or
|
|
25
|
+
`include`.
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
{
|
|
29
|
+
"$schema": "https://ui.shadcn.com/schema/registry.json",
|
|
30
|
+
"name": "acme",
|
|
31
|
+
"homepage": "https://acme.com",
|
|
32
|
+
"items": [
|
|
33
|
+
{
|
|
34
|
+
"name": "absolute-url",
|
|
35
|
+
"type": "registry:lib",
|
|
36
|
+
"title": "Absolute URL",
|
|
37
|
+
"description": "A utility to turn any path into an absolute URL.",
|
|
38
|
+
"files": [
|
|
39
|
+
{
|
|
40
|
+
"path": "lib/absolute-url.ts",
|
|
41
|
+
"type": "registry:lib"
|
|
42
|
+
}
|
|
43
|
+
]
|
|
44
|
+
}
|
|
45
|
+
]
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Root registry rules:
|
|
50
|
+
|
|
51
|
+
- Root `registry.json` must include `name` and `homepage`.
|
|
52
|
+
- `items` is an array of registry item definitions.
|
|
53
|
+
- `include` may be used to split the source registry into multiple files.
|
|
54
|
+
- Included registry files may omit `name` and `homepage`.
|
|
55
|
+
|
|
56
|
+
## Include
|
|
57
|
+
|
|
58
|
+
Use `include` to keep large registries modular.
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"$schema": "https://ui.shadcn.com/schema/registry.json",
|
|
63
|
+
"name": "acme",
|
|
64
|
+
"homepage": "https://acme.com",
|
|
65
|
+
"include": ["registry/ui/registry.json", "registry/blocks/registry.json"]
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Include rules:
|
|
70
|
+
|
|
71
|
+
- Include paths are relative to the `registry.json` that declares them.
|
|
72
|
+
- Include paths must explicitly point to a `registry.json` file.
|
|
73
|
+
- Do not use remote URLs, absolute paths, or parent traversal (`..`).
|
|
74
|
+
- Item file paths are relative to the registry file that declares the item.
|
|
75
|
+
- Duplicate item names fail across the resolved registry.
|
|
76
|
+
|
|
77
|
+
Example included file:
|
|
78
|
+
|
|
79
|
+
```json
|
|
80
|
+
{
|
|
81
|
+
"items": [
|
|
82
|
+
{
|
|
83
|
+
"name": "button",
|
|
84
|
+
"type": "registry:ui",
|
|
85
|
+
"files": [
|
|
86
|
+
{
|
|
87
|
+
"path": "button.tsx",
|
|
88
|
+
"type": "registry:ui"
|
|
89
|
+
}
|
|
90
|
+
]
|
|
91
|
+
}
|
|
92
|
+
]
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
If this file is at `registry/ui/registry.json`, then `button.tsx` is read from
|
|
97
|
+
`registry/ui/button.tsx`, and the built item path is emitted relative to the
|
|
98
|
+
root registry.
|
|
99
|
+
|
|
100
|
+
## Item Definitions
|
|
101
|
+
|
|
102
|
+
Common item fields:
|
|
103
|
+
|
|
104
|
+
```json
|
|
105
|
+
{
|
|
106
|
+
"name": "login-form",
|
|
107
|
+
"type": "registry:block",
|
|
108
|
+
"title": "Login Form",
|
|
109
|
+
"description": "A login form with email and password fields.",
|
|
110
|
+
"dependencies": ["zod"],
|
|
111
|
+
"registryDependencies": ["button", "input", "label"],
|
|
112
|
+
"files": [
|
|
113
|
+
{
|
|
114
|
+
"path": "blocks/login-form.tsx",
|
|
115
|
+
"type": "registry:block"
|
|
116
|
+
}
|
|
117
|
+
],
|
|
118
|
+
"cssVars": {
|
|
119
|
+
"light": {
|
|
120
|
+
"brand": "oklch(0.62 0.18 250)"
|
|
121
|
+
},
|
|
122
|
+
"dark": {
|
|
123
|
+
"brand": "oklch(0.72 0.16 250)"
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Important fields:
|
|
130
|
+
|
|
131
|
+
- `name`: the installable item name. It is not necessarily a file path.
|
|
132
|
+
- `type`: one of the registry item types, such as `registry:ui`,
|
|
133
|
+
`registry:block`, `registry:lib`, `registry:hook`, `registry:file`,
|
|
134
|
+
`registry:page`, `registry:theme`, `registry:style`, `registry:font`, or
|
|
135
|
+
`registry:item`.
|
|
136
|
+
- `files`: source files copied or generated by the item.
|
|
137
|
+
- `dependencies`: npm runtime dependencies.
|
|
138
|
+
- `devDependencies`: npm development dependencies.
|
|
139
|
+
- `registryDependencies`: other registry items required by this item.
|
|
140
|
+
- `cssVars`, `css`, `tailwind`, `envVars`, and `docs`: optional install-time
|
|
141
|
+
additions.
|
|
142
|
+
|
|
143
|
+
File rules:
|
|
144
|
+
|
|
145
|
+
- File paths are relative to the declaring `registry.json`.
|
|
146
|
+
- `registry:file` and `registry:page` files require a `target`.
|
|
147
|
+
- Do not use remote file URLs in source registry file paths.
|
|
148
|
+
- Keep source files copy-pasteable: no hidden app-only imports.
|
|
149
|
+
|
|
150
|
+
## Registry Dependencies
|
|
151
|
+
|
|
152
|
+
`registryDependencies` entries are item addresses, not file paths.
|
|
153
|
+
|
|
154
|
+
```json
|
|
155
|
+
{
|
|
156
|
+
"name": "login-form",
|
|
157
|
+
"type": "registry:block",
|
|
158
|
+
"registryDependencies": ["button", "@acme/input", "acme/ui/card#v1.2.0"],
|
|
159
|
+
"files": [
|
|
160
|
+
{
|
|
161
|
+
"path": "blocks/login-form.tsx",
|
|
162
|
+
"type": "registry:block"
|
|
163
|
+
}
|
|
164
|
+
]
|
|
165
|
+
}
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
Dependency rules:
|
|
169
|
+
|
|
170
|
+
- Bare names such as `"button"` mean official shadcn items.
|
|
171
|
+
- Bare names never mean same-registry or same-repository items.
|
|
172
|
+
- Namespaced dependencies use `@namespace/item-name`.
|
|
173
|
+
- GitHub dependencies use `owner/repo/item-name`.
|
|
174
|
+
- Pin GitHub dependencies with `owner/repo/item-name#ref` when needed.
|
|
175
|
+
- Refs are not inherited. If `owner/repo/foo#v2` depends on `bar` from the same
|
|
176
|
+
repo at `v2`, write `owner/repo/bar#v2`.
|
|
177
|
+
- Do not use relative dependencies such as `"./bar"`.
|
|
178
|
+
|
|
179
|
+
## Address Schemes
|
|
180
|
+
|
|
181
|
+
When reasoning about a registry item string, classify it first.
|
|
182
|
+
|
|
183
|
+
| Address | Scheme | Meaning |
|
|
184
|
+
| ----------------------------------- | --------- | ------------------------------------------------------------ |
|
|
185
|
+
| `button` | shadcn | Official shadcn item named `button`. |
|
|
186
|
+
| `@acme/button` | namespace | Item `button` from configured registry `@acme`. |
|
|
187
|
+
| `@acme/ui/button` | namespace | Item `ui/button` from configured registry `@acme`. |
|
|
188
|
+
| `https://example.com/r/button.json` | url | Built registry item JSON at that URL. |
|
|
189
|
+
| `./button.json` | file | Built registry item JSON on disk. |
|
|
190
|
+
| `acme/ui/button` | github | Item `button` from GitHub repo `acme/ui`. |
|
|
191
|
+
| `acme/ui/forms/login#main` | github | Item `forms/login` from GitHub repo `acme/ui` at ref `main`. |
|
|
192
|
+
|
|
193
|
+
For namespace and GitHub addresses, slashful item names are allowed and are item
|
|
194
|
+
names, not file paths. Addresses ending in `.json` keep file-address
|
|
195
|
+
precedence, so `acme/ui/data/schema.json` is treated as a file path, not a
|
|
196
|
+
GitHub item address.
|
|
197
|
+
|
|
198
|
+
## GitHub Registries
|
|
199
|
+
|
|
200
|
+
A public GitHub repository can act as a source registry when it has a root
|
|
201
|
+
`registry.json`.
|
|
202
|
+
|
|
203
|
+
```txt
|
|
204
|
+
owner/repo/item-name[#ref]
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
Rules:
|
|
208
|
+
|
|
209
|
+
- The first two path segments are GitHub owner and repo.
|
|
210
|
+
- All remaining path segments are the registry item name.
|
|
211
|
+
- The source entrypoint is always root `registry.json`.
|
|
212
|
+
- GitHub registries are source registries consumed directly by the CLI. They do
|
|
213
|
+
not require `shadcn build` or generated item JSON files.
|
|
214
|
+
- `include` follows the same source-registry rules as local registries.
|
|
215
|
+
- Currently, GitHub addresses support public `github.com` repositories only.
|
|
216
|
+
- Private repos and GitHub Enterprise require explicit product decisions.
|
|
217
|
+
|
|
218
|
+
When implementing GitHub registry fetching, resolve refs to a commit SHA before
|
|
219
|
+
reading source files. Do not read moving refs directly from
|
|
220
|
+
`raw.githubusercontent.com`, because branch-like refs can be cached for several
|
|
221
|
+
minutes.
|
|
222
|
+
|
|
223
|
+
Preferred flow:
|
|
224
|
+
|
|
225
|
+
```txt
|
|
226
|
+
owner/repo[#ref]
|
|
227
|
+
-> resolve ref with git ls-remote
|
|
228
|
+
-> commit SHA
|
|
229
|
+
-> read https://raw.githubusercontent.com/{owner}/{repo}/{sha}/registry.json
|
|
230
|
+
-> read includes and item files from the same SHA
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
This keeps a command on one consistent repository snapshot.
|
|
234
|
+
|
|
235
|
+
Full 40-character commit SHAs are already stable and can be used directly.
|
|
236
|
+
Branches, tags, and short refs require Git so the CLI can resolve them to a
|
|
237
|
+
commit SHA first.
|
|
238
|
+
|
|
239
|
+
## Build and Verify
|
|
240
|
+
|
|
241
|
+
Use the CLI to build source registries:
|
|
242
|
+
|
|
243
|
+
```bash
|
|
244
|
+
npx shadcn@latest build
|
|
245
|
+
npx shadcn@latest build registry.json --output public/r
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
Use CLI commands to inspect the result:
|
|
249
|
+
|
|
250
|
+
```bash
|
|
251
|
+
npx shadcn@latest list @acme
|
|
252
|
+
npx shadcn@latest search @acme -q "login"
|
|
253
|
+
npx shadcn@latest view @acme/login-form
|
|
254
|
+
npx shadcn@latest add @acme/login-form --dry-run
|
|
255
|
+
npx shadcn@latest registry validate ./registry.json
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
Use GitHub addresses directly for public GitHub registries:
|
|
259
|
+
|
|
260
|
+
```bash
|
|
261
|
+
npx shadcn@latest list owner/repo
|
|
262
|
+
npx shadcn@latest search owner/repo -q "login"
|
|
263
|
+
npx shadcn@latest view owner/repo/item
|
|
264
|
+
npx shadcn@latest add owner/repo/item --dry-run
|
|
265
|
+
npx shadcn@latest registry validate owner/repo
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
When working on registry implementation in the shadcn/ui codebase:
|
|
269
|
+
|
|
270
|
+
- Keep address parsing pure and testable.
|
|
271
|
+
- Do not add side effects to validators.
|
|
272
|
+
- Preserve existing behavior for official shadcn, namespace, URL, and file
|
|
273
|
+
schemes.
|
|
274
|
+
- Add tests for address parsing, source loading, dependency resolution, list,
|
|
275
|
+
search, view, and add paths.
|
|
276
|
+
- Prefer small source-reader abstractions over a plugin system until there are
|
|
277
|
+
multiple real providers.
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
# Styling & Customization
|
|
2
|
+
|
|
3
|
+
See [customization.md](../customization.md) for theming, CSS variables, and adding custom colors.
|
|
4
|
+
|
|
5
|
+
## Contents
|
|
6
|
+
|
|
7
|
+
- Semantic colors
|
|
8
|
+
- Built-in variants first
|
|
9
|
+
- className for layout only
|
|
10
|
+
- No space-x-* / space-y-*
|
|
11
|
+
- Prefer size-* over w-* h-* when equal
|
|
12
|
+
- Prefer truncate shorthand
|
|
13
|
+
- No manual dark: color overrides
|
|
14
|
+
- Use cn() for conditional classes
|
|
15
|
+
- No manual z-index on overlay components
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Semantic colors
|
|
20
|
+
|
|
21
|
+
**Incorrect:**
|
|
22
|
+
|
|
23
|
+
```tsx
|
|
24
|
+
<div className="bg-blue-500 text-white">
|
|
25
|
+
<p className="text-gray-600">Secondary text</p>
|
|
26
|
+
</div>
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
**Correct:**
|
|
30
|
+
|
|
31
|
+
```tsx
|
|
32
|
+
<div className="bg-primary text-primary-foreground">
|
|
33
|
+
<p className="text-muted-foreground">Secondary text</p>
|
|
34
|
+
</div>
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## No raw color values for status/state indicators
|
|
40
|
+
|
|
41
|
+
For positive, negative, or status indicators, use Badge variants, semantic tokens like `text-destructive`, or define custom CSS variables — don't reach for raw Tailwind colors.
|
|
42
|
+
|
|
43
|
+
**Incorrect:**
|
|
44
|
+
|
|
45
|
+
```tsx
|
|
46
|
+
<span className="text-emerald-600">+20.1%</span>
|
|
47
|
+
<span className="text-green-500">Active</span>
|
|
48
|
+
<span className="text-red-600">-3.2%</span>
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**Correct:**
|
|
52
|
+
|
|
53
|
+
```tsx
|
|
54
|
+
<Badge variant="secondary">+20.1%</Badge>
|
|
55
|
+
<Badge>Active</Badge>
|
|
56
|
+
<span className="text-destructive">-3.2%</span>
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
If you need a success/positive color that doesn't exist as a semantic token, use a Badge variant or ask the user about adding a custom CSS variable to the theme (see [customization.md](../customization.md)).
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## Built-in variants first
|
|
64
|
+
|
|
65
|
+
**Incorrect:**
|
|
66
|
+
|
|
67
|
+
```tsx
|
|
68
|
+
<Button className="border border-input bg-transparent hover:bg-accent">
|
|
69
|
+
Click me
|
|
70
|
+
</Button>
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
**Correct:**
|
|
74
|
+
|
|
75
|
+
```tsx
|
|
76
|
+
<Button variant="outline">Click me</Button>
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## className for layout only
|
|
82
|
+
|
|
83
|
+
Use `className` for layout (e.g. `max-w-md`, `mx-auto`, `mt-4`), **not** for overriding component colors or typography. To change colors, use semantic tokens, built-in variants, or CSS variables.
|
|
84
|
+
|
|
85
|
+
**Incorrect:**
|
|
86
|
+
|
|
87
|
+
```tsx
|
|
88
|
+
<Card className="bg-blue-100 text-blue-900 font-bold">
|
|
89
|
+
<CardContent>Dashboard</CardContent>
|
|
90
|
+
</Card>
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
**Correct:**
|
|
94
|
+
|
|
95
|
+
```tsx
|
|
96
|
+
<Card className="max-w-md mx-auto">
|
|
97
|
+
<CardContent>Dashboard</CardContent>
|
|
98
|
+
</Card>
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
To customize a component's appearance, prefer these approaches in order:
|
|
102
|
+
1. **Built-in variants** — `variant="outline"`, `variant="destructive"`, etc.
|
|
103
|
+
2. **Semantic color tokens** — `bg-primary`, `text-muted-foreground`.
|
|
104
|
+
3. **CSS variables** — define custom colors in the global CSS file (see [customization.md](../customization.md)).
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
## No space-x-* / space-y-*
|
|
109
|
+
|
|
110
|
+
Use `gap-*` instead. `space-y-4` → `flex flex-col gap-4`. `space-x-2` → `flex gap-2`.
|
|
111
|
+
|
|
112
|
+
```tsx
|
|
113
|
+
<div className="flex flex-col gap-4">
|
|
114
|
+
<Input />
|
|
115
|
+
<Input />
|
|
116
|
+
<Button>Submit</Button>
|
|
117
|
+
</div>
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
## Prefer size-* over w-* h-* when equal
|
|
123
|
+
|
|
124
|
+
`size-10` not `w-10 h-10`. Applies to icons, avatars, skeletons, etc.
|
|
125
|
+
|
|
126
|
+
---
|
|
127
|
+
|
|
128
|
+
## Prefer truncate shorthand
|
|
129
|
+
|
|
130
|
+
`truncate` not `overflow-hidden text-ellipsis whitespace-nowrap`.
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## No manual dark: color overrides
|
|
135
|
+
|
|
136
|
+
Use semantic tokens — they handle light/dark via CSS variables. `bg-background text-foreground` not `bg-white dark:bg-gray-950`.
|
|
137
|
+
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
## Use cn() for conditional classes
|
|
141
|
+
|
|
142
|
+
Use the `cn()` utility from the project for conditional or merged class names. Don't write manual ternaries in className strings.
|
|
143
|
+
|
|
144
|
+
**Incorrect:**
|
|
145
|
+
|
|
146
|
+
```tsx
|
|
147
|
+
<div className={`flex items-center ${isActive ? "bg-primary text-primary-foreground" : "bg-muted"}`}>
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
**Correct:**
|
|
151
|
+
|
|
152
|
+
```tsx
|
|
153
|
+
import { cn } from "@/lib/utils"
|
|
154
|
+
|
|
155
|
+
<div className={cn("flex items-center", isActive ? "bg-primary text-primary-foreground" : "bg-muted")}>
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
## No manual z-index on overlay components
|
|
161
|
+
|
|
162
|
+
`Dialog`, `Sheet`, `Drawer`, `AlertDialog`, `DropdownMenu`, `Popover`, `Tooltip`, `HoverCard` handle their own stacking. Never add `z-50` or `z-[999]`.
|