Simple Shadcn Cli

Streamline shadcn-cli Custom Registry Creation

simple-shadcn-cli is a dedicated command-line interface designed to simplify the creation and management of custom registry items for your shadcn-cli projects. It offers an interactive mode for crafting individual components and an automated build process for project-wide registry generation. This tool supports UI components, library utilities, and React hooks, helping developers efficiently extend their shadcn-cli toolkit with custom elements and configurations.

Features:

• Interactive CLI Creation: Step-by-step guidance for generating single registry items.
• Automated Project Build: Processes your project's components to create registry JSON files from a configuration file.
• Multiple Registry Type Support: Handles registry:ui (UI components), registry:lib (library utilities), and registry:hook (React hooks).
• Multiple Files per Item: Allows associating several source files with one registry item.
• File Overwrite Protection: Safeguards against unintentional overwriting of existing files during creation.
• TypeScript Schema Types: Provides Registry, RegistryItem, and RegistryItemFile types for robust configuration.
• Configurable Output Directory: Users can specify where the generated JSON files are stored.
• Configurable Registry Source: Define the directory containing your registry components for the build command.
• Detailed Item Configuration: Set name, type, description, dependencies, dev dependencies, and registry dependencies for items.
• GitHub Gist Integration Guide: Explains how to make registry items public for shadcn-cli using Gists.
• Example Project Provided: Demonstrates the build command usage in a Vite and React.js setup.

Summary:

simple-shadcn-cli provides developers with a focused command-line utility to efficiently produce custom registry items compatible with shadcn-cli. Whether creating items interactively or building them from an existing project structure, this tool automates the generation of the required JSON definitions. It supports various component types and offers configuration options, including TypeScript types, to enhance the development workflow for custom shadcn-cli elements.