Installation

Requirements

• Node.js 18+ or Bun 1.0+
• React 18+

Install inkx

bun

bun add inkx

npm

npm install inkx

yarn

yarn add inkx

pnpm

pnpm add inkx

TypeScript Support

inkx includes TypeScript definitions out of the box. No additional @types packages needed.

// tsconfig.json
{
  "compilerOptions": {
    "jsx": "react-jsx",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "strict": true
  }
}

Running Your App

inkx apps are just TypeScript/JavaScript files. Run them directly:

bun

bun run app.tsx

tsx

npx tsx app.tsx

ts-node

npx ts-node --esm app.tsx

Testing inkx Apps

inkx includes a testing library with auto-cleanup between renders:

import { createRenderer } from "inkx/testing"
import { Text } from "inkx"

const render = createRenderer()

test("renders hello", () => {
  const { lastFrame } = render(<Text>Hello</Text>)
  expect(lastFrame()).toContain("Hello")
})

test("renders world", () => {
  // Previous render is auto-cleaned when render() is called again
  const { lastFrame } = render(<Text>World</Text>)
  expect(lastFrame()).toContain("World")
})