{"id":13493968,"url":"https://github.com/thedevs-network/the-guard-bot","last_synced_at":"2025-05-15T18:00:28.345Z","repository":{"id":23214921,"uuid":"97957105","full_name":"thedevs-network/the-guard-bot","owner":"thedevs-network","description":"The Guard, a Telegram bot to moderate groups.","archived":false,"fork":false,"pushed_at":"2024-12-02T11:58:54.000Z","size":1013,"stargazers_count":504,"open_issues_count":6,"forks_count":166,"subscribers_count":31,"default_branch":"develop","last_synced_at":"2025-04-08T20:16:59.383Z","etag":null,"topics":["bot","telegram","telegram-bot"],"latest_commit_sha":null,"homepage":"https://t.me/thedevs_bot","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thedevs-network.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":"2017-07-21T14:34:26.000Z","updated_at":"2025-04-03T09:08:42.000Z","dependencies_parsed_at":"2022-08-08T13:00:22.668Z","dependency_job_id":"22539dfa-0b79-4b00-82f3-6d7efd719e33","html_url":"https://github.com/thedevs-network/the-guard-bot","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thedevs-network%2Fthe-guard-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thedevs-network%2Fthe-guard-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thedevs-network%2Fthe-guard-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thedevs-network%2Fthe-guard-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thedevs-network","download_url":"https://codeload.github.com/thedevs-network/the-guard-bot/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254394718,"owners_count":22063984,"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":["bot","telegram","telegram-bot"],"created_at":"2024-07-31T19:01:20.441Z","updated_at":"2025-05-15T18:00:28.282Z","avatar_url":"https://github.com/thedevs-network.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/logo.png\" width=\"180\" height=\"180\"\u003e\n  \u003ch1 align=\"center\"\u003eThe Guard Bot\u003c/h1\u003e\n\u003c/p\u003e\nThe Guard is a Telegram bot made to help admins manage their groups.\n\nInitially created to moderate [The Devs Network](https://thedevs.network).\n\n## Table of Contents\n* [Key Features](#key-features)\n* [Setup](#setup)\n* [Commands](#commands)\n* [Plugins](#plugins)\n* [Support](#support)\n* [License](#license)\n\n## Key Features\n* Synchronized across multiple groups\n* Adding admins to the bot\n* Auto-remove and warn channels and groups ads\n* Kick bots added by users\n* Warn and ban users to control the group\n* Commands work with replying, mentioning and ID\n* Removes commands and temporary bot messages\n* Ability to create custom commands\n* Supports plugins\n\nOverall, keeps the groups clean and healthy to use.\n\n## Setup\nYou need [Node.js](https://nodejs.org/) (\u003e= 18) to run this bot.\n\n1. Create a bot via [@BotFather](https://t.me/BotFather) and grab a **token**.\n2. Clone this repository or [download zip](https://github.com/TheDevs-Network/the-guard-bot/archive/master.zip).\n3. Install dependencies via `npm install`.\n4. Copy `example.config.js` to `config.js` and edit it.\n5. Start the bot via `npm start`.\n\n### Setup with Docker\nYou need to have [docker](https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-from-a-package) installed on your machine.\n\n1. Create a bot via [@BotFather](https://t.me/BotFather) and grab a **token**.\n2. Clone this repository or [download zip](https://github.com/TheDevs-Network/the-guard-bot/archive/master.zip).\n3. Copy `example.config.js` to `config.js` and edit it.\n4. Run `docker build -t the_guard_bot .` to build image.\n5. Run `docker run -v $(pwd)/data:/app/data --rm -itd the_guard_bot` to start the bot.\n\nNow you can add the bot as **administrator** to your groups.\n\n## Commands\nCommand                 | Role       | Available at | Description\n----------------------- | ---------- | ------------ | -----------------\n`/admin`                | _Master_   | _Everywhere_ | Makes the user admin in the bot and groups.\n`/unadmin`              | _Master_   | _Everywhere_ | Demotes the user from admin list.\n`/leave \u003cname\\|id\u003e`     | _Master_   | _Everywhere_ | Make the bot to leave the group cleanly.\n`/hidegroup`            | _Master_   | _Groups_     | Revoke invite link and hide the group from `/groups` list.\n`/showgroup`            | _Master_   | _Groups_     | Make the group accessible via `/groups` list.\n`/del [reason]`         | _Admin_    | _Everywhere_ | Deletes replied-to message.\n`/warn \u003creason\u003e`        | _Admin_    | _Groups_     | Warns the user.\n`/unwarn`               | _Admin_    | _Everywhere_ | Removes the last warn from the user.\n`/nowarns`              | _Admin_    | _Everywhere_ | Clears warns for the user.\n`/permit`               | _Admin_    | _Everywhere_ | Permits the user to advertise once, within 24 hours.\n`/ban \u003creason\u003e`         | _Admin_    | _Groups_     | Bans the user from groups.\n`/unban`                | _Admin_    | _Everywhere_ | Removes the user from ban list.\n`/user`                 | _Admin_    | _Everywhere_ | Shows the status of the user.\n`/addcommand \u003cname\u003e`    | _Admin_    | _In-Bot_     | Create a custom command.\n`/removecommand \u003cname\u003e` | _Admin_    | _In-Bot_     | Remove a custom command.\n`/staff`                | _Everyone_ | _Everywhere_ | Shows a list of admins.\n`/link`                 | _Everyone_ | _Everywhere_ | Shows the current group's link.\n`/groups`               | _Everyone_ | _Everywhere_ | Shows a list of groups which the bot is admin in.\n`/report [reason]`      | _Everyone_ | _Groups_     | Reports the replied-to message to admins, reason is optional. Also can be prepended by `@` or `!` instead, and it is aliased by `admin` and `admins`.\n`/commands`             | _Everyone_ | _In-Bot_     | Shows a list of available commands.\n`/help` \\| `/start`     | _Everyone_ | _In-Bot_     | How to use the bot.\n\nAll commands and actions are synchronized across all of the groups managed by the owner and they work with **replying**, **mentioning** or **ID** of a user.\n\nIf used by reply, `/ban` and `/warn` would remove the replied-to message.\n\n## Plugins\n\nThe guard is extensible in form of plugins where custom features and commands can be easily added to it.\n\nSee the [Plugins page on the Wiki](https://github.com/thedevs-network/the-guard-bot/wiki/Plugins) for more information.\n\n## Support\n\nIf you need help with using the Bot or setting it up, join our [Support Chat](https://t.me/theguardsupport).\n\n[**Roadmap**](https://github.com/TheDevs-Network/the-guard-bot/projects/1)\n\n## License\n\n\u003e Important Note: Under the AGPL-3.0 license, if you're running your own instance, you should add a link to the source [(this repository)](https://github.com/TheDevs-Network/the-guard-bot) in your bot's bio. If you're modifying this source and making your own bot, you should link to the source of your own version of the bot according to the AGPL-3.0 license. Check [LICENSE](LICENSE) for more info.\n\n---\n\n`The Guard` icon is from [Entypo+](http://entypo.com/) by Daniel Bruce.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthedevs-network%2Fthe-guard-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthedevs-network%2Fthe-guard-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthedevs-network%2Fthe-guard-bot/lists"}