{"id":13814590,"url":"https://github.com/dtinth/ttycast","last_synced_at":"2025-04-07T12:10:24.912Z","repository":{"id":3844782,"uuid":"4928613","full_name":"dtinth/ttycast","owner":"dtinth","description":"Broadcast your tty to the world! Stream your live terminal session online. Powered by ttyrec, tty.js and Socket.IO","archived":false,"fork":false,"pushed_at":"2015-12-23T13:17:05.000Z","size":119,"stargazers_count":430,"open_issues_count":6,"forks_count":23,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-03-31T11:04:14.189Z","etag":null,"topics":["nodejs","socket-io"],"latest_commit_sha":null,"homepage":"http://me.dt.in.th/page/ttycast","language":"JavaScript","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/dtinth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-07-06T17:38:21.000Z","updated_at":"2024-11-21T11:44:12.000Z","dependencies_parsed_at":"2022-08-27T16:50:57.828Z","dependency_job_id":null,"html_url":"https://github.com/dtinth/ttycast","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtinth%2Fttycast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtinth%2Fttycast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtinth%2Fttycast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dtinth%2Fttycast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dtinth","download_url":"https://codeload.github.com/dtinth/ttycast/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247648977,"owners_count":20972945,"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","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":["nodejs","socket-io"],"created_at":"2024-08-04T04:02:20.392Z","updated_at":"2025-04-07T12:10:24.893Z","avatar_url":"https://github.com/dtinth.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"ttycast: broadcast your tty!\n============================\n\nThis app allows you to broadcast your tty online, in really real time! Powered by:\n\n * [headless-terminal](https://github.com/dtinth/headless-terminal) - headless\n   terminal emulator, forked from [tty.js](https://github.com/chjj/tty.js).\n * [socket.io](http://socket.io/) - for real time communication\n * [ttyrec](http://0xcc.net/ttyrec/index.html.en) - a tty recorder (and the [JavaScript port](https://github.com/jedi4ever/ttyrec.js))\n * and also thanks to [Connect](http://www.senchalabs.org/connect/).\n\n\u003cimg src=\"http://i.imgur.com/YBobVKm.png\" alt=\"ttycast\"\u003e\n\n\nPrerequisites\n-------------\n\nInstall ttyrec and ttycast:\n\n    npm install -g ttyrec ttycast\n\n* The above command installs the [JavaScript port of ttyrec](https://github.com/jedi4ever/ttyrec.js), which is fairly new. If it does not work, you can also try the [native ttyrec](http://0xcc.net/ttyrec/index.html.en), which is available in most package managers (apt-get, Homebrew, ...).\n\n\nRunning (Broadcast \u0026 Record)\n-------\n\nFirst, set your terminal to the size that you prefer to broadcast, then run the script:\n\n    ttyreccast outfile.tty\n\nOpen your browser and navigate to the server. You should see a blank black screen.\n\n    http://localhost:13377/\n\nThen, open a new terminal of __the same size__ and run this command:\n\n    reset \u0026\u0026 ttyrec /tmp/ttycast\n\nYou should see your terminal screen on the web browser now. Recorded output goes into `outfile.tty`.\n\n\n\nChanging Port\n-------------\n\nttycast uses the PORT environment variable but the default port is 13377\n\n\n\nRunning (manual way)\n--------------------\n\nIn your terminal emulator, create a named pipe and pipe it using `ttyplay -n` to ttycast.\n\n    mkfifo /tmp/ttycast \u0026\u0026 ttyplay -n /tmp/ttycast | ttycast -s 80x25; rm /tmp/ttycast\n\nOpen your browser and navigate to the server.\n\n    http://localhost:13377/\n\nThen, spawn a new 80x25 terminal window and start recording:\n\n    reset \u0026\u0026 ttyrec /tmp/ttycast\n\nThen you should see characters appearing in real-time. After using, don't forget to `rm /tmp/ttycast`!\n\n\n\nPiping Via SSH\n--------------\n\nYou can install ttycast on your server somewhere, and pipe your\nlocal terminal there through SSH!\n\nGood when you are behind a firewall.\n\n    ttyplay -n /tmp/ttycast | ssh myserver.dt.in.th PORT=12345 ttycast\n\n\n\nPipe Anything\n-------------\n\nUm you can pipe anything that a terminal can understand to ttycast, and it will be broadcasted.\n\n    brew install sl\n    { while true; do sl 2\u003e\u00261; done } | ttycast\n\n\u003cimg src=\"http://i.imgur.com/7pQoN.png\" alt=\"sl!!\"\u003e\n\n\n\nLicense\n-------\n\nThe MIT license\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdtinth%2Fttycast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdtinth%2Fttycast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdtinth%2Fttycast/lists"}