getting started

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 radianos util and CSS variables for the project.

pnpm dlx radianui@latest init

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

Terminal
 No package.json found at C:\Users\RadianOS\Projects. Create a new project? ... yes
 What would you like to name your project? ... my-app
 Which framework do you want to use? » Next.js
 Would you like to use /src directory? ... yes
 Which color would you like to use as your brand color? » Dark Orchid
 Which font would you like to use for your project? » Inter - Inter Display (Default)
 Creating a new Next.js project. This might take some time.
 Writing components.json file
 Setting up project configuration
 Installing dependencies
 Updating global CSS variables
 
Success! Project initialization completed. You may now add components.

options

Terminal
Usage: radianui init [options] [project-name]
 
Arguments:
  project-name                 the name of the project
 
Options:
  --next                       use next.js (default: false)
  --vite                       use vite (default: false)
  --useSrc                     use src directory
  --color <color>              set brand color
  --font <font>                set default font
  -s, --skipPrompts            skip confirmation prompts (default: false)
  -d, --defaultConfigurations  use default configurations (default: false)
  -c, --cwd <cwd>              current working directory (default: "D:\\RadianOS\\radianos")
  -h, --help                   display help for command

add

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

pnpm dlx radianui@latest add [component]

You will be presented with installation process:

Terminal
RadianOS v1.0.0
 Checking registry
 Installing the dependencies
 
Created 1 file(s):
 
- C:\Project\components\ui\accordion.tsx

options

Terminal
Usage: radianui add [options] [components...]
 
add components to ui folder inside the components folder in your project
 
Arguments:
  components       the components to add.
 
Options:
  -y, --yes        skip confirmation prompts. (default: false)
  -a, --all        install all available components. (default: false)
  -c, --cwd <cwd>  the working directory. defaults to the current directory. (default: "D:\\RadianOS\\radianos")
  -o, --overwrite  overwrite existing files if they exist. (default: false)
  -h, --help       display help for command