Ink - React for CLIs
React for CLIs. Build and test your CLI output using components.
Ink provides the same component-based UI building experience that React offers in the browser, but for command-line apps. It uses Yoga for Flexbox layouts in the terminal.
Important: All text must be wrapped in a <Text> component.
Quick Example
import {render, Text, Box} from 'ink';
render(
<Box borderStyle="round" padding={1}>
<Text color="green">Hello World</Text>
</Box>
);
Components
<Text> - Display text with styling (color, bold, italic, underline, etc.)
<Box> - Flexbox container for layouts
- Layout Properties - dimensions, flex, spacing, alignment
- Visual Properties - borders, colors, backgrounds
<Newline> - Insert newline characters
<Spacer> - Flexible space that expands to fill available space
<Static> - Permanently render output above everything else (for logs, completed tasks)
<Transform> - Transform string representation before output
Hooks
Interaction
useInput() - Handle keyboard input (arrow keys, enter, escape, etc.)
useFocus() - Make components focusable with Tab key
useFocusManager() - Programmatically manage focus
Lifecycle & Streams
useApp() - Exit the app programmatically
useStdin() - Access stdin stream and setRawMode
useStdout() - Access stdout stream and write output
useStderr() - Access stderr stream
Accessibility
useIsScreenReaderEnabled() - Detect if screen reader is active
API
render(tree, options?) - Mount and render your app
- Instance Methods - rerender(), unmount(), waitUntilExit(), clear()
measureElement(ref) - Get width and height of a component
Guides
- Accessibility & Screen Readers - ARIA support, screen reader integration
- Testing - Test Ink components with ink-testing-library
- React DevTools - Debug with React DevTools
Third-Party Components
See references/third-party.md for a comprehensive list of community components including:
- Text inputs, spinners, select menus
- Progress bars, tables, charts
- Markdown rendering, syntax highlighting
- And many more
1---
2name: ink
3description: Build CLI applications using React. Use when creating terminal UIs, handling keyboard input, or building interactive command-line tools with React components. Supports flexbox layouts, text styling, focus management, and accessibility.
4metadata:
5 source: https://skillmd.com/skills/majiayu000/ink
6---
7
8# Ink - React for CLIs
9
10> React for CLIs. Build and test your CLI output using components.
11
12Ink provides the same component-based UI building experience that React offers in the browser, but for command-line apps. It uses [Yoga](https://github.com/facebook/yoga) for Flexbox layouts in the terminal.
13
14**Important:** All text must be wrapped in a [`<Text>`](references/text.md) component.
15
16## Quick Example
17
18```jsx
19import {render, Text, Box} from 'ink';
20
21render(
22 <Box borderStyle="round" padding={1}>
23 <Text color="green">Hello World</Text>
24 </Box>
25);
26```
27
28## Components
29
30- **[`<Text>`](references/text.md)** - Display text with styling (color, bold, italic, underline, etc.)
31- **[`<Box>`](references/box-layout.md)** - Flexbox container for layouts
32 - [Layout Properties](references/box-layout.md) - dimensions, flex, spacing, alignment
33 - [Visual Properties](references/box-styling.md) - borders, colors, backgrounds
34- **[`<Newline>`](references/spacer-newline.md)** - Insert newline characters
35- **[`<Spacer>`](references/spacer-newline.md)** - Flexible space that expands to fill available space
36- **[`<Static>`](references/static.md)** - Permanently render output above everything else (for logs, completed tasks)
37- **[`<Transform>`](references/transform.md)** - Transform string representation before output
38
39## Hooks
40
41### Interaction
42- **[`useInput()`](references/input.md)** - Handle keyboard input (arrow keys, enter, escape, etc.)
43- **[`useFocus()`](references/focus.md)** - Make components focusable with Tab key
44- **[`useFocusManager()`](references/focus.md)** - Programmatically manage focus
45
46### Lifecycle & Streams
47- **[`useApp()`](references/lifecycle.md)** - Exit the app programmatically
48- **[`useStdin()`](references/input.md)** - Access stdin stream and setRawMode
49- **[`useStdout()`](references/lifecycle.md)** - Access stdout stream and write output
50- **[`useStderr()`](references/lifecycle.md)** - Access stderr stream
51
52### Accessibility
53- **[`useIsScreenReaderEnabled()`](references/screen-reader.md)** - Detect if screen reader is active
54
55## API
56
57- **[`render(tree, options?)`](references/render.md)** - Mount and render your app
58- **[Instance Methods](references/instance.md)** - rerender(), unmount(), waitUntilExit(), clear()
59- **[`measureElement(ref)`](references/measure.md)** - Get width and height of a component
60
61## Guides
62
63- **[Accessibility & Screen Readers](references/accessibility.md)** - ARIA support, screen reader integration
64- **[Testing](references/testing.md)** - Test Ink components with ink-testing-library
65- **[React DevTools](references/devtools.md)** - Debug with React DevTools
66
67## Third-Party Components
68
69See **[references/third-party.md](references/third-party.md)** for a comprehensive list of community components including:
70- Text inputs, spinners, select menus
71- Progress bars, tables, charts
72- Markdown rendering, syntax highlighting
73- And many more