Shadcn Registry

shadcn-registry: CLI Tool for Custom shadcn UI Registries

shadcn-registry is a command-line tool that simplifies the process of creating and managing custom component registries for shadcn UI. It allows developers to generate registry files from their own components, ensuring compatibility with the shadcn CLI. This tool is ideal for teams looking to maintain a private or extended collection of shadcn-style components, streamlining their development workflow and component sharing practices within their projects.

Features:

• JSON Registry Definition: Create and manage your shadcn component registry using a structured JSON file.
• Schema Validation: Ensures your registry files adhere to the correct format for shadcn compatibility, as defined in registry.schema.ts.
• Registry Build Command: Compiles your defined registry into files usable by the shadcn CLI using npx shadcn-registry build <path-to-registry>.
• Customizable Output Paths: Control the output directories for generated registry files (-p, --path) and the main index file (-i, --index).
• Selective Index Inclusion: Specify which component types (e.g., ui, hook, lib) to include in the generated registry index file using --index-include.
• CI/CD Friendly: Designed for easy integration into automated build and deployment pipelines for continuous registry updates.
• Experimental Registry Generation: Automatically generate an index.json registry file from your component directory structure using the npx shadcn-registry generate <path-to-components> command.

Summary:

shadcn-registry is a practical CLI utility for developers working with shadcn UI. It empowers users to create, validate, and build their own custom component registries. This facilitates the management of private or extended shadcn component collections, making it easier to integrate them into projects using the standard shadcn CLI. The tool also offers experimental features for automated registry generation from existing component directories, enhancing developer productivity.