Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 873 Commits
.github		.github
cmake		cmake
html		html
man		man
scripts		scripts
snap		snap
src		src
.clang-format		.clang-format
.gitattributes		.gitattributes
.gitignore		.gitignore
CMakeLists.txt		CMakeLists.txt
Dockerfile		Dockerfile
Dockerfile.alpine		Dockerfile.alpine
LICENSE		LICENSE
README.md		README.md
app.rc.in		app.rc.in
screenshot.gif		screenshot.gif

Repository files navigation

ttyd - Share your terminal over the web

ttyd is a simple command-line tool for sharing terminal over the web.

Features

Built on top oflibuv andWebGL2 for speed
Fully-featured terminal withCJK and IME support
ZMODEM (lrzsz) /trzsz file transfer support
Sixel image output support (img2sixel /lsix)
SSL support based onOpenSSL /Mbed TLS
Run any custom command with options
Basic authentication support and many other custom options
Cross platform: macOS, Linux, FreeBSD/OpenBSD,OpenWrt, Windows

❤ Special thanks toJetBrains for sponsoring the opensource license to this project.

Installation

Install on macOS

Install withHomebrew:brew install ttyd
Install withMacPorts:sudo port install ttyd

Install on Linux

Binary version (recommended): download from thereleases page
Install withHomebrew :brew install ttyd
Install the snap:sudo snap install ttyd --classic

Build from source (debian/ubuntu):

sudo apt-get updatesudo apt-get install -y build-essential cmake git libjson-c-dev libwebsockets-devgit clone https://github.com/tsl0922/ttyd.gitcd ttyd&& mkdir build&&cd buildcmake ..make&& sudo make install

You may also need to compile/installlibwebsockets from source if thelibwebsockets-dev package is outdated.

Install on OpenWrt:opkg install ttyd
Install on Gentoo: clone therepo and follow the directionshere.

Install on Windows

Binary version (recommended): download from thereleases page
Install withWinGet:winget install tsl0922.ttyd
Install withScoop:scoop install ttyd
Compile on Windows

Usage

Command-line Options

USAGE:    ttyd [options] <command> [<arguments...>]OPTIONS:    -p, --port              Port to listen (default: 7681, use `0` for random port)    -i, --interface         Network interface to bind (eg: eth0), or UNIX domain socket path (eg: /var/run/ttyd.sock)    -U, --socket-owner      User owner of the UNIX domain socket file, when enabled (eg: user:group)    -c, --credential        Credential for basic authentication (format: username:password)    -H, --auth-header       HTTP Header name for auth proxy, this will configure ttyd to let a HTTP reverse proxy handle authentication    -u, --uid               User id to run with    -g, --gid               Group id to run with    -s, --signal            Signal to send to the command when exit it (default: 1, SIGHUP)    -w, --cwd               Working directory to be set for the child program    -a, --url-arg           Allow client to send command line arguments in URL (eg: http://localhost:7681?arg=foo&arg=bar)    -W, --writable          Allow clients to write to the TTY (readonly by default)    -t, --client-option     Send option to client (format: key=value), repeat to add more options    -T, --terminal-type     Terminal type to report, default: xterm-256color    -O, --check-origin      Do not allow websocket connection from different origin    -m, --max-clients       Maximum clients to support (default: 0, no limit)    -o, --once              Accept only one client and exit on disconnection    -q, --exit-no-conn      Exit on all clients disconnection    -B, --browser           Open terminal with the default system browser    -I, --index             Custom index.html path    -b, --base-path         Expected base path for requests coming from a reverse proxy (eg: /mounted/here, max length: 128)    -P, --ping-interval     Websocket ping interval(sec) (default: 5)    -6, --ipv6              Enable IPv6 support    -S, --ssl               Enable SSL    -C, --ssl-cert          SSL certificate file path    -K, --ssl-key           SSL key file path    -A, --ssl-ca            SSL CA file path for client certificate verification    -d, --debug             Set log level (default: 7)    -v, --version           Print the version and exit    -h, --help              Print this text and exit

Read the example usage on thewiki.