{"id":13902892,"url":"https://github.com/akshaykmr/teletype","last_synced_at":"2025-04-05T01:03:33.660Z","repository":{"id":57314947,"uuid":"286348689","full_name":"akshaykmr/teletype","owner":"akshaykmr","description":"Stream and share terminals over the web. Show off mad cli-fu, help a colleague, teach, or troubleshoot. end-to-end encrypted 🛡","archived":false,"fork":false,"pushed_at":"2025-03-27T21:47:21.000Z","size":776,"stargazers_count":115,"open_issues_count":3,"forks_count":6,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-29T00:04:56.806Z","etag":null,"topics":["cli","collaboration","command-line","e2ee","end-to-end-encryption","private","sharing","teletype","terminal","vim"],"latest_commit_sha":null,"homepage":"https://oorja.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akshaykmr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"license.txt","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},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://oorja.io"]}},"created_at":"2020-08-10T01:32:54.000Z","updated_at":"2025-03-27T21:47:26.000Z","dependencies_parsed_at":"2023-02-12T11:45:30.961Z","dependency_job_id":"c89df4f7-847d-436a-b2dc-d1398b79fc1c","html_url":"https://github.com/akshaykmr/teletype","commit_stats":{"total_commits":224,"total_committers":1,"mean_commits":224.0,"dds":0.0,"last_synced_commit":"e3f3d1c7e0fd8197baa1acc419aa6e2be0a19024"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akshaykmr%2Fteletype","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akshaykmr%2Fteletype/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akshaykmr%2Fteletype/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akshaykmr%2Fteletype/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akshaykmr","download_url":"https://codeload.github.com/akshaykmr/teletype/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247271515,"owners_count":20911587,"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":["cli","collaboration","command-line","e2ee","end-to-end-encryption","private","sharing","teletype","terminal","vim"],"created_at":"2024-08-06T22:01:29.097Z","updated_at":"2025-04-05T01:03:33.643Z","avatar_url":"https://github.com/akshaykmr.png","language":"TypeScript","funding_links":["https://oorja.io"],"categories":["cli"],"sub_categories":[],"readme":"TeleType\n=====\n\ncli tool that allows you to share your terminal online conveniently. Check out [oorja.io](https://oorja.io) - show off mad cli-fu, help a colleague, teach, or troubleshoot.\n\n[![Version](https://img.shields.io/npm/v/oorja.svg)](https://npmjs.org/package/oorja)\n[![Downloads/week](https://img.shields.io/npm/dw/oorja.svg)](https://npmjs.org/package/oorja)\n[![Follow](https://img.shields.io/twitter/follow/oorja_app?style=social)](https://twitter.com/oorja_app)\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"600\" src=\"https://oorja.io/images/cli-demo.svg\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://oorja.io/images/teletype-session.png\"\u003e\n\u003c/p\u003e\n\nYour stream can be view-only or collaboration enabled (command-line flag).\n\n\n\u003c!-- toc --\u003e\n* [Install and stream!](#install-and-stream)\n* [Commands](#commands)\n\u003c!-- tocstop --\u003e\n\n# Install and stream!\n\n- You'll need Node 22.10.0 \u003e. CLI is available via npm. \u003cbr /\u003e\n  \u003ca href=\"https://nodejs.org/en/download/\" target=\"_blank\"\u003e\n  You can setup node/npm from here.\n  \u003c/a\u003e \n- Package does fail on some systems because of node-pty compilation failures. I'm thinking it's better to package the whole thing\nas a binary in future releases (i.e. not available via npm but via a script or manual install).\n\n- `npm install -g oorja`\n- `teletype`\n- `teletype -m`  (for collaboration mode)\n\nMisc: If you have issues installing on apple M1 or similar systems:\n- `sudo xcode-select --install`\n- `CXXFLAGS=\"--std=c++17\" npm install -g oorja`\n\n**your stream is end-to-end encrypted**\n\n**PRO TIP:**\nAny participant in the room can stream their terminal(s) i.e there can be multiple streams at the same time, and you can switch between them like terminal tabs!\n\nFor options: `teletype -h` \n\n**Note**\nThis is the cli companion for [oorja.io](https://oorja.io) which is a privacy focussed collaboration tool with more features like voice, notes, and chat - [privacy policy](https://oorja.io/privacy-policy).\nTLDR: Your data is end-to-end encrypted, no prying eyes 🍻.\n\nLike it ? [follow or tweet, tell your colleagues](https://twitter.com/oorja_app) 👩🏻‍💻\n\nOpen [issues](https://github.com/akshaykmr/TeleType/issues).\n\nMore ways to [contact](https://oorja.io/contact).\n\n\n# Commands\n\u003c!-- commands-disabled --\u003e\n* [`oorja help [COMMAND]`](#oorja-help-command)\n* [`oorja teletype [SPACE]`](#oorja-teletype-space)\n* [`oorja signout`](#oorja-signout)\n\n## `oorja help [COMMAND]`\n\nDisplay help for oorja.\n\n```\nUSAGE\n  $ oorja help [COMMAND...] [-n]\n\nARGUMENTS\n  COMMAND...  Command to show help for.\n\nFLAGS\n  -n, --nested-commands  Include all nested commands in the output.\n\nDESCRIPTION\n  Display help for oorja.\n```\n\n## `oorja teletype [SPACE_URL]`\n\nLaunch a terminal streaming session in oorja.\n\n```\nUSAGE\n  $ oorja teletype [SPACE_URL] [-h] [-s \u003cvalue\u003e] [-m] [-n]\n\nFLAGS\n  -h, --help           Show CLI help.\n  -m, --multiplex      Allows users to WRITE TO YOUR SHELL i.e enables collaboration mode. Make sure you trust space\n                       participants. Off by default\n  -n, --new_space      Create new space\n  -s, --shell=\u003cvalue\u003e  [default: /usr/bin/zsh] shell to use. e.g. bash, fish\n\nDESCRIPTION\n  Launch a terminal streaming session in oorja.\n\nALIASES\n  $ oorja tty\n\nEXAMPLES\n  $ teletype\n  Will prompt to choose streaming destination - existing space or create a new one.\n\n  $ teletype 'https://oorja.io/spaces?id=foo#key'\n  Will stream to the space specified by secret link, you must have joined the space before streaming.\n\n  $ teletype -m\n  Will also allow participants to write to your terminal!\n```\n\n## `oorja signout`\n\nSign-out of oorja. Clears saved auth-token\n\n```\nUSAGE\n  $ oorja signout\n\nDESCRIPTION\n  Sign-out of oorja. Clears saved auth-token\n```\n\n\u003c!-- commandsstop-disabled --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakshaykmr%2Fteletype","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakshaykmr%2Fteletype","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakshaykmr%2Fteletype/lists"}