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.

Image

Image renderer with iTerm2/Kitty protocol and ASCII fallback

Ink OpenTUI

Terminal

Image rendering uses terminal-specific protocols (iTerm2, Kitty) and falls back to ASCII art. Results vary by terminal emulator.

Installation


$ pnpm dlx shadcn@latest add @termcn/image

Usage

import { Image } from "@/components/ui/image";

<Image src="./screenshot.png" width={40} alt="Application screenshot" />

API Reference

Image

Prop	Type	Default
`src`	`string`	`required`
`width`	`number`	`20`
`height`	`number`	-
`protocol`	`"auto" \| "iterm2" \| "kitty" \| "ascii"`	`"auto"`
`alt`	`string`	-

Help Keyboard Shortcuts

On This Page

Installation Usage API Reference Image

Edit this page Follow @shadcnlabs Join community