Share the terminal with your friends.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


$ share-term Donate now

Share the terminal with your friends.

It's possible to share it into another terminal or in a browser, both with request control feature.

If you enjoy using Share Term, supporting it would be really appreciated. 😄 ❤️


You can install the package globally and use it as command line tool:

$ npm i -g share-term

Then, run share-term --help and see what the CLI tool can do.

$ share-term --help
share-term --help
Share the terminal with your friends.

usage: share-term [action] [options]

  get <id> [--control]     Connect to a terminal session. If `--control`
                           options is passed, remote control will be
  welcome <host> <id>      This action is used internally when starting
                           the terminal sharing.

  -v, --version            Displays version information.
  -h, --help               Displays this help.
  -c, --control            Used to request remote control when the client
                           is connecting from a terminal.

  share-term               # Starts a shared terminal session
  share-term get <id>      # Connects to the terminal session with id <id>
  share-term get <id> -c   # Connects and asks for remote control in the
                           # terminal session with id <id>

Documentation can be found at
Support Share Term now:


🌍 Sharing the terminal

To share your terminal do:

$ share-term

You will get a session id which you will send to your friends.

🗼 Accessing a session

To join a terminal session, having the id <id> you have two ways:

  1. Open the Share Term website and enter your id there. Then click the Access button. To request remote control click the 🗼 button in the right bottom side.

  2. Having share-term installed on your computer (see Installation) you can join the session using:

    # Without remote control
    $ share-term get <id>
    # With remote control
    $ share-term get <id> -c


For full API reference, see the file.

How to contribute

Have an idea? Found a bug? See how to contribute.

Press Highlights

None yet. If you wrote or found an article about this project, add it in this section. 📝

Who uses this

If you are using this library in one of your projects, add it in this list.


KINDLY © Ionică Bizău–The LICENSE file contains a copy of the license.