uselab CLI

A simple CLI for adding UseKit hooks to React projects.

Installation

Requires Node.js 20 or newer.

npm install -g uselab

Or run it directly:

npx uselab@latest --help

Quick Start

1. Initialize your project:

npx uselab@latest init

2. Add a hook:

npx uselab@latest add use-network-status

3. See available hooks:

npx uselab@latest list

Common Commands

Add a hook:

npx uselab@latest add use-battery

Force JavaScript:

npx uselab@latest add use-battery --js

Force TypeScript:

npx uselab@latest add use-battery --ts

Preview a hook:

npx uselab@latest view use-battery

Search hooks:

npx uselab@latest search battery

Build registry files:

npx uselab@latest build --registry registry.json --output dist

How It Works

• uselab installs hooks into your project.
• It chooses TypeScript or JavaScript automatically based on your project.
• You can override that choice with --ts or --js.
• Existing projects stay simple: initialize once, then add hooks as needed.

Configuration

Running init creates a uselab.json file in your project root:

{
  "hooks": "src/hooks"
}

By default, hooks go to:

• src/hooks/ if your project has a src folder
• hooks/ otherwise

Documentation

For full docs and the hook registry:

• https://usekit.kiron.dev/docs/cli
• https://usekit.kiron.dev