reuse-cli
v0.1.6
Published
Add magic ui components to your apps. Shadcn-ui based config
Downloads
9
Maintainers
Readme
magicui
A CLI for adding magic ui components to your project. Superset of shadcn-ui.
## ## ## ## ## ####
### ### ## ## ##
####### #### ### ## ### #### ## ## ##
####### ## ## ## ## ## ## ## ## ##
## # ## ##### ## ## ## ## ## ## ##
## ## ## ## ##### ## ## ## ## ## ##
## ## ##### ## #### #### ##### ####
#####
Usage
Use the init
command to initialize dependencies for a new project.
The init
command installs dependencies (framer-motion
), adds the cn
util, configures tailwind.config.js
, and CSS variables for the project.
npx reuse-cli init
shadcn-ui project
If your project is already using the shadcn-ui
, don't worry! You can still use magicui.
npx shadcn-ui init
Just add these two lines to your components.json
file:
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "default",
"rsc": true,
"tsx": true,
"tailwind": {
"config": "tailwind.config.js",
"css": "app/globals.css",
"baseColor": "slate",
"cssVariables": true
},
"aliases": {
"components": "@/components",
"utils": "@/lib/utils",
+ "ui": "@/components/ui",
+ "magicui": "@/components/magicui"
}
}
add
Use the add
command to add components to your project.
The add
command adds a component to your project and installs all required dependencies.
npx reuse-cli add [component]
Example
npx reuse-cli add bento-grid
You can also use the optional --all
flag to install all components:
npx reuse-cli add --all
You can also use the --exmaple
flag to select and install example & demo you saw on webside:
npx reuse-cli add --example
You can also run the command without any arguments to view a list of all available components:
npx reuse-cli add
shadcn-ui
You can also use the same CLI for selecting & installing shadcn-ui components:
npx reuse-cli add --shadcn button
npx reuse-cli add --shadcn --all
Documentation
Visit https://magicui.design/docs/installation to view the documentation.
License
Licensed under the MIT license.