A powerful and user-friendly CLI tool to efficiently remove Shadcn UI components from your project.
🌟 If you find this project helpful, please consider giving it a ⭐ on GitHub! 🌟
- Remove Specific Components: Target one or more components by name.
- Remove All Components: Option to remove all detected components at once.
- Interactive Mode: Select components to remove from a list if none are specified.
- Dry Run: Preview which files/directories would be removed without making changes.
-
Flexible Detection: Handles both file-based (
button.tsx
) and directory-based (dialog/
) component structures. - User-Friendly: Provides clear feedback with progress spinners and colored output.
- Safe: Includes confirmation prompts before deleting files.
- Lightweight & Fast: Built with modern tools for efficiency.
-
Node.js: Version 18.0.0 or higher (
>=18.0.0
) - npm (or yarn/pnpm)
Install the tool globally using your preferred package manager:
# Using npm
npm install -g shadcn-remover
# Using yarn
yarn global add shadcn-remover
# Using pnpm
pnpm add -g shadcn-remover
Navigate to the root directory of your project in your terminal and run the command:
shadcn-remover [components...] [options]
-
[components...]
: (Optional) A space-separated list of component names to remove (e.g.,button card dialog
).
Option | Alias | Description | Default |
---|---|---|---|
--all |
-a |
Attempt to remove all detected Shadcn UI components | false |
--dry-run |
-d |
Show what would be removed without actually deleting | false |
--version |
-V |
Display the version number | |
--help |
-h |
Display help information |
# Remove specific components (button, alert-dialog, sheet)
shadcn-remover button alert-dialog sheet
# Remove all components (will prompt for confirmation)
shadcn-remover --all
# Start interactive mode (prompts you to select components)
shadcn-remover
# Dry run: See what would happen if you removed the 'card' component
shadcn-remover card --dry-run
# Dry run: See what would happen if you removed all components
shadcn-remover --all --dry-run
By default, shadcn-remover
expects your Shadcn UI components to be located in:
<your-project-root>/src/components/ui/
Ensure you run the command from your project's root directory for the path detection to work correctly.
Contributions, issues, and feature requests are welcome! Feel free to check the issues page.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Exodus-Tola
- GitHub: @exodus-tola-mindCoder
This project is licensed under the MIT License - see the LICENSE file for details.
cli
, shadcn
, shadcn-ui
, ui
, components
, remove
, delete
, cleanup
, utility
, tool
, nodejs
If you find this project helpful, please consider giving it a ⭐ on GitHub!
Follow the repository to stay updated with the latest features and improvements. Suggestions and feedback are always welcome!