ShellBot

About 🤖

ShellBot 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.

Installation 🛠️

To install ShellBot, install it with pipx:

pipx install git+https://github.com/barabum0/shell-bot@pipx

Usage 🚀

1. Create a config.json or config.yaml file based on the config_example.json or config_example.yaml. The bot can read both formats.
2. Add your Telegram bot token and other configuration details to the file.
3. Run the bot using:

shellbot

By default, it will use the config.json file, but you can specify another file with:

shellbot --config config1.yaml

Troubleshooting 🔍

If you encounter any issues while using ShellBot, please check the GitHub Issues page for similar problems or to open a new issue.

Contribution 🤝

Contributions are welcome. Please fork the repository, make your changes, and submit a pull request.

License 📄

This project is licensed under the MIT License - see the LICENSE file for details.