{"id":13475967,"url":"https://github.com/IonicaBizau/web-term","last_synced_at":"2025-03-27T01:30:39.726Z","repository":{"id":12892297,"uuid":"15569095","full_name":"IonicaBizau/web-term","owner":"IonicaBizau","description":":tv: A fullscreen terminal in your browser.","archived":false,"fork":false,"pushed_at":"2020-08-09T16:53:27.000Z","size":2451,"stargazers_count":170,"open_issues_count":2,"forks_count":21,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-10-22T22:48:40.962Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IonicaBizau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-01-01T19:45:35.000Z","updated_at":"2024-09-24T06:31:14.000Z","dependencies_parsed_at":"2022-09-13T22:42:18.402Z","dependency_job_id":null,"html_url":"https://github.com/IonicaBizau/web-term","commit_stats":null,"previous_names":["ionicabizau/browser-terminal"],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IonicaBizau%2Fweb-term","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IonicaBizau%2Fweb-term/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IonicaBizau%2Fweb-term/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IonicaBizau%2Fweb-term/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IonicaBizau","download_url":"https://codeload.github.com/IonicaBizau/web-term/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245372382,"owners_count":20604492,"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":["hacktoberfest"],"created_at":"2024-07-31T16:01:25.191Z","updated_at":"2025-03-27T01:30:39.707Z","avatar_url":"https://github.com/IonicaBizau.png","language":"JavaScript","funding_links":["https://www.buymeacoffee.com/H96WwChMy","https://www.patreon.com/ionicabizau","https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=RVXDDLKKLQRJW"],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003c!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. --\u003e\n\n\n\n\n\n\n\n\n[![web-term](http://i.imgur.com/3kMJhvc.png)](#)\n\n\n\n\n\n\n\n\n\n\n\n# `$ web-term`\n\n [![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\u0026utm_medium=button\u0026utm_term=johnnyb\u0026utm_campaign=github)\n\n\u003ca href=\"https://www.buymeacoffee.com/H96WwChMy\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png\" alt=\"Buy Me A Coffee\"\u003e\u003c/a\u003e\n\n\n\n\n\n\n\n\u003e A full screen terminal in your browser.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## :cloud: Installation\n\nYou can install the package globally and use it as command line tool:\n\n\n```sh\n# Using npm\nnpm install --global web-term\n\n# Using yarn\nyarn global add web-term\n```\n\n\nThen, run `web-term --help` and see what the CLI tool can do.\n\n\n```\n$ web-term --help\nUsage: web-term [options]\n\nA full screen terminal in your browser.\n\nOptions:\n  --authentication-key      An optional authentication key.\n  -P, --pty-options \u003cjson\u003e  Additional options to pass to the pty library.\n  -K, --key \u003cpath\u003e          The path to the key file.\n  -C, --cert \u003cpath\u003e         The path to the certificate file.\n  -s, --start \u003cprogram\u003e     The start program.\n  -b, --shell \u003cprogram\u003e     The shell program. By default `bash`.\n  -o, --open                If provided, the web term will be automatically\n                            opened in the default browser.\n  -c, --cwd \u003cpath\u003e          The path to the web terminal current working\n                            directory.\n  -d, --daemon              Start web term as background process.\n  -H, --host \u003chost\u003e         The host to listen to.\n  -p, --port \u003cport\u003e         The web term server port.\n  -h, --help                Displays this help.\n  -v, --version             Displays version information.\n\nExamples:\n  $ web-term # Default behavior\n  $ web-term -p 8080 # start on 0.0.0.0:8080\n  $ web-term -p 8080 -h localhost # start on localhost:8080\n  $ web-term -d # daemonize\n  $ web-term -c path/to/some/dir\n  $ web-term -o # Opens the web-term in the browser\n  $ web-term -s alsamixer # Opens alsamixer in the browser\n  $ web-term -C path/to/cert.pem -K path/to/key.pem # https support\n\nDocumentation can be found at https://github.com/IonicaBizau/web-term.\n```\n\n\n\n\n\n\n\n## Screenshots\n\n### VIM\n\n![](http://i.imgur.com/49FTpfI.png \"\")\n\n### Alsamixer\n\n![](http://i.imgur.com/rJbtLdi.jpg \"\")\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## :question: Get Help\n\nThere are few ways to get help:\n\n\n\n 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.\n 2. For bug reports and feature requests, open issues. :bug:\n 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:\n\n\n\n\n\n## :memo: Documentation\n\nFor full API reference, see the [DOCUMENTATION.md][docs] file.\n\n\n\n\n\n\n\n\n\n\n\n\n## :yum: How to contribute\nHave an idea? Found a bug? See [how to contribute][contributing].\n\n\n## :sparkling_heart: Support my projects\nI open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,\nthis 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).\n\nHowever, 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:\n\n\n - Starring and sharing the projects you like :rocket:\n - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:\n - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:\n - [![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).\n - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`\n\n    ![](https://i.imgur.com/z6OQI95.png)\n\n\nThanks! :heart:\n\n\n\n\n\n\n\n\n\n## :cake: Thanks\nThis 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!\n\n\n\n\n\n\n\n\n## :dizzy: Where is this library used?\nIf you are using this library in one of your projects, add it in this list. :sparkles:\n\n - `magnesium`\n\n\n\n\n\n\n\n\n\n\n\n## :scroll: License\n\n[MIT][license] © [Ionică Bizău][website]\n\n\n\n\n\n\n[license]: /LICENSE\n[website]: https://ionicabizau.net\n[contributing]: /CONTRIBUTING.md\n[docs]: /DOCUMENTATION.md\n[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg\n[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg\n[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg\n[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg\n[patreon]: https://www.patreon.com/ionicabizau\n[amazon]: http://amzn.eu/hRo9sIZ\n[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=RVXDDLKKLQRJW\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIonicaBizau%2Fweb-term","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FIonicaBizau%2Fweb-term","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIonicaBizau%2Fweb-term/lists"}