An inline CLI telegram notifier. Used for sending message from CLI, or whenever another CLI command has finished
This repository has been archived on 2024-12-15. You can view files and clone it, but cannot push or open issues or pull requests.
Find a file
2020-03-22 19:33:30 -04:00
lib Changed from js to ts - Added implementation for profiles - Can also be used as a node_module 2020-03-22 19:33:30 -04:00
.gitignore Published to npm 2020-03-19 15:57:26 -04:00
.npmignore Changed from js to ts - Added implementation for profiles - Can also be used as a node_module 2020-03-22 19:33:30 -04:00
package-lock.json Changed from js to ts - Added implementation for profiles - Can also be used as a node_module 2020-03-22 19:33:30 -04:00
package.json Changed from js to ts - Added implementation for profiles - Can also be used as a node_module 2020-03-22 19:33:30 -04:00
README.md Changed from js to ts - Added implementation for profiles - Can also be used as a node_module 2020-03-22 19:33:30 -04:00
tsconfig.json Changed from js to ts - Added implementation for profiles - Can also be used as a node_module 2020-03-22 19:33:30 -04:00
tslint.json Changed from js to ts - Added implementation for profiles - Can also be used as a node_module 2020-03-22 19:33:30 -04:00
yarn.lock Changed from js to ts - Added implementation for profiles - Can also be used as a node_module 2020-03-22 19:33:30 -04:00

telme

CLI inline telegram bot notifications

TL;DR

  1. Get a bot token ( BotFather )
  2. $ npm install -g node-telme
  3. $ telme --init
  4. Do something :)

How do i get a bot token?

  • Get a telegram bot token from the botFather
  • Just talk to BotFather and follow a few simple steps. Once you've created a bot and received your authorization token, copy it for later

Configure telme

Simply run $ telme --init and follow the easy steps. You will need the bot token at this stage. This will help you generate a .telmeconfig file in your home directory. You can always run --init again to override values or just edit the file yourself.

Profiles

You can set multiple profiles, that will target different bots and/or different chats.

You can use the same bot in all profiles if you like. But the target chat can be different

To initialize a new profile:

$ telme --init --profile <profile_name>

Examples:

Simple message
$ telme --m "Message to send"
Task message

Task messages are a simple way to receive a message from your bot once a command has been finished. It will also let you know if you had any errors.

$ telme docker build . -t my-image/build/that/takes/for/ever

In this example, once the docker build has finished you will receive a message.

$ telme npm run test
$ telme do-a-long-task