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.

Git Status

Git status display (branch, staged, modified, ahead/behind)

Terminal

git-status-demo

No opentui live preview is registered for this example yet.

Installation


$ pnpm dlx shadcn@latest add @termcn/git-status

Usage

import { GitStatus } from "@/components/ui/git-status";

<GitStatus branch="main" staged={2} modified={5} ahead={1} behind={0} />

API Reference

GitStatus

Prop	Type	Default
`branch`	`string`	`required`
`staged`	`number`	`0`
`modified`	`number`	`0`
`ahead`	`number`	`0`
`behind`	`number`	`0`

Directory Tree JSON

On This Page

Installation Usage API Reference GitStatus

Edit this page Follow @shadcnlabs Join community