JSPM

  • Created
  • Published
  • Downloads 10
  • Score
    100M100P100Q30996F
  • License MIT

A full screen terminal in your browser.

Package Exports

  • web-term
  • web-term/bin/public/js/blm.js
  • web-term/bin/public/js/jquery.js
  • web-term/bin/public/js/term.js
  • web-term/bin/public/js/web-term.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (web-term) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

web-term

$ web-term

Support me on Patreon Buy me a book PayPal Version Downloads

A full screen terminal in your browser.

☁️ Installation

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

$ npm i -g web-term

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

$ web-term --help
Usage: web-term [options]

A full screen terminal in your browser.

Options:
  -P, --pty-options <json>  Additional options to pass to the pty library.
  -p, --port <port>         The web term server port.
  -H, --host <host>         The host to listen to.
  -d, --daemon              Start web term as background process.
  -c, --cwd <path>          The path to the web terminal current working
                            directory.
  -K, --key <path>          The path to the key file.
  -b, --shell <program>     The shell program. By default `bash`.
  -s, --start <program>     The start program.
  -C, --cert <path>         The path to the certificate file.
  -o, --open                If provided, the web term will be automatically
                            opened in the default browser.
  -h, --help                Displays this help.
  -v, --version             Displays version information.

Examples:
  $ web-term # Default behavior
  $ web-term -p 8080 # start on 0.0.0.0:8080
  $ web-term -p 8080 -h localhost # start on localhost:8080
  $ web-term -d # daemonize
  $ web-term -c path/to/some/dir
  $ web-term -o # Opens the web-term in the browser
  $ web-term -s alsamixer # Opens alsamixer in the browser
  $ web-term -C path/to/cert.pem -K path/to/key.pem # https support

Documentation can be found at https://github.com/IonicaBizau/web-term.

Screenshots

VIM

Alsamixer

📝 Documentation

For full API reference, see the DOCUMENTATION.md file.

😋 How to contribute

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

💖 Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

🍰 Thanks

This project is highly based on tty.js created by @chjj. Thanks a lot for this awesome stuff!

💫 Where is this library used?

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

  • magnesium—A terminal emulator based on Electron.

📜 License

MIT © Ionică Bizău