Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/IonicaBizau/web-term

:tv: A fullscreen terminal in your browser.
https://github.com/IonicaBizau/web-term

hacktoberfest

Last synced: 14 days ago
JSON representation

:tv: A fullscreen terminal in your browser.

Lists

README 

        



[![web-term](http://i.imgur.com/3kMJhvc.png)](#)



# `$ web-term`



 [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/web-term.svg)](https://www.npmjs.com/package/web-term) [![Downloads](https://img.shields.io/npm/dt/web-term.svg)](https://www.npmjs.com/package/web-term) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)



Buy Me A Coffee



> A full screen terminal in your browser.



## :cloud: Installation



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



```sh

# Using npm

npm install --global web-term



# Using yarn

yarn global add 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:

  --authentication-key      An optional authentication key.

  -P, --pty-options   Additional options to pass to the pty library.

  -K, --key           The path to the key file.

  -C, --cert          The path to the certificate file.

  -s, --start      The start program.

  -b, --shell      The shell program. By default `bash`.

  -o, --open                If provided, the web term will be automatically

                            opened in the default browser.

  -c, --cwd           The path to the web terminal current working

                            directory.

  -d, --daemon              Start web term as background process.

  -H, --host          The host to listen to.

  -p, --port          The web term server port.

  -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



![](http://i.imgur.com/49FTpfI.png "")



### Alsamixer



![](http://i.imgur.com/rJbtLdi.jpg "")



## :question: Get Help



There are few ways to get help:



 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.

 2. For bug reports and feature requests, open issues. :bug:

 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:



## :memo: Documentation



For full API reference, see the [DOCUMENTATION.md][docs] file.



## :yum: How to contribute

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



## :sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to 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 :rocket:

 - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:

 - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

 - [![Support me on Patreon][badge_patreon]][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`



    ![](https://i.imgur.com/z6OQI95.png)



Thanks! :heart:



## :cake: Thanks

This project is highly based on [`tty.js`](https://github.com/chjj/tty.js) created by [@chjj](https://github.com/chjj). Thanks a lot for this awesome stuff!



## :dizzy: Where is this library used?

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



 - `magnesium`



## :scroll: License



[MIT][license] © [Ionică Bizău][website]



[license]: /LICENSE

[website]: https://ionicabizau.net

[contributing]: /CONTRIBUTING.md

[docs]: /DOCUMENTATION.md

[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg

[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg

[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg

[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg

[patreon]: https://www.patreon.com/ionicabizau

[amazon]: http://amzn.eu/hRo9sIZ

[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW