Termsteel
Termsteel is a versatile and sleek web terminal built in python and accessible from a web browser to interact without complexity with the terminal on your machine inspired on Pyxtermjs.
- Easy-to-install: Install Termsteel quickly and easily with no hassle
- Lightweight: Works seamlessly with minimal hardware and software requirements.
- Design: a beautiful and responsive web interface to view and interact with your machine's terminal.
- Scalable: able to handle a lot of data and supports many linux console applications
- Free: open source software that makes it easy to access your machine.
Trailer :
trailer.mp4
Pre-installation Note
-
Termsteel only works on MacOS, Windows (Only with WSL & WSL2), or some Linux distributions that support the pty (pseudo-terminal manipulation tools), termios and fcntl will be able to run Termsteel. For more details see the list of supported OS/Distributions.
-
Termsteel requires a minimum of
1GBof RAM to function properly. -
You will need python
3.0orhigher -
To know how to install Termsteel in detail or on specific platform please refer to this documentation page
Easy install
To start using and installing Termsteel type the command:
pip install termsteel
See the Pipy page for more details
Alternative Install Methods (Highly recommend)
Method 1: Curl the installer script
If you are using Linux or Windows via WSL use this command :
curl -sSL https://raw.githubusercontent.com/afi-dev/Termsteel/main/installer.sh | sudo bash
If you are using MacOS use this command :
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/afi-dev/Termsteel/main/mac_installer.sh)"
Method 2: Manually download the installer script and run
If you are using Linux or Windows via WSL use this command :
wget https://raw.githubusercontent.com/afi-dev/Termsteel/main/installer.sh | sudo bash installer.sh
If you are using MacOS use this command :
curl -o mac_installer.sh https://raw.githubusercontent.com/afi-dev/Termsteel/main/mac_installer.sh && bash mac_installer.sh
Install for Developpement
If you just want to install the development version repo and run Termsteel:
git clone https://github.com/afi-dev/Termsteel.git
cd Termsteel && pip install -r requirements.txt && cd src && cd termsteel && python3 app.py
Run termsteel
If you installed from pip or from the install script use this :
termsteel
Optional arguments you can use
termsteel [-h] [-p PORT] [--host HOST] [--debug] [--version] [-r]
[--command COMMAND] [--cmd-args CMD_ARGS]
optional arguments:
-h, --help show this help message and exit
-p PORT, --port PORT port to run server on (default: 5000)
--host HOST host to run server on (it is highly recommended to use the ip of your machine from your local
network) (default: 192.168.1.190)
--debug debug the server (default: False)
--version print version and exit (default: False)
-r, --reset reset Termsteel to default password (default: False)
-c COMMAND, --command COMMAND
Command to run in the terminal, i.e: htop (default: bash)
--cmd-args CMD_ARGS arguments to pass to command (i.e. --cmd-args='arg1 arg2 --flag') (default: )
Default credentials
The default login credentials for accessing the dashbaord are:
-
username :
Admin -
password :
Termsteel
You can change them directly from the web dashboard in setting from the password tab
Lost login credentials
If you have lost your login credentials you can still reset Termsteel to the default credentials, to do this you can reset Termsteel directly by typing the following command :
termsteel --reset
Or you have to modify config.json and set "reset" to true then restart Termsteel.
Contributing
I invite you to participate, to contribute to projects by suggesting new features, creating pull requests or issues.
If you have something to add, whether it's a typo or a brand new feature, I'm glad to consider it! Please be sure to follow our code of conduct and state your sentences clearly so that they are understandable to everyone when you submit your request.
Support this project
Termsteel is completely free and open-source, so feel free to participate in its creation. By the way, you can support my work by supporting me by making a donation, it's always a pleasure and it motivates me to make more beautiful projects.
Cannot run termsteel: ModuleNotFound 'termios'
When installing termsteel:
then running
termsteelI get the following error:I am using Python 3.8 on Windows 10 with WSL 2
Sound output of Terminal Applications
Thank you for this awesome tool. Is there a straight-forward way to integrate the sound output of Terminal Applications running on Termsteel? Thank you again.
Error Install with Flask-JWT-Login
Hello,
i tried to install but i got:
Preparing metadata (setup.py) ... error error: subprocess-exited-with-error
× python setup.py egg_info did not run successfully. │ exit code: 1 ╰─> [6 lines of output] Traceback (most recent call last): File "", line 2, in
File "", line 34, in
File "C:\Users\ user .... \AppData\Local\Temp\pip-install-dagqibp8\flask-jwt-login_372ce447414e4e20ac0341d4898d6c5e\setup.py", line 12, in
long_description=open('README.md').read(),
FileNotFoundError: [Errno 2] No such file or directory: 'README.md'
[end of output]
note: This error originates from a subprocess, and is likely not a problem with pip. error: metadata-generation-failed
Selection on Install
Hi.
I was unable to select any options during the installation.
Tried to connect from multiple terminals, but none of them let me choose from the options.
Bump pyjwt from 1.6.4 to 2.4.0
Bumps pyjwt from 1.6.4 to 2.4.0.
Release notes
Sourced from pyjwt's releases.
... (truncated)
Changelog
Sourced from pyjwt's changelog.