Docs
CLI

CLI

Use the CLI to add components to your project.

init

Use the init command to initialize configuration and dependencies for a new project.

The init command installs dependencies, adds the ny util, configures tailwind.config.js, and CSS variables for the project.

npx nyxb@latest init

You will be asked a few questions to configure nyxbui.json:

Which style would you like to use? › Miami
Which color would you like to use as base color? › Zinc
Do you want to use CSS variables for colors? › no / yes

Options

Usage: nyxb init [options] [components...]
 
initialize your project and install dependencies
 
Arguments:
  components         the components to add or a url to the component.
 
Options:
  -d, --defaults    use default values i.e miami, zinc and css variables. (default: false)
  -f, --force       force overwrite of existing nyxbui.json. (default: false)
  -y, --yes         skip confirmation prompt. (default: false)
  -c, --cwd <cwd>   the working directory. defaults to the current directory.
  -h, --help       display help for command

add

Use the add command to add components and dependencies to your project.

npx nyxb@latest add [component]

You will be presented with a list of components to choose from:

Which components would you like to add? › Space to select. A to toggle all.
Enter to submit.
 
◯  accordion
◯  alert
◯  alert-dialog
◯  aspect-ratio
◯  avatar
◯  badge
◯  button
◯  calendar
◯  card
◯  checkbox

Options

Usage: nyxb add [options] [components...]
 
add a component to your project
 
Arguments:
  components         the components to add or a url to the component.
 
Options:
  -y, --yes          skip confirmation prompt. (default: false)
  -o, --overwrite    overwrite existing files. (default: false)
  -c, --cwd <cwd>    the working directory. defaults to the current directory.
  -a, --all          add all available components. (default: false)
  -p, --path <path>  the path to add the component to.
  -h, --help         display help for command

build

Use the build command to generate the registry JSON files.

npx nyxb@latest build

This command reads the registry.json file and generates the registry JSON files in the public/r directory.

Usage: nyxb build [options] [registry]
 
build components for a nyxb registry
 
Arguments:
  registry             path to registry.json file (default: "./registry.json")
 
Options:
  -o, --output <path>  destination directory for json files (default: "./public/r")
  -c, --cwd <cwd>      the working directory. defaults to the current directory. (default:
                       "/Users/nyxb/Code/nyxb/ui/packages/nyxb")
  -h, --help           display help for command

To customize the output directory, use the --output option.

npx nyxb@latest build --output ./public/registry
Dark modeMonorepo