Installation

Requirements

Node.js 20+
An existing project using Ink v6+
TypeScript (recommended)

Adding components

InkUI uses a copy-paste model — there is no package to install. Run the CLI to add components directly to your project:

npx inkui add spinner
npx inkui add table select
npx inkui add spinner badge progress-bar

This copies the component source into ./components/ui/ in your project. You own it.

Manual install (package)

If you prefer, every component is also published to npm:

npm install @inkui-cli/spinner
# or
pnpm add @inkui-cli/spinner

Then import directly:

import { Spinner } from '@inkui-cli/spinner';

Peer dependencies

All components require these in your project:

npm install ink react
npm install -D @types/react typescript

Project setup (if starting fresh)

mkdir my-cli && cd my-cli
npm init -y
npm install ink react
npm install -D typescript @types/react tsx
 
npx inkui add spinner table select

Create src/app.tsx:

import React from 'react';
import { render } from 'ink';
import { Spinner } from './components/ui/spinner';
 
function App() {
  return <Spinner label="Starting..." />;
}
 
render(<App />);

Run with:

npx tsx src/app.tsx

Requirements

Adding components

Manual install (package)

Peer dependencies

Project setup (if starting fresh)

On this page