{"id":25049254,"url":"https://github.com/kaelianbaudelet/termsteel","last_synced_at":"2025-04-14T05:35:21.887Z","repository":{"id":36978592,"uuid":"502089547","full_name":"kaelianbaudelet/Termsteel","owner":"kaelianbaudelet","description":"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.","archived":false,"fork":false,"pushed_at":"2024-03-03T00:38:09.000Z","size":73139,"stargazers_count":17,"open_issues_count":4,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-29T15:13:46.699Z","etag":null,"topics":["alpinejs","flask","pty","python","pyxtermjs","tailwindcss","terminal","termsteel"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/termsteel","language":"HTML","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/kaelianbaudelet.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-10T15:18:56.000Z","updated_at":"2024-12-03T18:12:52.000Z","dependencies_parsed_at":"2024-03-03T01:44:41.909Z","dependency_job_id":null,"html_url":"https://github.com/kaelianbaudelet/Termsteel","commit_stats":{"total_commits":71,"total_committers":2,"mean_commits":35.5,"dds":"0.014084507042253502","last_synced_commit":"d5c7981b243be0d10a1fa3f172311f7bdb4776ca"},"previous_names":["kaelianbaudelet/termsteel","afi-dev/termsteel"],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaelianbaudelet%2FTermsteel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaelianbaudelet%2FTermsteel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaelianbaudelet%2FTermsteel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kaelianbaudelet%2FTermsteel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kaelianbaudelet","download_url":"https://codeload.github.com/kaelianbaudelet/Termsteel/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248829013,"owners_count":21168133,"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":["alpinejs","flask","pty","python","pyxtermjs","tailwindcss","terminal","termsteel"],"created_at":"2025-02-06T08:17:12.888Z","updated_at":"2025-04-14T05:35:21.859Z","avatar_url":"https://github.com/kaelianbaudelet.png","language":"HTML","funding_links":["https://ko-fi.com/afidev"],"categories":[],"sub_categories":[],"readme":"# Termsteel\r\n\r\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://github.com/afi-dev/Termsteel/assets/44731817/e40c7ad9-a784-41ce-a753-4c9889557b17\" style=\"max-width: 100%;\"\u003e\u003c/p\u003e\r\n\r\n\u003cp align=\"center\"\u003e⚠️ This project is currently not maintained, it's just a demonstration project, actually i work on newer version on NextJS\u003c/h1\u003e\r\n\u003cbr\u003e\r\n\u003cp align=\"center\"\u003e\u003cb\u003e🙃 Termsteel is a 🇫🇷 French project. \u003c/b\u003e\u003c/p\u003e\r\n\r\n\u003cp align=\"center\"\u003e\u003cstrong\u003eTermsteel 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 \u003ca href=\"https://github.com/cs01/pyxtermjs\"\u003ePyxtermjs\u003c/a\u003e.\u003c/strong\u003e\u003c/p\u003e\r\n\r\n\u003cp align=\"center\"\u003e\u003ca href=\"https://github.com/afi-dev/Termsteel/blob/main/OS_SUPPORT.md\"\u003e\u003cimg src=\"https://i.imgur.com/XBceujJ.png\" style=\"max-width: 100%;\"\u003e\u003c/a\u003e\u003c/p\u003e\r\n\r\n![termsteel_banner.png](https://raw.githubusercontent.com/afi-dev/Termsteel/main/.github/assets/termsteel_banner.png)\r\n\r\n- **Easy-to-install**: Install Termsteel quickly and easily with no hassle\r\n- **Lightweight**: Works seamlessly with minimal hardware and software requirements.\r\n- **Design**: a beautiful and responsive web interface to view and interact with your machine's terminal.\r\n- **Scalable**: able to handle a lot of data and supports many linux console applications\r\n- **Free**: open source software that makes it easy to access your machine.\r\n\r\n![termsteel_cards.png](https://raw.githubusercontent.com/afi-dev/Termsteel/main/.github/assets/termsteel_cards.png)\r\n\r\n### Trailer : \r\n\r\nhttps://user-images.githubusercontent.com/44731817/174507182-ecfb696f-7dfd-4303-aa69-247e97e89afe.mp4\r\n\r\n### Demo : \r\n\r\nhttps://user-images.githubusercontent.com/44731817/179745407-9f9eedb1-ee34-42ab-ae93-3e33d8fca16b.mp4\r\n\r\n### Preview :\r\n\r\n\u003cimg src=\"https://i.imgur.com/zT2nJOI.gif\"\u003e\r\n\r\n-----\r\n\r\n## Pre-installation Note\r\n\r\n- Termsteel only works on MacOS, Windows (Only with WSL \u0026 WSL2), or some Linux distributions that support the [pty](https://docs.python.org/3/library/pty.html) (pseudo-terminal manipulation tools), [termios](https://docs.python.org/3/library/termios.html) and [fcntl](http://manpages.ubuntu.com/manpages/bionic/man2/fcntl.2.html) will be able to run Termsteel. For more details see the [list of supported OS/Distributions](https://github.com/afi-dev/Termsteel/blob/main/OS_SUPPORT.md).\r\n\r\n- Termsteel requires a minimum of **`1GB`** of RAM to function properly.\r\n\r\n- You will need python `3.0` or `higher` with `pip`\r\n\r\n- To know how to install Termsteel in detail or on specific platform please refer to this [documentation page](https://github.com/afi-dev/Termsteel/wiki/Install-Termsteel)\r\n\r\n- Termsteel not work Windows Platform please install Termsteel on WSL if you want to install it on Windows\r\n\r\n- Do not use Termsteel as a public access environment to your machine, Termsteel is only a proof of concept and does not guarantee maximum security without a ssl certificate on a production environment\r\n\r\n## Easy install \r\n\r\nTo start using and installing Termsteel type the command:\r\n\r\n```\r\npip install termsteel\r\n```\r\nSee the [Pipy](https://pypi.org/project/termsteel/) page for more details\r\n\r\n## Alternative Install Methods (Highly recommend)\r\n\r\n### Method 1: Curl the installer script\r\n\r\nIf you are using **Linux** or **Windows via WSL** use this command :\r\n```\r\ncurl -sSL https://raw.githubusercontent.com/afi-dev/Termsteel/main/installer.sh | sudo bash\r\n```\r\n\r\nIf you are using **MacOS** use this command :\r\n```\r\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/afi-dev/Termsteel/main/mac_installer.sh)\"\r\n```\r\n\r\n### Method 2: Manually download the installer script and run\r\n\r\nIf you are using **Linux** or **Windows via WSL** use this command :\r\n```\r\nwget https://raw.githubusercontent.com/afi-dev/Termsteel/main/installer.sh | sudo bash installer.sh\r\n```\r\n\r\nIf you are using **MacOS** use this command :\r\n```\r\ncurl -o mac_installer.sh https://raw.githubusercontent.com/afi-dev/Termsteel/main/mac_installer.sh \u0026\u0026 bash mac_installer.sh\r\n```\r\n\r\n## Install for Developpement\r\nIf you just want to install the development version repo and run Termsteel:\r\n\r\n```\r\ngit clone https://github.com/afi-dev/Termsteel.git\r\ncd Termsteel \u0026\u0026 pip install -r requirements.txt \u0026\u0026 cd src \u0026\u0026 cd termsteel \u0026\u0026 python3 app.py\r\n```\r\n\r\n## Run termsteel\r\n\r\nIf you installed from pip or from the install script use this :\r\n```\r\ntermsteel\r\n```\r\n\r\n### Optional arguments you can use\r\n```\r\ntermsteel [-h] [-p PORT] [--host HOST] [--debug] [--version] [-r]\r\n                        [--command COMMAND] [--cmd-args CMD_ARGS]\r\n\r\noptional arguments:\r\n  -h, --help            show this help message and exit\r\n  -p PORT, --port PORT  port to run server on (default: 5000)\r\n  --host HOST           host to run server on (it is highly recommended to use the ip of your machine from your local\r\n                        network) (default: 192.168.1.190)\r\n  --debug               debug the server (default: False)\r\n  --version             print version and exit (default: False)\r\n  -r, --reset           reset Termsteel to default password (default: False)\r\n  -c COMMAND, --command COMMAND\r\n                        Command to run in the terminal, i.e: htop (default: bash)\r\n  --cmd-args CMD_ARGS   arguments to pass to command (i.e. --cmd-args='arg1 arg2 --flag') (default: )\r\n  \r\n```\r\n\r\n## Default credentials\r\n\r\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://i.imgur.com/zs3tXc2.png\" style=\"max-width: 100%;\"\u003e\u003c/p\u003e\r\n\r\nThe default login credentials for accessing the dashbaord are:\r\n\r\n- username : **`Admin`**\r\n\r\n- password : **`Termsteel`**\r\n\r\nYou can change them directly from the `web dashboard` in `setting` from the `password tab`\r\n\r\n***⚠️ Please remember not to leave these credentials as default and change your password to a secure password containing upper case, lower case, special characters and numbers.***\r\n\r\n## Lost login credentials\r\n\r\nIf 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 : \r\n\r\n```\r\ntermsteel --reset\r\n``` \r\n\r\nOr you have to modify [`config.json`](https://github.com/afi-dev/Termsteel/blob/main/src/termsteel/config.json) and set `\"reset\"` to `true` then restart Termsteel.\r\n\r\n## Contributing\r\n\r\nI invite you to participate, to contribute to projects by suggesting new features, creating pull requests or issues.\r\n\r\nIf 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](https://github.com/afi-dev/Termsteel/blob/main/CODE_OF_CONDUCT.md) and state your sentences clearly so that they are understandable to everyone when you submit your request.\r\n\r\n## Support this project\r\n\r\nTermsteel 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](https://ko-fi.com/afidev), it's always a pleasure and it motivates me to make more beautiful projects. \r\n\r\n## License \u0026 Conditions\r\n\r\n- [MIT](https://github.com/afi-dev/Termsteel/blob/main/LICENSE)\r\n\r\n- [EULA](https://github.com/afi-dev/Termsteel/blob/main/EULA)\r\n\r\n## Useful link\r\n\r\n- [Documentation](https://github.com/afi-dev/Termsteel/wiki)\r\n\r\n- [Credits](https://github.com/afi-dev/Termsteel/blob/main/CREDITS.md)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaelianbaudelet%2Ftermsteel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkaelianbaudelet%2Ftermsteel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkaelianbaudelet%2Ftermsteel/lists"}