# Terminal Simulator

CLI build simulation with chunked log output and step-function scrolling.

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).

## Installation

<TabsTrigger value="cli">Command</TabsTrigger>
<TabsTrigger value="manual">Manual</TabsTrigger>

```bash
npx shadcn@latest add @framecn/terminal-simulator
```

<Step>Copy and paste the following code into your project.</Step>

<Step>Update the import paths to match your project setup.</Step>

## Usage

```tsx
import { TerminalSimulator } from "@/components/framecn/terminal-simulator";
```

```tsx
<TerminalSimulator />
```

## API Reference

### TerminalSimulator

| Prop               | Type             | Default                |
| ------------------ | ---------------- | ---------------------- |
| `lines`            | `TerminalLine[]` | `DEFAULT_LINES`        |
| `prompt`           | `string`         | `"$"`                  |
| `title`            | `string`         | `"~/projects/framecn"` |
| `background`       | `string`         | `"#0a0a0a"`            |
| `chromeColor`      | `string`         | `"#1a1a1a"`            |
| `fontSize`         | `number`         | `18`                   |
| `charsPerFrame`    | `number`         | `1`                    |
| `chunkSize`        | `number`         | `1`                    |
| `speed`            | `number`         | `1`                    |
| `fps`              | `number`         | `30`                   |
| `durationInFrames` | `number`         | `200`                  |
| `className`        | `string`         | `-`                    |

## Notes

  Commands type out character-by-character with chunked log output. The terminal
  auto-scrolls as new content appears.