Skip to main content

InteractiveTerminal

Surfacesterminal

Streaming terminal surface for agent shell output, with an optional input line.

import { InteractiveTerminal } from "@elabs-ai/components-terminal";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-terminal

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt for your coding agent

Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.

Add the brand-ui InteractiveTerminal component (from @elabs-ai/components-terminal) to this project.

1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`.
2. Look InteractiveTerminal up before writing code: `npx -y @elabs-ai/components-cli docs InteractiveTerminal` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-terminal is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-terminal` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-terminal`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`.
4. Use it here: [the screen or file, and what it should show]
5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop.
6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.

Avoid

  • Spawning a shell or process from the component — it renders a stream; the app owns the runtime (D5).
  • Looking for an isStreaming/output prop — this surface is imperative: hold the InteractiveTerminalHandle ref and call write() per chunk (the declarative sibling is Terminal).
  • Reaching the terminal engine through a static import — heavy engines must be reached by a dynamic import() (the heavy-deps ratchet).

Works with

Pairs with

Examples

2 live examples

Read-only (log)

`readOnly` degrades the terminal to the existing log use case: `write()` still renders ANSI output, but stdin is disabled and no `onData` fires.

API

InteractiveTerminal

PropTypeDescription
onData(data: string) => voidKeystrokes + paste → process. The PTY/process stays consumer-owned.
onResize(size: { cols: number; rows: number }) => voidFires whenever the container resizes and cols/rows are refit.
readOnlybooleanDegrades to a read-only log: writes still render, stdin is disabled.
fontSizenumberTerminal font size in px. Defaults to `13` (matches `CodeEditor`).

Also accepts: Omit<HTMLAttributes<HTMLDivElement>, "onResize">

Theming

The tokens each state resolves to. Change the token and every theme follows.

StateToken
streamingimperative — ref.current.write(chunk) as output arrives (no isStreaming prop)
readOnlyreadOnly → stdin disabled, writes still render (read-only log)