CLI Reference

init

Initialize your project and set up the foundation for Kachindo UI.

Overview

The init command is your starting point. It prepares your project by creating the necessary configuration files, utility functions, and directory structure required by other Kachindo commands.

What happens during init?

  • Creates a components.json configuration file.
  • Sets up the cn utility for tailwind-merge.
  • Ensures nativewind and reanimated are installed.
  • Configures your tailwind.config.js with Kachindo tokens.
  • Sets up base directories for components, hooks, and constants.

Usage

Terminal

$npx kachindo@latest init

Configuration

During initialization, you'll be prompted to choose several options to tailor Kachindo to your project:

LanguageChoose between TypeScript or JavaScript.
Components pathWhere your UI components will be stored (default: ./components).
Utils pathWhere utility functions like 'cn' will be stored (default: ./lib/utils).

Make sure to run this command in the root of your project where your package.json is located.

Profile