https://github.com/0xpiranhacodes/webpty
A helpful package that helps you access shell & shell-based applications via web application
https://github.com/0xpiranhacodes/webpty
pkg pty python tornado websocket xterm-js
Last synced: 2 months ago
JSON representation
A helpful package that helps you access shell & shell-based applications via web application
- Host: GitHub
- URL: https://github.com/0xpiranhacodes/webpty
- Owner: 0xPiranhaCodes
- License: mit
- Created: 2020-12-03T11:24:12.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-07-25T06:40:33.000Z (about 2 years ago)
- Last Synced: 2025-07-28T01:40:06.997Z (2 months ago)
- Topics: pkg, pty, python, tornado, websocket, xterm-js
- Language: Python
- Homepage: https://replit.com/@satheesh1997/webpty
- Size: 196 KB
- Stars: 16
- Watchers: 2
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# webpty
Web based application to access shell & shell based applications via a browser.
[](https://badge.fury.io/py/webpty)
#
## Installation
Use [pip](https://pip.pypa.io/en/stable/) and install webpty.
```bash
pip install webpty
```
## Usage
```bash
webpty
```
Creates a tornado server which will be serving bash shell on http://localhost:8000/
### Change Shell
```bash
webpty -c $SHELL
```
or
```bash
webpty --cmd=$SHELL
```
This $SHELL can be bash, sh, python, vim, wtfutil, etc. that is available in the system.
### Change Port
```bash
webpty -p $PORT
```
or
```bash
webpty --port=$PORT
```
Creates a tornado server that server on the specified port http://localhost:$PORT/
### Change Allowed Hosts
By default, server will accept request from all the hosts without any restriction, to make it accept only from certain hosts,
```bash
webpty -ah $ALLOWED_HOSTS
```
or
```bash
webpty --allowed-hosts=$ALLOWED_HOSTS
```
Server accepts only requests from $ALLOWED_HOSTS. This $ALLOWED_HOSTS should be list of strings seperated by a comma.
#
## Screenshots
#### Bash
#### Python
#### Vim
#
## Contributing
Pull requests are welcome. Raise a issue and start a discussion before submitting a pr.
#
