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.

Help

Auto-generated help panel from a keymap

Ink OpenTUI

Terminal

                                                                               █
 help-demo                                                                     █
 Loading preview...                                                            █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █
                                                                               █

Installation


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

Usage

import { Help } from "@/components/ui/help";

<Help
  title="Keyboard Shortcuts"
  keymap={{
    q: "Quit",
    h: "Help",
    j: "Move down",
    k: "Move up",
  }}
/>

API Reference

Help

Prop	Type	Default
`keymap`	`Record<string, string>`	`required`
`title`	`string`	-
`compact`	`boolean`	`false`

Error Boundary Image

On This Page

Installation Usage API Reference Help

Edit this page Follow @shadcnlabs Join community