Compare commits
1 commit
c59eec9c50
...
e747b17141
Author | SHA1 | Date | |
---|---|---|---|
e747b17141 |
1 changed files with 11 additions and 19 deletions
30
README.md
30
README.md
|
@ -5,7 +5,7 @@
|
||||||
1. Get a bot token ( [BotFather](https://telegram.me/botfather) )
|
1. Get a bot token ( [BotFather](https://telegram.me/botfather) )
|
||||||
2. `$ npm install -g node-telme`
|
2. `$ npm install -g node-telme`
|
||||||
3. `$ telme --init`
|
3. `$ telme --init`
|
||||||
4. Need help? `$ telme --help`
|
4. Do something :)
|
||||||
|
|
||||||
## How do i get a bot token?
|
## How do i get a bot token?
|
||||||
- Get a telegram bot token from the botFather
|
- Get a telegram bot token from the botFather
|
||||||
|
@ -13,43 +13,35 @@
|
||||||
|
|
||||||
## Configure `telme`
|
## Configure `telme`
|
||||||
|
|
||||||
Simply run `$ telme --init` and follow 2 easy steps. You will need the bot token at this stage.
|
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.
|
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
|
## Profiles
|
||||||
|
|
||||||
You can set multiple profiles, that will target different bots and/or different chats.
|
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
|
> You can use the same bot in all profiles if you like. But the target chat can be different
|
||||||
|
|
||||||
To initialize a new profile:
|
To initialize a new profile:
|
||||||
```shell
|
```
|
||||||
$ telme --init --profile <profile_name>
|
$ telme --init --profile <profile_name>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Examples:
|
## Examples:
|
||||||
###### Simple message
|
###### Simple message
|
||||||
```shell
|
```
|
||||||
$ telme --m "Message to send"
|
$ 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
|
|
||||||
```shell
|
|
||||||
# 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 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.
|
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.
|
||||||
```shell
|
```
|
||||||
$ telme docker build . -t my-image/build/that/takes/for/ever
|
$ 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.
|
In this example, once the docker build has finished you will receive a message.
|
||||||
|
|
||||||
As mentioned before - you can also specify a profile.
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ 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)
|
$ telme npm run test
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
$ telme do-a-long-task
|
||||||
|
```
|
Reference in a new issue