CLI
How to use the nativecn CLI to initialize your project, add components, and manage dependencies.
Usage
The nativecn CLI provides commands to initialize your project and add components.
Initialize nativecn
To initialize your project and install dependencies, run:
npx nativecn initOptions:
-y, --yes: Skip confirmation prompt-c, --cwd <cwd>: Specify the working directory (default: current directory)
Add components
To add specific components to your project, use:
npx nativecn add [...Components]Options:
-y, --yes: Skip confirmation prompt-o, --overwrite: Overwrite existing files-c, --cwd <cwd>: Specify the working directory (default: current directory)-a, --all: Add all available components-p, --path <path>: Specify the path to add the component to
Pro Tip
If you dont specify components, you will be prompted to select from a list of available components. You can also chain multiple component names:This will add the Button, Text, and Input components in one go.
npx nativecn add Button Text InputAdditional Information
- The
initcommand sets up necessary configuration files liketailwind.config.js,babel.config.js, and others. - It also installs required dependencies including NativeWind, TailwindCSS, and other utility libraries.
- The
addcommand fetches component code from a registry and adds it to your project. - Use
--helpwith any command for more detailed information.