{"id":18400689,"url":"https://github.com/databricks/databricks-ttyd","last_synced_at":"2025-08-11T05:04:22.819Z","repository":{"id":37966721,"uuid":"395073180","full_name":"databricks/databricks-ttyd","owner":"databricks","description":null,"archived":false,"fork":false,"pushed_at":"2023-08-28T11:12:38.000Z","size":11509,"stargazers_count":6,"open_issues_count":11,"forks_count":8,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-08-10T00:34:42.632Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/databricks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-11T17:49:32.000Z","updated_at":"2023-12-23T07:12:58.000Z","dependencies_parsed_at":"2024-11-06T03:04:28.481Z","dependency_job_id":"2b7852e0-88de-49eb-a6a5-c5610086df2b","html_url":"https://github.com/databricks/databricks-ttyd","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/databricks/databricks-ttyd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databricks%2Fdatabricks-ttyd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databricks%2Fdatabricks-ttyd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databricks%2Fdatabricks-ttyd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databricks%2Fdatabricks-ttyd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/databricks","download_url":"https://codeload.github.com/databricks/databricks-ttyd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/databricks%2Fdatabricks-ttyd/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269832882,"owners_count":24482330,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T02:36:03.595Z","updated_at":"2025-08-11T05:04:22.768Z","avatar_url":"https://github.com/databricks.png","language":"C","readme":"![backend](https://github.com/tsl0922/ttyd/workflows/backend/badge.svg) ![frontend](https://github.com/tsl0922/ttyd/workflows/frontend/badge.svg) [![Packaging status](https://repology.org/badge/tiny-repos/ttyd.svg)](https://repology.org/project/ttyd/versions)\n\n# ttyd - Share your terminal over the web\n\nttyd is a simple command-line tool for sharing terminal over the web.\n\n![screenshot](https://github.com/tsl0922/ttyd/raw/main/screenshot.gif)\n\n# Features\n\n- Built on top of [Libwebsockets](https://libwebsockets.org) with [libuv](https://libuv.org) for speed\n- Fully-featured terminal based on [Xterm.js](https://xtermjs.org) with [CJK](https://en.wikipedia.org/wiki/CJK_characters) and IME support\n- Graphical [ZMODEM](https://en.wikipedia.org/wiki/ZMODEM) integration with [lrzsz](https://ohse.de/uwe/software/lrzsz.html) support\n- SSL support based on [OpenSSL](https://www.openssl.org)\n- Run any custom command with options\n- Basic authentication support and many other custom options\n- Cross platform: macOS, Linux, FreeBSD/OpenBSD, [OpenWrt](https://openwrt.org), Windows\n\n\u003e ❤ Special thanks to [JetBrains](https://www.jetbrains.com/?from=ttyd) for sponsoring the opensource license to this project.\n\n# Installation\n\n## Install on macOS\n\nInstall with [homebrew](http://brew.sh):\n\n```bash\nbrew install ttyd\n```\n\n## Install on Linux\n\n- Binary version (recommended): download from the [releases](https://github.com/tsl0922/ttyd/releases) page.\n- Build from source (debian/ubuntu):\n\n    ```bash\n    sudo apt-get install build-essential cmake git libjson-c-dev libwebsockets-dev\n    git clone https://github.com/tsl0922/ttyd.git\n    cd ttyd \u0026\u0026 mkdir build \u0026\u0026 cd build\n    cmake ..\n    make \u0026\u0026 sudo make install\n    ```\n\n    You may also need to compile/install [libwebsockets](https://libwebsockets.org) from source if the `libwebsockets-dev` package is outdated.\n\n- Install on Gentoo: clone the [repo](https://bitbucket.org/mgpagano/ttyd/src/master) and follow the directions [here](https://wiki.gentoo.org/wiki/Custom_repository#Creating_a_local_repository).\n\n## Install on Windows\n\n[Compile on Windows](https://github.com/tsl0922/ttyd/wiki/Compile-on-Windows).\n\n## Install on OpenWrt\n\n```bash\nopkg install ttyd\n```\n\n# Usage\n\n## Command-line Options\n\n```\nttyd is a tool for sharing terminal over the web\n\nUSAGE:\n    ttyd [options] \u003ccommand\u003e [\u003carguments...\u003e]\n\nVERSION:\n    1.6.3\n\nOPTIONS:\n    -p, --port              Port to listen (default: 7681, use `0` for random port)\n    -i, --interface         Network interface to bind (eg: eth0), or UNIX domain socket path (eg: /var/run/ttyd.sock)\n    -c, --credential        Credential for Basic Authentication (format: username:password)\n    -u, --uid               User id to run with\n    -g, --gid               Group id to run with\n    -s, --signal            Signal to send to the command when exit it (default: 1, SIGHUP)\n    -a, --url-arg           Allow client to send command line arguments in URL (eg: http://localhost:7681?arg=foo\u0026arg=bar)\n    -f, --arg-file          File prefix for a unique generated temp file that URL arguments are written to (ex. /tmp/prefix); the generated file's full path is then passed in as a command line argument (ex. /tmp/prefix{unique string})\n    -R, --readonly          Do not allow clients to write to the TTY\n    -t, --client-option     Send option to client (format: key=value), repeat to add more options\n    -T, --terminal-type     Terminal type to report, default: xterm-256color\n    -O, --check-origin      Do not allow websocket connection from different origin\n    -m, --max-clients       Maximum clients to support (default: 0, no limit)\n    -o, --once              Accept only one client and exit on disconnection\n    -B, --browser           Open terminal with the default system browser\n    -I, --index             Custom index.html path\n    -b, --base-path         Expected base path for requests coming from a reverse proxy (eg: /mounted/here, max length: 128)\n    -P, --ping-interval     Websocket ping interval(sec) (default: 300)\n    -6, --ipv6              Enable IPv6 support\n    -S, --ssl               Enable SSL\n    -C, --ssl-cert          SSL certificate file path\n    -K, --ssl-key           SSL key file path\n    -A, --ssl-ca            SSL CA file path for client certificate verification\n    -d, --debug             Set log level (default: 7)\n    -v, --version           Print the version and exit\n    -h, --help              Print this text and exit\n\nVisit https://github.com/tsl0922/ttyd to get more information and report bugs.\n```\n\nRead the example usage on the [wiki](https://github.com/tsl0922/ttyd/wiki/Example-Usage).\n\n## Browser Support\n\nModern browsers, See [Browser Support](https://github.com/xtermjs/xterm.js#browser-support).\n\n## Alternatives\n\n* [Wetty](https://github.com/krishnasrinivas/wetty): [Node](https://nodejs.org) based web terminal (SSH/login)\n* [GoTTY](https://github.com/yudai/gotty): [Go](https://golang.org) based web terminal\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatabricks%2Fdatabricks-ttyd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatabricks%2Fdatabricks-ttyd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatabricks%2Fdatabricks-ttyd/lists"}