Registry

The termcn registry ships Ink and OpenTUI components, hooks, providers, and themes in the shadcn registry format. Register the namespace once in components.json, then pull items by name with the CLI.

Setup

Add a registries entry for this site. See the shadcn registry documentation for all components.json fields and behaviors.

Copy{
  "registries": {
    "@termcn": "https://termcn.dev/r/{name}.json"
  }
}

You can replace @termcn with another namespace; it only needs to match what you pass to shadcn add.

Usage

Items are namespaced by base: ink/ for Ink and opentui/ for OpenTUI.

Registry files follow these destinations:

• Components install into components/ui/.
• Hooks install into the configured hooks/ directory.
• Theme, motion, and Unicode providers install into providers/.
• Themes install into lib/terminal-themes/.

Components declare their hook dependencies, so installing a component does not install or require a provider.

Ink

Install a component:

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @termcn/ink/spinner
Copy

Install a theme:

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @termcn/ink/theme-dracula
Copy

Install the theme provider:

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @termcn/ink/theme-provider
Copy

Install the motion provider:

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @termcn/ink/motion-provider
Copy

Install the unicode provider:

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @termcn/ink/unicode-provider
Copy

Without a registry alias, use the full URL (as on each docs page):

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add https://termcn.dev/r/ink/spinner.json
Copy

OpenTUI

Install a component:

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @termcn/opentui/spinner
Copy

Install a theme:

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @termcn/opentui/theme-dracula
Copy

Install the theme provider:

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @termcn/opentui/theme-provider
Copy

Install the motion provider:

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @termcn/opentui/motion-provider
Copy

Install the unicode provider:

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add @termcn/opentui/unicode-provider
Copy

Without a registry alias, use the full URL (as on each docs page):

bunnpmpnpmyarn
$ pnpm dlx shadcn@latest add https://termcn.dev/r/opentui/spinner.json
Copy