mirror of
https://github.com/thedevs-network/the-guard-bot
synced 2025-08-30 05:37:59 +00:00
The Guard Bot
The Guard is a Telegram bot made to help admins manage their groups.Initially created to moderate The Devs Network.
NOTE: The Guard is still in alpha phase and is not ready for production
Setup
You need Node.js (> 8.1) to run this bot.
- Create a bot via @BotFather and grab a token.
- Clone this repository or downlaod zip.
- Install dependencies via
npm install
. - Copy
config.example.json
toconfig.json
, fill it properly and remove comments. - Start the bot via
npm start
.
Now you can add the bot as administrator to your groups.
Commands
Command | Rule | Description |
---|---|---|
/admin |
Master | Makes the user admin. |
/unadmin |
Master | Demotes the user from admin list. |
/warn <reason> |
Admin | Warns the user. |
/unwarn |
Admin | Removes the last warn from the user. |
/nowarns |
Admin | Clears warns for the user. |
/getwarns |
Admin | Shows a list of warns for the user. |
/ban <reason> |
Admin | Bans the user from groups. |
/unban |
Admin | Removes the user from ban list. |
/staff |
All | Shows a list of admins. |
/groups |
All | Show a list of groups which the bot is admin in. |
/report |
All | Reports the replied-to message to admins. |
All commands and actions are synchronized across all of the groups managed by the owner and they work with both replying and mentioning a user.
If used by reply, /ban
and /warn
remove the replied-to message.
The bot is still in alpha phase so feel free to open issues and ask for a feature.
Languages
JavaScript
79.6%
TypeScript
20.3%
Dockerfile
0.1%