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.

Embedded Terminal

Embedded PTY terminal panel (requires node-pty peer)

Ink OpenTUI

Terminal

Embedded terminal requires Node.js and may not render in the browser preview.

Installation


$ pnpm dlx shadcn@latest add @termcn/embedded-terminal

Usage

import { EmbeddedTerminal } from "@/components/ui/embedded-terminal";

<EmbeddedTerminal
  command="bash"
  args={["-c", "echo Hello world"]}
  width={80}
  height={24}
  onExit={(code) => console.log(`Exited with ${code}`)}
/>

API Reference

EmbeddedTerminal

Prop	Type	Default
`command`	`string`	`required`
`args`	`string[]`	`[]`
`cwd`	`string`	-
`width`	`number`	`80`
`height`	`number`	`24`
`onExit`	`(code: number) => void`	-

Clock Error Boundary

On This Page

Installation Usage API Reference EmbeddedTerminal

Edit this page Follow @shadcnlabs Join community