README.md in slack-smart-bot-1.14.1 vs README.md in slack-smart-bot-1.14.2
- old
+ new
@@ -231,11 +231,11 @@
**_`^THE_COMMAND`_**
**_`!!THE_COMMAND`_**
Examples run a command on demand:
-<img src="img/commands_on_demand.png" width="400">
+<img src="img/commands_on_demand.png" width="500">
Also you can always call the Smart Bot from any channel, even from channels without a running Smart Bot. You can use the External Call on Demand: **_`@NAME_OF_BOT on #CHANNEL_NAME COMMAND`_**. In this case you will call the bot on #CHANNEL_NAME. You can supply more than one channel then all the bots will respond. In case you are in a private conversation with the Smart Bot (DM) then you can use directly: **_`#CHANNEL_NAME COMMAND`_** or **_`on #CHANNEL_NAME COMMAND`_**
Examples:
@@ -247,11 +247,11 @@
>**_Peter>_** `on #sales notify clients`
If you want the Smart Bot just listen to part of the message you send, add the commands you want using '`' and start the line with '-!', '-!!' or '-^'
Examples:
-<img src="img/commands_inline.png" width="400">
+<img src="img/commands_inline.png" width="500">
All the commands specified on `./rules/general_commands.rb` will be accessible from any channel where the Smart Bot is present, without the necessity to call it with !, !!, ^ or on demand.
Examples:
@@ -268,11 +268,11 @@
To show only the specific rules of the Smart Bot defined on the rules file: **_`bot rules`_** or **_`bot rules COMMAND`_**
Also you can call `suggest command` or `random command` and SmartBot will return the help content for a random command.
Example:
-<img src="img/command_bot_help_echo.png" width="300">
+<img src="img/command_bot_help_echo.png" width="250">
When you call a command that is not recognized, you will get suggestions from the Smart Bot.
Remember when you add code to your rules you need to specify the help that will be displayed when using `bot help`, `bot rules`
@@ -348,18 +348,20 @@
> for all users
You can run Ruby code by using the command: **_`ruby THE_CODE`_**.
Example:
-<img src="img/command_ruby.png" width="500">
+<img src="img/command_ruby.png" width="650">
Also it is possible to attach a Ruby file and the Smart Bot will run and post the output. You need to select Ruby as file format. Or if you prefer it you can call the `ruby` command and on the same message supply a code block.
#### REPL
> for all users
+[](https://www.youtube.com/watch?v=URMI3BdD7J8)
+
Easily starts a REPL session so you will be able to create a script directly from the slack conversation. You will be able to share the REPL so they can run it or see the content.
It Will run all we write as a ruby command and will keep the session values until we finish the session sending `quit`, `exit` or `bye`
You can specify a SESSION_NAME that admits from a to Z, numbers, - and _. If no SESSION_NAME supplied it will be treated as a temporary REPL.
@@ -386,13 +388,13 @@
_private repl random-ssn_
_repl_
Running Example:
-<img src="img/command_repl1.png" width="600">
+<img src="img/command_repl1.png" width="650">
-<img src="img/command_repl2.png" width="600">
+<img src="img/command_repl2.png" width="650">
Runnning on demand the repl we created:
<img src="img/command_run_repl.png" width="400">
@@ -426,11 +428,11 @@
That shortcut will be available for you, in case you want to make it available for everybody on the channel:
Example:
-<img src="img/command_add_sc.png" width="500">
+<img src="img/command_add_sc.png" width="650">
In case you want to use a shortcut as a inline shortcut inside a command you can do it by adding a $:
Example:
>**_Peter>_** `!add shortcut cust1: 3488823-1233`
@@ -458,11 +460,11 @@
>**_Peter>_** `add announcement Party will start at 20:00 :tada:`
>**_Peter>_** `add :heavy_exclamation_mark: message Pay attention all DB are on maintenance until 20:00 GMT`
To see the announcements of the channel: **_`see announcements`_**, **_`see COLOR announcements`_**, **_`see EMOJI announcements`_** and to delete a particular announcement: **_`delete announcement ID`_**
-<img src="img/command_see_announcements.png" width="500">
+<img src="img/command_see_announcements.png" width="650">
If you are a master admin and you are on master channel then you can call **_`publish announcements`_** that will publish the announcements on all channels. The messages stored on a DM won't be published. This is very convenient to be called from a *Routine* for example every weekday at 09:00.
### Share messages
> for all users
@@ -538,11 +540,11 @@
>**_`10 times every 30s !ruby puts Time.now`_**
>**_`24 times every 60m !get sales today`_**
>**_`quit loop 1`_**
>**_`stop iterator 12`_**
-<img src="img/command_loop.png" width="400">
+<img src="img/command_loop.png" width="500">
### Control who has access to a command
> for admins
You can add, remove and list admins of any channel by using: `add admin @user`, `remove admin @user` and `see admins`. You need to be the creator of the channel, a Master admin or an admin.
@@ -617,10 +619,12 @@
>**_`most used commands`_**
### Teams
> for all users
+[](https://www.youtube.com/watch?v=u8B4aGDXH9M)
+
You can add, update, see, ping and delete teams. When calling `see TEAM_NAME team` the availability of the members will be displayed.
`add team TEAM_NAME PROPERTIES` will add a team with the info supplied. In case it is supplied a channel with type 'members' the members of that channel would be considered members of the team.
Examples:
>**_`add team devweb members #devweb support #devweb-support : We take care of the website`_**
@@ -674,11 +678,11 @@
>**_`see all memos from Sales team`_**
>**_`see bugs from Sales team dev`_**
>**_`sales team memo 4 Put it on hold until tests for Apple feature are finished`_**
>**_`sales team memo 7`_**
-<img src="img/command_see_team.png" width="600">
+<img src="img/command_see_team.png" width="650">
Other team commands: **_`delete team TEAM_NAME`_**, **_`delete memo ID from team TEAM_NAME`_**, **_`set STATUS on memo ID TEAM_NAME team`_**, **_`see MEMO_TYPE from TEAM_NAME team TOPIC`_**
@@ -711,11 +715,11 @@
}
```
When calling `see my time off` on a DM will display a calendar of the year with the days off, including public holidays
-<img src="img/command_my_timeoff.png" width="650">
+<img src="img/command_my_timeoff.png" width="750">
Other 'time off' commands: **_`remove time off ID`_**, **_`see my time off`_**, **_`see vacations @USER`_**, **_`time off team NAME`_**, **_`set public holidays to COUNTRY/REGION`_**
### OpenAI
@@ -729,10 +733,10 @@
ai: {
open_ai: {
access_token: 'OPENAI_ACCESS_TOKEN',
organization_id: 'OPENAI_ORGANIZATION_ID',
gpt_model: 'gpt-3.5-turbo',
- whisper_model : 'whisper-1',
+ whisper_model: 'whisper-1',
image_size: '256x256'
}
}
```