Technical Documentation: tsl0922/ttyd
ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference
Overview (`README.md`)
ttyd - Share your terminal over the web
ttyd is a simple command-line tool for sharing terminal over the web.
Features
- Built on top of libuv and WebGL2 for speed
- Fully-featured terminal with CJK and IME support
- ZMODEM (lrzsz) / trzsz file transfer support
- Sixel image output support (img2sixel / lsix)
- SSL support based on OpenSSL / Mbed TLS
- Run any custom command with options
- Basic authentication support and many other custom options
- Cross platform: macOS, Linux, FreeBSD/OpenBSD, OpenWrt, Windows
Installation
Install on macOS
Install on Linux
- Install on Debian/Ubuntu:
sudo apt install ttyd - Install the snap:
sudo snap install ttyd --classic - Install on OpenWrt:
opkg install ttyd - Install on Gentoo: clone the repo and follow the directions here.
- Install with Homebrew :
brew install ttyd - Precompiled static binaries: download from the releases page
Install on Windows
- Binary version (recommended): download from the releases page
- Install with WinGet:
winget install tsl0922.ttyd - Install with Scoop:
scoop install ttyd - Compile on Windows
Usage
Command-line Options
text
/* Detailed source-code truncated for AI context efficiency. */Read the example usage on the wiki.
Browser Support
Modern browsers, See Browser Support.
Alternatives
Overview (`html/README.md`)
Prerequisites
NOTE: yarn v2 is required.
Install Yarn, and run: yarn install.
Development
- Start ttyd:
ttyd bash - Start the dev server:
yarn run start
Publish
Run yarn run build, this will compile the inlined html to ../src/html.h.
Overview (`man/README.md`)
Building the man page
bash
go get github.com/cpuguy83/go-md2man
go-md2man < ttyd.man.md > ttyd.1--- METRICS ---
- Files Extracted: 3
- Estimated Token Budget: ~827 tokens
- Canonical Reference: https://codewiki.google/github.com/tsl0922/ttyd