{"id":30029909,"url":"https://github.com/therealfredp3d/making-banditgui","last_synced_at":"2025-08-06T18:07:41.680Z","repository":{"id":289771628,"uuid":"970885065","full_name":"TheRealFREDP3D/Making-BanditGUI","owner":"TheRealFREDP3D","description":"Play Overthewire Bandit wargame using a browser, allowing users to connect to the Bandit server, execute commands in a real SSH terminal, access level-specific information and hints, and track their progress. (Playable Demo)","archived":false,"fork":false,"pushed_at":"2025-07-29T11:37:16.000Z","size":32608,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-29T13:53:41.844Z","etag":null,"topics":["bandit-war-games","ctf","cybersecurity","education","flask","learning-by-doing","linux","overthewire-bandit","project","python","terminal","webdev","xterm"],"latest_commit_sha":null,"homepage":"https://github.com/TheRealFREDP3D/Making-BanditGUI","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheRealFREDP3D.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-22T17:23:20.000Z","updated_at":"2025-07-29T11:37:20.000Z","dependencies_parsed_at":"2025-07-16T00:39:49.868Z","dependency_job_id":"922bb122-7478-4c55-9a94-12268dd777ed","html_url":"https://github.com/TheRealFREDP3D/Making-BanditGUI","commit_stats":null,"previous_names":["therealfredp3d/making-banditgui"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/TheRealFREDP3D/Making-BanditGUI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheRealFREDP3D%2FMaking-BanditGUI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheRealFREDP3D%2FMaking-BanditGUI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheRealFREDP3D%2FMaking-BanditGUI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheRealFREDP3D%2FMaking-BanditGUI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheRealFREDP3D","download_url":"https://codeload.github.com/TheRealFREDP3D/Making-BanditGUI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheRealFREDP3D%2FMaking-BanditGUI/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269128359,"owners_count":24364931,"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","status":"online","status_checked_at":"2025-08-06T02:00:09.910Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["bandit-war-games","ctf","cybersecurity","education","flask","learning-by-doing","linux","overthewire-bandit","project","python","terminal","webdev","xterm"],"created_at":"2025-08-06T18:07:37.122Z","updated_at":"2025-08-06T18:07:41.671Z","avatar_url":"https://github.com/TheRealFREDP3D.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# v0.4 - BanditGUI: Making Cybersecurity Learning Accessible\n\n![Screenshot](docs/assets/v0.4-Main-screen.jpg)\n\nBanditGUI is a web-based interface for the popular OverTheWire Bandit wargame. It aims to make learning cybersecurity fundamentals more approachable by providing a browser-based terminal, structured level information, and an AI-powered assistant.\n\n## Why BanditGUI?\n\nThe command-line nature of challenges like Bandit can be a hurdle for beginners. BanditGUI lowers this barrier by:\n\n* Providing an integrated terminal in your browser.\n* Offering easy access to level goals, commands, and learning resources.\n* Assisting with hints and explanations through an AI chat interface.\n\n## Core Features\n\n* **Interactive Web Terminal:** A full-featured xterm.js terminal in your browser to connect to Bandit via SSH.  \n\n![Interactive Web Terminal](docs/assets/v0.4-Bandit0-Done-Terminal.jpg)\n\n* **Real SSH Connections:** Practice with actual Linux commands in a realistic environment.\n\n* **Level Guidance:** Access information, relevant commands, and reading materials for each Bandit level.\n\n![Level Guidance](docs/assets/v0.4-Bandit0.jpg)\n\n* **AI-Powered Chat Assistant:** Get intelligent hints and explanations from an LLM-powered chat (supports various models via LiteLLM).\n\n![Ask-a-Pro](docs/assets/v0.4-Mentor.jpg)\n\n* **Simplified Setup:** Easy installation using a Python script.\n* **Modular Design:** Built with a maintainable Python Flask backend and JavaScript frontend.\n\n## Tech Stack\n\n* **Backend:** Python (Flask)\n* **Frontend:** HTML, CSS, JavaScript (xterm.js)\n* **SSH:** Paramiko\n* **LLM Integration:** LiteLLM  \n\n![Easy LLM Selection](docs/assets/v0.4-Ask-a-Pro-LLM.jpg)\n\n## Getting Started\n\n### Installation\n\n1. **Clone the repository:**\n\n    ```bash\n    git clone https://github.com/therealfredp3D/Making-BanditGUI.git\n    cd Making-BanditGUI\n    ```\n\n2. **Run the installation script:**\n    This script will set up a virtual environment, install dependencies, and create run scripts.\n\n    ```bash\n    python install.py\n    # or python3 install.py on some systems\n    ```\n\n3. **Follow on-screen instructions.** The script will guide you through any necessary checks.\n\n### Running BanditGUI\n\n* **Windows:** Execute `run.bat` (Generated by `install.py`)\n* **Linux/macOS:** Execute `./run.sh` (Generated by `install.py`)\n\nOnce started, the application is typically available at `http://127.0.0.1:5000`.\n\n## How to Contribute\n\nWe welcome contributions! Please follow these general steps:\n\n1. Fork the repository.\n2. Create a new branch for your feature or bug fix.\n3. Make your changes.\n4. Test your changes thoroughly.\n5. Commit your changes with a clear message.\n6. Open a Pull Request to the `main` branch.\n\n## Roadmap Highlights\n\nWe are continuously working to improve BanditGUI. Some of our future goals include:\n\n1. **Password Management**: Adding secure password storage with encryption\n2. **Progress Tracking**: Implementing a system to track user progress through the challenges\n3. **Gamification**: Adding badges, streaks, and other gamification elements to increase engagement\n\n## License\n\nThis project is licensed under the MIT License.\n\n### 5. LLM-Powered Chat Interface\n\nThe application includes an advanced chat interface powered by Large Language Models (LLMs). It leverages `litellm` to support various API providers and LLMs, making it easy to switch between different models.\n\n**Dynamic Ollama Model Loading:**\n\n* When selecting an Ollama model, the app automatically fetches the list of available models from your local Ollama server (`http://localhost:11434/api/tags`).\n* This ensures the dropdown always reflects the actual models you have installed in Ollama, without needing to update the static config file.\n\nFor more detailed installation instructions, see [installation guide](docs/notion/notion_installation_guide.md).\n\n## New in v0.4\n\n## Frontend Asset Bundling (v0.4.2+)\n\n* The frontend now uses Webpack to bundle and minify JavaScript and CSS assets for improved performance.\n* All main JS and CSS are bundled into `banditgui/static/dist/main.js` and `banditgui/static/dist/styles.css`.\n* The main HTML template (`banditgui/templates/index.html`) now references these bundled files.\n\n### How to Build Frontend Assets\n\n1. Install dependencies (if not already):\n\n   ```bash\n   npm install\n   ```\n\n2. Build the assets:\n\n   ```bash\n   npm run build\n   ```\n\n3. The output will be in `banditgui/static/dist/`.\n\n\u003e **Note:** If you add or change JS/CSS, re-run `npm run build` to update the bundles.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftherealfredp3d%2Fmaking-banditgui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftherealfredp3d%2Fmaking-banditgui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftherealfredp3d%2Fmaking-banditgui/lists"}