Getting Started

CLI

The Kachindo CLI is the fastest way to add components to your React Native or Expo project.

Overview

Kachindo UI doesn't use a traditional npm package for its components. Instead, we provide a CLI that lets you copy and paste component source code directly into your project. This gives you full control over the implementation and styling.

Commands

Initialize your project with Kachindo UI. This will create a components.json config file, set up the necessary directory structure, and install required dependencies like NativeWind and Reanimated.

Terminal

$npx kachindo@latest init

Add a component to your project. You can specify multiple components or run without arguments to see a list of available components.

Terminal

$npx kachindo@latest add [components...]

Example

Terminal

$npx kachindo@latest add button card

Check for updates to your installed components. This command compares your local files with the latest versions in the Kachindo registry.

Terminal

$npx kachindo@latest diff

Update installed components to their latest versions. Warning: This will overwrite your existing component files.

Terminal

$npx kachindo@latest update

Create a brand new React Native (CLI) or Expo project with Kachindo UI pre-configured and dependencies pre-installed.

Terminal

$npx kachindo@latest build

Display the signature Kachindo brand animation in your terminal.

Terminal

$npx kachindo@latest animation

Display help information for all Kachindo CLI commands and options.

Terminal

$npx kachindo@latest --help

Why a CLI?

By using a CLI to add components, you avoid the "black box" of node_modules. You can see exactly how each component is built, tweak it to fit your needs, and ensure that your project's bundle size only includes the code you actually use.

No Bloat

Only add the components you need.

Full Control

Modify the code directly in your project.

Theming

Easily integrate with your project's NativeWind theme.

Profile