VistabyteUI

A CLI for adding VistabyteUI components to your project. Superset of shadcn-ui.

 ##     ## ####  ######  ########  ###    ########  ##    ## ######## #######
 ##     ##  ##  ##    ##    ##    ## ##      ##     ##  ##     ##    ##
 ##     ##  ##  ##          ##   ##   ##     ##      ####      ##    ##
  ##   ##   ##   ######     ##  ##     ##    ##       ##       ##    ########
   ## ##    ##        ##    ##  #########    ##       ##       ##    ##
    ###     ##  ##    ##    ##  ##     ##    ##       ##       ##    ##
     #     ####  ######     ##  ##     ##    ##       ##       ##    ########

Usage

Initialize dependencies for a new project with the init command:

npx vistabyteui-cli init

This command installs dependencies (including framer-motion), adds the cn util, configures tailwind.config.js, and sets up CSS variables for your project.

For existing shadcn-ui projects

If you're already using shadcn-ui, you can still integrate VistabyteUI:

1. First, run the shadcn-ui init command:

   npx shadcn-ui init

2. Then, add these 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",
   +   "vistabyteui": "@/components/vistabyteui"
     }
   }

Adding Components

Use the add command to include components in your project:

npx vistabyteui-cli add [component]

Examples

Add a specific component:

npx vistabyteui-cli add bento-grid

Install all components:

npx vistabyteui-cli add --all

Select and install examples from the website:

npx vistabyteui-cli add --example

View all available components:

npx vistabyteui-cli add

shadcn-ui Integration

VistabyteUI CLI also supports selecting and installing shadcn-ui components:

npx vistabyteui-cli add --shadcn button

Install all shadcn-ui components:

npx vistabyteui-cli add --shadcn --all

Documentation

For detailed information, visit https://ui.vistabyte.co/docs/installation.

License

Licensed under the MIT license.