README.md

telegram-youtube-dl - Telegram bot to download Youtube content.

• Setting up
• Install
• Usage
  • Run types
• Bot commands
• Testing
• Docker

Setting up

Before you can run a Telegram bot, you have to create it and get it's API token. To do that, open Telegram and talk to @Botfather (it's a bot of course).

Install

npm install

Usage

The app expects TELEGRAM_TOKEN environment variable to contain the bot token. make sure you set it up via export TELEGRAM_TOKEN=<token> or inline with the npm run command.

Run types

npm run dev - use ts-node.
npm run start - use node to run transpiled code from dist folder. use this if everything already transpilied.
npm run prod - tranpile the code and run start.

Bot commands

/start - welcome message
/help - help message

/audio <video url> - This will download the audio format of the video and send it to the requesting user.

Testing

npm test - run all tests

Docker

After building the Dockerfile, run with your token as ENV variable.

docker run -d -e TELEGRAM_TOKEN=<your bot token> <image name>