Skip to content
akshaykmrPublic

About

Stream and share terminals over the web. Show off mad cli-fu, help a colleague, teach, or troubleshoot. end-to-end encrypted 🛡

Topics

Resources

Stars

135 stars

Watchers

6 watching

Forks

Repository files navigation

TeleType

cli tool that allows you to share your terminal online conveniently. Check out SupaKit - show off mad cli-fu, help a colleague, teach, or troubleshoot.

Version Downloads/week Follow

image

Your stream can be view-only or collaboration enabled (command-line flag).

Install and stream!

  • You'll need Node 24.15.0 or newer. CLI is available via npm.
    You can setup node/npm from here.

  • Package does fail on some systems because of node-pty compilation failures. I'm thinking it's better to package the whole thing as a binary in future releases (i.e. not available via npm but via a script or manual install).

  • macOS: if teletype crashes with Error: posix_spawnp failed., node-pty may have installed its helper without execute permissions (node-pty#850). This should be fixed by a newer node-pty release. Workaround: chmod +x "$(npm root -g)"/oorja/node_modules/node-pty/prebuilds/darwin-*/spawn-helper

  • npm install -g oorja

  • teletype

  • teletype -m (for collaboration mode)

You can also run Teletype without a global install:

npx oorja@latest teletype

To create a new anonymous stream:

npx oorja@latest teletype --new --anonymous

Add --multiplayer to allow viewers to control the shell. For CI debugging:

npx --yes oorja@latest teletype --ci-debug

--ci-debug creates an anonymous writable terminal stream and prints its link. The CI step stays running until the shell exits. --yes skips npm's installation prompt.

your stream is end-to-end encrypted

PRO TIP: Any 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!

For options: teletype -h

Note This is the cli companion for SupaKit which is a privacy focussed collaboration tool with more features like voice, notes, and chat - privacy policy. TLDR: Your data is end-to-end encrypted, no prying eyes 🍻.

Like it ? follow or tweet, tell your colleagues 👩🏻‍💻

Open issues.

More ways to contact.

Commands

oorja teletype [STREAMKEY]

Launch a terminal streaming session in SupaKit.

USAGE
  $ oorja teletype [STREAMKEY] [-h] [-s <value>] [-m] [--multishell] [-n] [--anonymous] [--ci-debug]
    [--streaming-indicator enabled|disabled] [--harness-host]

FLAGS
  -h, --help                          Show CLI help.
  -m, --multiplayer                   Allow space participants to type into and control this shell.
  -n, --new                           Create a new space
  -s, --shell=<value>                 shell to use. e.g. bash, fish
      --anonymous                     Create an anonymous session without prompting for sign-in.
      --ci-debug                      Create a new anonymous writable bash stream for CI debugging.
      --harness-host                  Allow this machine to run agent sessions for this space.
      --multishell                    Allow this CLI session to host multiple terminal shells. Off by default
      --streaming-indicator=<option>  [default: enabled] Prefix the shell prompt with a streaming indicator.
                                      <options: enabled|disabled>

DESCRIPTION
  Launch a terminal streaming session in SupaKit.

ALIASES
  $ oorja tty

EXAMPLES
  $ teletype
  Will prompt to choose streaming destination - either enter a stream key for an existing space or create a new space.

  $ teletype 'sk-xxxx:space-id#encryption-secret'
  Will stream to the space using the secret stream-key. NOTE: stream-keys are personal (generated for you in the teletype app at supakit.app), do not accept them from other people, nor should
  you share your stream-keys with others.

  $ teletype --multiplayer
  Will also allow participants to write to your terminal! Collaboration mode must be explicitly enabled.

  $ teletype --multishell
  Allows this CLI session to host multiple terminal shells as tabs in the web app.
  In this mode, shells are controlled from the web app rather than the local terminal.

  $ teletype --ci-debug
  Creates a new anonymous stream without prompting for sign-in. Useful for CI debug sessions you want to control from the link.

oorja signout

Sign out of SupaKit. Clears saved auth-token

USAGE
  $ oorja signout

DESCRIPTION
  Sign out of SupaKit. Clears saved auth-token

oorja help [COMMAND]

Display help for oorja.

USAGE
  $ oorja help [COMMAND...] [-n]

ARGUMENTS
  [COMMAND...]  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for oorja.

oorja harness-host [STREAMKEY]

Run agents on this computer from SparkChat in a SupaKit space.

USAGE
  $ oorja harness-host [STREAMKEY] [-m]

ARGUMENTS
  [STREAMKEY]  Secret stream key for the target space

FLAGS
  -m, --multiplayer  Allow space participants to run agents on this computer.

DESCRIPTION
  Run agents on this computer from SparkChat in a SupaKit space.

oorja harness-host:doctor

Check prerequisites and discover available agent models.

USAGE
  $ oorja harness-host:doctor [--json] [--timeout <value>]

FLAGS
  --json             Print machine-readable JSON.
  --timeout=<value>  [default: 30] Maximum seconds for model discovery per agent.

DESCRIPTION
  Check prerequisites and discover available agent models.

oorja harness-host:prepare [RUNTIMES]

Set up agent runtimes on this machine.

USAGE
  $ oorja harness-host:prepare [RUNTIMES...]

ARGUMENTS
  [RUNTIMES...]  (all|codex|claude-code|opencode|pi) [default: all] Agent runtimes to set up; use all to set up every
                 supported runtime

DESCRIPTION
  Set up agent runtimes on this machine.

About

Stream and share terminals over the web. Show off mad cli-fu, help a colleague, teach, or troubleshoot. end-to-end encrypted 🛡

Topics

Resources

Stars

135 stars

Watchers

6 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages