Skip to content

cli.md

Latest commit

 

History

History
136 lines (89 loc) · 3.08 KB

cli.md

File metadata and controls

136 lines (89 loc) · 3.08 KB
title CLI Reference

CLI Reference

Commands

npx termui init

Initialize TermUI in your project. Creates termui.config.json and components/ui/ directory.

npx termui init

npx termui add <component>

Add one or more components from the registry.

npx termui add spinner
npx termui add table select progress-bar
npx termui add --all   # install all 101 components

npx termui list

List all available components with install status.

npx termui list

npx termui update <component>

Re-download a component from the registry (overwrites local copy).

npx termui update spinner

npx termui diff <component>

Show diff between your local component and the registry version.

npx termui diff table

npx termui theme [name]

List available themes or apply one to your project.

npx termui theme           # list themes
npx termui theme dracula   # apply Dracula theme

Available themes: default, dracula, nord, catppuccin, monokai, solarized, tokyo-night, one-dark

npx termui preview

Interactive component gallery in the terminal. Browse all 101 components with live prop editing.

npx termui preview

Keybindings:

  • ↑↓ / jk — navigate list
  • → / Enter / l — select / drill in
  • ← / Esc / h — back
  • p — Props Playground (live JSX codegen)
  • q — quit

npx termui dev

Watch mode — monitors your component directory and hot-reloads the preview on file changes.

npx termui dev
npx termui dev --dir ./src/components

npx termui mcp

Start the TermUI MCP server over stdio. Exposes five tools to AI assistants (Claude Code, Cursor, GitHub Copilot):

npx termui mcp
npx termui mcp --help
Tool exposed Description
list_components Browse all components grouped by category
add_component Install component(s) into the current project
get_component_docs Full props + usage for a specific component
search_components Keyword search over the registry
get_theme_tokens List available themes and their token structure

npx termui add mcp

Install the MCP server config into an AI tool. Prompts for the installation scope:

npx termui add mcp
Scope File written
Local project .mcp.json (Claude Code project scope — auto-detected)
Global — Claude Code ~/.claude/settings.json
Global — Claude Desktop ~/Library/Application Support/Claude/claude_desktop_config.json (macOS)

After installing, restart your AI tool. Claude Code auto-detects .mcp.json; Claude Desktop requires a restart.