Ink Web

Quick Start

Installation

npm install ink-web xterm
yarn add ink-web xterm
pnpm add ink-web xterm
bun add ink-web xterm

Usage

import { InkTerminalBox, Box, Text } from 'ink-web'
import 'ink-web/css'
import 'xterm/css/xterm.css'

const App = () => (
  <InkTerminalBox focus>
    <Box flexDirection="column">
      <Text color="green">Hello from Ink in the browser!</Text>
    </Box>
  </InkTerminalBox>
)

Framework-Specific Guides

For detailed setup instructions for your framework:

Alternative: Standalone Installation

Alternatively, you can use the standalone version which allows more flexibility in how dependencies are managed. See the standalone installation guide for more details.

On this page