Skip to content

A Discord bot client for TLDR Pages - a simpler alternative to man pages.

Notifications You must be signed in to change notification settings

Bnux256/TldrBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TldrBot

A Discord bot client for the TLDR Pages - a simpler alternative to man pages. Gives you a comprehensible and informative reference manual for every command.

"The name comes from the word TL;DR, which is an abbreviation for "too long; didn't read", referring to man pages that are said to be too long by several users." - Wikipedia


Run /tldr tar to get its TLDR manual:
Screenshot 2022-04-10 11 16 31 AM

Try it out!

Click here to add the bot to your server!

Installation

Docker-Compose: (recommended)

Download the docker-compose.yml file and bot token or a docker secret to it. Run docker build https://github.com/Bnux256/TldrBot.git#main -t bnux256/tldrbot --no-cache to build the docker container. Now to start the bot use: docker compose up -d and docker compose stop to stop it.

Standalone (Instruction for UNIX os)- requires Python>=3.9:

Clone the repo and add your bot token to .env file. Create a venv using python3 -m venv venv and enter into it using source venv/bin/activate. Install dependencies by running pip3 install -r requirments.txt Now to start it (if you are already inside the venv you created) run python3 main.py.

After the bot starts for the first time, run the /update commmand to setup it's cache.

About

A Discord bot client for TLDR Pages - a simpler alternative to man pages.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published