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.

Keyboard Shortcuts

Formatted keyboard shortcut reference table

Terminal

Installation


$ pnpm dlx shadcn@latest add @termcn/keyboard-shortcuts

Usage

import { KeyboardShortcuts } from "@/components/ui/keyboard-shortcuts";

<KeyboardShortcuts
  title="Editor Shortcuts"
  shortcuts={[
    { key: "Ctrl+S", description: "Save file" },
    { key: "Ctrl+Z", description: "Undo" },
    { key: "Ctrl+F", description: "Find" },
  ]}
/>

API Reference

KeyboardShortcuts

Prop	Type	Default
`shortcuts`	`Shortcut[]`	`required`
`columns`	`number`	`1`
`title`	`string`	-

Shortcut

Prop	Type	Default
`key`	`string`	`required`
`description`	`string`	`required`
`category`	`string`	-

Image Log

On This Page

Installation Usage API Reference KeyboardShortcuts Shortcut

Edit this page Follow @shadcnlabs Join community