https://github.com/thusithawijethunga/ext-shadcn-cli
Shadcn-Extension An open source component collection , that extends your ui library , built using shadcn component
https://github.com/thusithawijethunga/ext-shadcn-cli
shadcn shadcn-react shadcn-ui
Last synced: 8 months ago
JSON representation
Shadcn-Extension An open source component collection , that extends your ui library , built using shadcn component
- Host: GitHub
- URL: https://github.com/thusithawijethunga/ext-shadcn-cli
- Owner: thusithawijethunga
- License: mit
- Created: 2025-03-18T05:04:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-18T08:24:39.000Z (about 1 year ago)
- Last Synced: 2025-03-18T10:34:03.147Z (about 1 year ago)
- Topics: shadcn, shadcn-react, shadcn-ui
- Language: TypeScript
- Homepage: https://ui.byheart.lk
- Size: 723 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Shadcn-Extension
A CLI (inspired by shadcn-ui) for adding components to your project, making it easier to integrate and manage UI components within your codebase.
## Installation
To get started with the `shadcn-Extension` CLI, ensure you have `npx` installed. This tool allows you to run packages directly from npm without globally installing them.
> ## NOTE
>
> ALL TYPES PACKAGES FOR NOW NEEDS TO BE INSTALLED MANUALLY
## Usage
### Initializing a New Project
Use the `init` command to initialize dependencies for a new project. This command sets up everything you need, including installing necessary dependencies, adding the `cn` utility, configuring `tailwind.config.js`, and setting up CSS variables.
1. **Initialize Dependencies**
Run the following command to initialize the project:
```bash
npx shadcn-ui init
```
2. **Initialize Shadcn-Extension CLI**
Next, set up your project with the shadcn-extension CLI:
```bash
npx @shadext/cli init
```
### Adding Components
Use the `add` command to add components to your project. This command installs the required dependencies and integrates the specified component into your project.
1. **Add a Specific Component**
To add a specific component, specify the component name:
```bash
npx @shadext/cli add [component]
```
**Example:**
Adding a `tree-view` component:
```bash
npx @shadext/cli add tree-view
```
2. **View Available Components**
If you want to see a list of all available components, run the `add` command without any arguments:
```bash
npx @shadext/cli add
```
This will display a list of components that you can add to your project.
## Full Documentation
For detailed documentation, including installation guides, component usage, and more, visit the [shadcn-Extension Documentation](https://ui.byheart.lk/docs/installation).
## License
This project is licensed under the [MIT license](https://github.com/thusithawijethunga/ext-shadcn-cli/cli/LICENSE.md).
## Contributing
Contributions are welcome! If you have suggestions for improvements, please open an issue or submit a pull request on the [GitHub repository](https://github.com/thusithawijethunga/ext-shadcn-cli).