{"id":21164540,"url":"https://github.com/barabum0/shell-bot","last_synced_at":"2025-07-09T16:33:21.334Z","repository":{"id":207193159,"uuid":"718631143","full_name":"barabum0/shell-bot","owner":"barabum0","description":"A Telegram bot to run preset commands in shell","archived":false,"fork":false,"pushed_at":"2024-05-31T16:02:53.000Z","size":5667,"stargazers_count":2,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-05T03:02:12.561Z","etag":null,"topics":["aiogram","python","shell","telegram"],"latest_commit_sha":null,"homepage":"","language":"Python","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/barabum0.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-11-14T13:40:34.000Z","updated_at":"2024-05-31T14:11:21.000Z","dependencies_parsed_at":"2023-12-09T19:43:16.428Z","dependency_job_id":null,"html_url":"https://github.com/barabum0/shell-bot","commit_stats":null,"previous_names":["barabum0/shell-bot"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/barabum0/shell-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barabum0%2Fshell-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barabum0%2Fshell-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barabum0%2Fshell-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barabum0%2Fshell-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/barabum0","download_url":"https://codeload.github.com/barabum0/shell-bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/barabum0%2Fshell-bot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264494969,"owners_count":23617474,"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":["aiogram","python","shell","telegram"],"created_at":"2024-11-20T14:06:31.408Z","updated_at":"2025-07-09T16:33:20.629Z","avatar_url":"https://github.com/barabum0.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# ShellBot\n\n![GitHub stars](https://img.shields.io/github/stars/barabum0/shell-bot)\n![GitHub forks](https://img.shields.io/github/forks/barabum0/shell-bot)\n![GitHub issues](https://img.shields.io/github/issues/barabum0/shell-bot)\n![GitHub license](https://img.shields.io/github/license/barabum0/shell-bot)\n\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Formatted with: isort](https://img.shields.io/badge/formatted%20with-isort-blue.svg)](https://github.com/psf/black)\n[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)\n\n\u003c/div\u003e\n\n## About 🤖\n\nShellBot is a Telegram bot designed to run commands in a shell environment. It allows users to execute predefined shell commands through a Telegram interface, making it a versatile tool for remote command execution.\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/barabum0/shell-bot/blob/main/example-recording.gif?raw=true\" width=\"50%\" height=\"50%\"\u003e\n\u003c/div\u003e\n\n## Installation 🛠️\n\nTo install ShellBot, install it with [`pipx`](https://github.com/pypa/pipx?tab=readme-ov-file):\n\n```bash\npipx install git+https://github.com/barabum0/shell-bot@pipx\n```\n\n## Usage 🚀\n\n1. Create a `config.json` or `config.yaml` file based on the `config_example.json` or `config_example.yaml`. The bot can read both formats.\n2. Add your Telegram bot token and other configuration details to the file.\n3. Run the bot using:\n\n```bash\nshellbot\n```\n\nBy default, it will use the `config.json` file, but you can specify another file with:\n\n```bash\nshellbot --config config1.yaml\n```\n\n## Troubleshooting 🔍\n\nIf you encounter any issues while using ShellBot, please check the [GitHub Issues](https://github.com/barabum0/shell-bot/issues) page for similar problems or to open a new issue.\n\n## Contribution 🤝\n\nContributions are welcome. Please fork the repository, make your changes, and submit a pull request.\n\n## License 📄\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarabum0%2Fshell-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbarabum0%2Fshell-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarabum0%2Fshell-bot/lists"}