CLI Reference

inkui add

Add one or more components to your project.

npx @inkui-cli/inkui add <component> [components...]

Examples

# Add a single component
npx @inkui-cli/inkui add spinner
 
# Add multiple at once
npx @inkui-cli/inkui add spinner table select dialog
 
# Add all 32 components at once
npx @inkui-cli/inkui add --all

What gets added

Running npx @inkui-cli/inkui add spinner copies:

./components/ui/
├── _core.ts        ← shared theme & design tokens (copied once)
└── spinner/
    ├── Spinner.tsx  ← the component source you own
    └── index.ts

Components import from the shared _core.ts file that is automatically copied alongside them. You own all of it — modify freely.

inkui list

List all available components in a table:

npx @inkui-cli/inkui list

inkui playground

Interactive component browser — live preview every component in your terminal:

npx @inkui-cli/inkui playground

inkui theme

Visual theme builder — pick colors interactively and export a ready-to-use inkui.theme.ts file:

npx @inkui-cli/inkui theme

Available components

Component	Command
Accordion	`npx @inkui-cli/inkui add accordion`
Autocomplete	`npx @inkui-cli/inkui add autocomplete`
Badge	`npx @inkui-cli/inkui add badge`
CodeBlock	`npx @inkui-cli/inkui add code-block`
Confirm	`npx @inkui-cli/inkui add confirm`
DataTable	`npx @inkui-cli/inkui add data-table`
Dialog	`npx @inkui-cli/inkui add dialog`
DiffView	`npx @inkui-cli/inkui add diff-view`
Divider	`npx @inkui-cli/inkui add divider`
Gauge	`npx @inkui-cli/inkui add gauge`
Header	`npx @inkui-cli/inkui add header`
Hooks	`npx @inkui-cli/inkui add hooks`
JSONViewer	`npx @inkui-cli/inkui add json-viewer`
KeyHint	`npx @inkui-cli/inkui add key-hint`
LoadingBar	`npx @inkui-cli/inkui add loading-bar`
Markdown	`npx @inkui-cli/inkui add markdown`
MultiSelect	`npx @inkui-cli/inkui add multi-select`
Panel	`npx @inkui-cli/inkui add panel`
ProgressBar	`npx @inkui-cli/inkui add progress-bar`
ScrollArea	`npx @inkui-cli/inkui add scroll-area`
Select	`npx @inkui-cli/inkui add select`
Sparkline	`npx @inkui-cli/inkui add sparkline`
Spinner	`npx @inkui-cli/inkui add spinner`
StatusIndicator	`npx @inkui-cli/inkui add status-indicator`
Stepper	`npx @inkui-cli/inkui add stepper`
StreamingText	`npx @inkui-cli/inkui add streaming-text`
Table	`npx @inkui-cli/inkui add table`
Tabs	`npx @inkui-cli/inkui add tabs`
TextInput	`npx @inkui-cli/inkui add text-input`
Toast	`npx @inkui-cli/inkui add toast`
TokenCounter	`npx @inkui-cli/inkui add token-counter`
TreeView	`npx @inkui-cli/inkui add tree-view`
Typewriter	`npx @inkui-cli/inkui add typewriter`

Run npx @inkui-cli/inkui list in your terminal to see all components with descriptions.