A collection of beautifully designed, accessible, and customizable terminal UI components. Built on Ink and OpenTUI. 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.

                                                                               █
 menu-demo                                                                     █
 Loading preview...                                                            █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █

Installation


$ pnpm dlx shadcn@latest add @termcn/opentui/menu

Usage

import { Menu } from "@/components/ui/menu";

<Menu
  title="File"
  items={[
    { key: "new", label: "New File", shortcut: "⌘N" },
    { key: "save", label: "Save", shortcut: "⌘S" },
  ]}
  onSelect={(item) => console.log(item.key)}
/>

API Reference

Prop	Type	Default
`items`	`MenuItem[]`	`required`
`onSelect`	`(item: MenuItem) => void`	-
`title`	`string`	-

MenuItem

Prop	Type	Default
`key`	`string`	`required`
`label`	`string`	`required`
`icon`	`string`	-
`shortcut`	`string`	-
`disabled`	`boolean`	-
`separator`	`boolean`	-
`children`	`MenuItem[]`	-

Command Palette Pagination

On This Page

Installation Usage API Reference Menu MenuItem

Edit this page Follow @shadcnlabs Join community