-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathllms.txt
More file actions
36 lines (24 loc) · 2.91 KB
/
Copy pathllms.txt
File metadata and controls
36 lines (24 loc) · 2.91 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# terminaltui
> terminaltui is a TypeScript framework for building interactive terminal websites and applications with file-based screen routing, 42 components, themes, images, video, API routes, headless testing, npm distribution, and SSH hosting.
Current release: 2.1.0. License: MIT. Runtime: Node.js 18 or newer, ESM only.
The canonical rendering proof is a three-second, 24-frame recording of the bundled Cinema demo running in Kitty on macOS, not a browser mock-up. terminaltui sends real pixels through the Kitty graphics protocol on Kitty and Ghostty; Apple Terminal, tmux, SSH, and other terminals receive a coloured Unicode-cell fallback with the same geometry. Run it with `npx terminaltui demo cinema`. Raw video is packed once into a `.tvf` frame pack; ffmpeg is needed at pack time for common video formats, not at runtime.
terminaltui routes interactive terminal screens. It is not a React renderer, a CLI subcommand router, or a browser-in-terminal project.
## Product
- [Homepage](https://terminaltui.dev/): product overview, quick start, architecture, and benchmarks.
- [Real image and video rendering proof](https://terminaltui.dev/video/): real Kitty recording, rendering paths, measurements, and reproducible Cinema command.
- [Demo gallery](https://terminaltui.dev/demos/): real cell-grid captures from apps that ship in the package.
- [v2.1.0 release](https://github.com/OmarMusayev/terminaltui/releases/tag/v2.1.0): release notes and tagged source.
## Documentation
- [Documentation index](https://terminaltui.dev/docs/): guides for routing, components, layouts, state, testing, images, video, and deployment.
- [Video documentation](https://terminaltui.dev/docs/video/): TVF packing, playback, controls, bandwidth, and testing.
- [Image documentation](https://terminaltui.dev/docs/images/): Kitty/Ghostty pixel rendering and the portable coloured-cell tier ladder.
- [Changelog](https://github.com/OmarMusayev/terminaltui/blob/main/CHANGELOG.md): release history and migration notes.
## Code and agent references
- [GitHub repository](https://github.com/OmarMusayev/terminaltui): source, examples, tests, and repository history.
- [npm package](https://www.npmjs.com/package/terminaltui): installable `terminaltui` release.
- [AGENTS.md](https://github.com/OmarMusayev/terminaltui/blob/main/AGENTS.md): project identity, repository map, and source-of-truth rules.
- [claude/SKILL.md](https://github.com/OmarMusayev/terminaltui/blob/main/claude/SKILL.md): long-form API reference designed for code-generation agents.
- [Cinema demo source](https://github.com/OmarMusayev/terminaltui/tree/main/demos/cinema): reproducible application shown in the recording.
## Optional
- [Direct MP4 recording](https://terminaltui.dev/media/terminaltui-kitty-video.mp4): 1920×1132, 3 seconds, 8 fps, 24 frames, silent.
- [Poster image](https://terminaltui.dev/media/terminaltui-kitty-video-poster.jpg): still image used in the site, README, and social metadata.