lib | ||
.gitignore | ||
.npmignore | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
tsconfig.json | ||
tslint.json | ||
yarn.lock |
telme
CLI inline telegram bot notifications
TL;DR
- Get a bot token ( BotFather )
$ npm install -g node-telme
$ telme --init
- Need help?
$ telme --help
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 2 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"
In the next example a message will be sent every time the user user
logs in to a tty.
Added the next lines at the bottom of
~/.profile
file
# Telme on login
telme --m "A new Login:\n\`\`\` user: $(whoami) | hostname: $(hostname) | remote ip $(who | cut -d'(' -f2 | cut -d')' -f1)\`\`\` Hope this is you!"
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.
As mentioned before - you can also specify a profile.
$ telme -p movie-club curl https://example.com/large/file/download.mp4
this will send the message to the movie-club
profile chat. (By the movie-club
bot)