Skip to content
Tooling

Cookest UI CLI

A zero-config command-line tool for adding Cookest UI components directly to your React or Flutter project — no setup, no friction.

v0.1.1ReactFlutter

No install required — run with npx or bunx:

bunx @cookest/ui-cli [command]

Workflow

1

Initialize your project

Run init inside your project root. The CLI auto-detects your framework and package manager — no questions asked.

terminal
$ bunx @cookest/ui-cli init
Cookest UI
React (bun) detected
Created .cookestrc
Next steps
1. bun add @cookest/ui
2. cookest-ui add button input badge
3. import { Button } from "@cookest/ui"
Docs: https://docs.cookest.app

Generated .cookestrc:

{
"framework": "react",
"componentsDir": "src/components/ui"
}
2

Explore available components

Use list to see all components grouped by category, with their full description. Filter by name or tag.

terminal
$ bunx @cookest/ui-cli list
Cookest UI 18 components
Inputs
────────────────────────────────────────────────────
button Pressable button with variants, loading state...
input Text input with label, error, helper text...
toggle Animated on/off switch with label...
select Custom dropdown with search, keyboard nav...
Display
────────────────────────────────────────────────────
badge Status label — info, success, warning...
alert Info, success, warning, error banners...
avatar User avatar with image, initials fallback...
… and 11 more
cookest-ui add <component>
3

Add components to your project

Run add with one or more component names. Files are fetched from the registry and written directly into your project — ready to customize.

terminal
$ bunx @cookest/ui-cli add button badge card
Cookest UI — add
Fetching from registry (github.com/Cookest)
Adding 3 components (react)
Adding button...
src/components/ui/Button.tsx
Adding badge...
src/components/ui/Badge.tsx
Adding card...
src/components/ui/Card.tsx
Import in your project:
import { Button } from "@/components/ui/Button";
Done!

Commands

cookest-ui init--yes

Create .cookestrc in the current project. Auto-detects framework and package manager. Use --yes to skip confirmation prompts.

cookest-ui list[filter]

List all available components grouped by category. Pass a string to filter by name, description, or tag.

cookest-ui add <name>--overwrite

Add one or more components to your project. Fetches source files from the registry. Use --overwrite to replace existing files.

cookest-ui diff <name>--all

Compare your local component files against the registry source. Useful when upgrading.

cookest-ui completion [shell]bash · zsh · fish

Print a shell completion script. Pipe it into your shell config to get tab completion for all commands and component names.

Shell Autocomplete

Install globally once, then register completion for your shell. Gives you tab completion for all commands and component names.

install globally
$ bun install -g @cookest/ui-cli
+ @cookest/ui-cli@0.1.2
zsh — add to ~/.zshrc
eval "$(cookest-ui completion zsh)"
bash — add to ~/.bashrc
eval "$(cookest-ui completion bash)"
fish — add to Fish config
cookest-ui completion fish | source
After setup: cookest-ui add <TAB> shows all component names. cookest-ui <TAB> shows all commands.

npm — @cookest/ui-cli

Available on npm. Use bunx, npx, or pnpx to run without installing globally.

bunx @cookest/ui-clinpx @cookest/ui-clipnpx @cookest/ui-cli