A collection of beautifully designed, accessible, and customizable terminal UI components. Built on Ink. Works with shadcn/ui.

How do I publish components with termcn?

Add or edit components under registry/bases/ink/ or registry/bases/opentui/, register them in registry.json, run pnpm registry:build (which refreshes public/r/), then deploy. Consumers install with npx shadcn@latest add against your published registry URL.

Is termcn open source?

Yes. The source is on GitHub and released under the MIT License.

Command Palette

VS Code–style command palette with fuzzy search

Terminal

command-palette-demo

No opentui live preview is registered for this example yet.

Installation


$ pnpm dlx shadcn@latest add @termcn/command-palette

Usage

import { CommandPalette } from "@/components/ui/command-palette";

<CommandPalette
  isOpen={true}
  onClose={() => setOpen(false)}
  commands={[
    { id: "save", label: "Save", onSelect: () => {} },
    { id: "quit", label: "Quit", onSelect: () => {} },
  ]}
/>

API Reference

CommandPalette

Prop	Type	Default
`commands`	`Command[]`	`required`
`isOpen`	`boolean`	`required`
`onClose`	`() => void`	`required`
`placeholder`	`string`	`"Type a command..."`
`maxItems`	`number`	`8`

Command

Prop	Type	Default
`id`	`string`	`required`
`label`	`string`	`required`
`description`	`string`	-
`shortcut`	`string`	-
`onSelect`	`() => void`	`required`
`group`	`string`	-

Breadcrumb Menu

On This Page

Installation Usage API Reference CommandPalette Command

Edit this page Follow @shadcnlabs Join community