terminal / README.md
ghostdrive1's picture
Update README.md
f968e40 verified
|
Raw
History Blame Contribute Delete
1.51 kB
---
title: "HF Terminal"
colorFrom: "green"
colorTo: "gray"
sdk: "docker"
pinned: false
---
# HF Terminal
Real Bash shell in your browser via WebSocket + PTY. CRT-style skeuomorphic UI with scanlines, phosphor glow, and screen curvature.
## Features
- Real Bash shell β€” supports `nano`, `vim`, `htop`, full ANSI colour
- WebSocket transport β€” zero polling, instant keystrokes
- Skeuomorphic CRT UI β€” scanlines, glow, curvature, flicker
- Three phosphor modes β€” Green, Amber, White
- Persistent bash history to `/data`
## Architecture
| Layer | Technology |
|-----------|-----------------------------------------|
| Backend | Python 3.11 + Tornado (HTTP + WebSocket)|
| PTY | `pty.fork()` + non-blocking `select()` |
| Frontend | xterm.js 5.3 (CDN), vanilla JavaScript |
| Styling | Hand-crafted CSS β€” no frameworks |
| Container | Docker (Debian slim + common CLI tools) |
## Controls
| Control | Description |
|-------------|--------------------------------------------------|
| Phosphor | Switch between Green, Amber, and White phosphor |
| Scanlines | Toggle CRT scanline overlay |
| Glow | Toggle text glow and bloom effect |
| Curvature | Toggle CRT screen curvature effect |
| Bell | Toggle audible bell on `\x07` (default: off) |
**Keyboard shortcut:** `Ctrl+Shift+K` clears the terminal buffer.
## License
MIT