Home page
GitHub

The UserGe - Documentation.

Read through the documentation and find the answers to all your questions!

Get startedBuy Me A Coffee!
__init__.py
config.py
from userge.logger import logging  # noqa
from userge import config  # noqa
from userge.core import (  # noqa
    Userge, filters, Message, get_collection, pool)


userge = Userge()

Introduction

Getting started

Learn how to get Userge set up and running in under thirty minutes or it's free.

Deployment

Step-by-step guides to setting up your userbot.

Main Repo

Check out the project on GitHub

Plugins

Extend your bot's functionality with third-party plugins or write your own.

Support Group

Get in touch with our support group.

Hello wonderer! Here is the best way to start your journey to make your Telegram Account automated with UserGe. It is the best Open-source Userbot for Telegram to simplify your daily task in a convenient way. The best part? It's extremely easy to setup and operate - even if you're completely new!

Quick start

What is UserGe?

UserGe is a Powerful, Pluggable Telegram UserBot written in Python using Pyrogram by which you can Automate your Telegram account to work as you want. It comes with salient and descriptive features that help you to manage your task with some easy command.

Features

  • Powerful and Very Useful built-in Plugins
  • Telegram Upload/ Download
  • Google Drive Upload/Download Supported (Also Team Drive Supported!)
  • (Zip/ Unzip/ tar) Supported
  • Multi Archives Split/ Combine Supported
  • PM Permit/ AFK
  • Notes/ Filters/ Welcomes
  • Plugin Manager
  • OCR Image reader
  • Remove Background APIs
  • Group Management
  • Built-in help support (Use .help)
  • and much more…

Sound good so far? Keep reading!

About the docs

This documentation contains the A to Z of UserGe and can be thought of as the 'User Manual' for UserGe. Most of the questions you have can be answered by simply reading this documentation. Whether you're trying to find out how to deploy, troubleshoot, contribute or have a general question, this documentation will help you figure it out.

You should know!

Reading this documentation & finding answers is the fastest way to fix your issue!

  • Deployment
  • How to Use UserGe (FAQ's)
  • Examples
  • Decorators
  • Errors & Their Fixes
  • Termux

Important Note For Contributors:

Users who want to make custom plugins need to have a Moderate level of Python like Data-types, Functions, Iterators, Async/await syntaxes, Some modules and libraries like Pyrogram, requests, os, aiohttp, etc.

Getting help

Read through the documentation but couldn't find an answer? Not a problem! Reach out to the UserGe Support Group on Telegram.

Plugins

For the plugins repo, please visit HERE

Submit an issue

Found a bug in UserGe? Or perhaps something isn't working as expected? Open an issue on the GitHub project.

Join the community

Our vibrant community of UserGe enthusiasts are always happy to welcome new users. Join us on Telegram and stay updated with the latest news, announcements and more!

Next
Deployment →