Minor fixes to the DB and Help pages

Author: Muchaszewski

Readme.md

@@ -16,29 +16,16 @@ Did you like this tool? Give us a visit :) [https://prographers.com/](https://pr
 - Parameters for controlling the bot's behavior
 - Docker support
 - Full documentation
-- Custom pre-defined commands
+- Custom pre-defined and dynamic commands
+- Context, a system message for the whole thread `-context`
 
 ## Dependencies
 
 - .NET 7.0
 - OpenAI-DotNet
 - SlackNet
 - SlackNet.AspNetCore
-
-## Installation
-
-- Clone the repository
-
-```bash
-git clone https://github.com/Prographers/Slack-GPT.git
-cd Slack-GPT
-```
-
-- Restore nuget packages
-
-```bash
-dotnet restore
-```
+- Octokit.Net
 
 ## Getting OpenAI Api Key
 
@@ -97,6 +84,9 @@ or per request.
 See GptDefaults.cs for more information about the defaults or `appsettings.Example.json`.
 
 ### Custom parameters
+
+**Predefined commands**
+
 You can add you own custom parameters to the bot to minimize the typing for each repated request. To do so, add the it's definition
 to the `GptCommands` section in `appsettings.json`. For example:
 
@@ -121,6 +111,17 @@ usage:
 
 > @GPT-4 -refactor `public class Foo { public void Bar() { Console.WriteLine("Hello World"); } }`
 
+**Dynamic commands** 
+
+In a similar manner you can create dynamic commands. To do so, call the 
+`/gpt commands add -command "prompt" "description" -global` command with the command name and the prompt.
+ - `-command` How this command will be called. eg: `-prographers`
+ - `-prompt` The prompt that will be used for this command. eg: `Prographers is software-house company...`
+ - `-description` The description of the command. eg: `A command to add infomation about Prographers` this is optional.
+ - `-global` flag will make the command available to all users. Otherwise it will be available for the user who created it.
+
+Use `/gpt commands help` to see more information about the commands.
+
 ## Docker
 
 You can start the docker container with the following command:
@@ -155,6 +156,21 @@ through the Slack API. The container is also running as a non-root user, and has
 - Deleting a message is a way to re-do the thread. So then it's easier to track the conversation when editing the message.
 - Ephemeral messages that are generated by the bot will disappear after slack client reloads. You can disable them in settings.
 
+## Run locally from source
+
+- Clone the repository
+
+```bash
+git clone https://github.com/Prographers/Slack-GPT.git
+cd Slack-GPT
+```
+
+- Restore nuget packages
+
+```bash
+dotnet restore
+```
+
 ## Screenshot
 
 Notification messages!

Slack-GPT-Socket.sln.DotSettings.user

@@ -19,5 +19,6 @@
     <TestId>NUnit3x::8513CAC6-F4FB-4821-B229-7B2E31E1DA66::net7.0::Slack_GPT_Tests.Handlers.CommandHandlerTests.CommandsCommand_AddSameCommand_MultipleUsers_CannotRemove</TestId>
     <TestId>NUnit3x::8513CAC6-F4FB-4821-B229-7B2E31E1DA66::net7.0::Slack_GPT_Tests.Handlers.CommandHandlerTests.WhatsNewCommand_Ok</TestId>
     <TestId>NUnit3x::8513CAC6-F4FB-4821-B229-7B2E31E1DA66::net7.0::Slack_GPT_Tests.Handlers.CommandHandlerTests.WhatsNewCommand_Error</TestId>
+    <TestId>NUnit3x::8513CAC6-F4FB-4821-B229-7B2E31E1DA66::net7.0::Slack_GPT_Tests.TestLiteDB.TestNullConnectionString_Ok</TestId>
   </TestAncestor>
 &lt;/SessionState&gt;</s:String></wpf:ResourceDictionary>

Slack-GPT-Socket/Program.cs

@@ -15,7 +15,9 @@
 
 builder.Services.AddSingleton<GptClient>();
 builder.Services.AddSingleton<GptCustomCommands>();
-builder.Services.AddSingleton<ILiteDatabase>(x => new LiteDatabase(builder.Configuration.GetConnectionString("LiteDB")));
+builder.Services.AddSingleton<ILiteDatabase>(x => 
+    new LiteDatabase(builder.Configuration.GetConnectionString("LiteDB") ?? "Filename=:memory:;Mode=Memory;Cache=Shared")
+);
 
 builder.Services.AddSingleton<IUserCommandDb, UserCommandDb>();
 

Slack-GPT-Socket/SlackHandlers/Command/HelpCommandStrategy.cs

@@ -34,23 +34,23 @@ public async Task<SlashCommandResponse> Execute(SlashCommand command)
     {
         // If command is just "help", return general help text
         if (command.Text == "help") return CommandStrategyUtils.SlashCommandResponse(GeneralHelpText(command));
-        
+
         // If command is "help <command>", return help text for that command
         var commandName = command.Text.Substring(4).Trim();
 
         foreach (var parameter in _parameterManager)
         {
-            var args = new ParameterEventArgs()
+            var args = new ParameterEventArgs
             {
                 Name = commandName,
                 UserId = command.UserId,
                 Value = string.Empty,
                 ValueRaw = string.Empty
             };
-            
+
             if (parameter.CanHandle(args))
             {
-                return CommandStrategyUtils.SlashCommandResponse(parameter.BuildHelpText(_gptDefaults, 
+                return CommandStrategyUtils.SlashCommandResponse(parameter.BuildHelpText(_gptDefaults,
                     commandName, command.UserId));
             }
         }
@@ -67,11 +67,20 @@ public async Task<SlashCommandResponse> Execute(SlashCommand command)
     private string GeneralHelpText(SlashCommand command)
     {
         var sb = new StringBuilder();
-        sb.AppendLine("Here are the commands you can use with the model\n" +
-                      "Commands are only accepted if put at the beginning of the prompt eg:" +
-                      "-command <prompt>\n" +
-                      "@GPT -command <prompt>\n" +
-                      "/gpt -command <prompt>\n");
+        sb.AppendLine("Here are the commands you can use with the model");
+        sb.AppendLine("Commands are only accepted if put at the beginning of the prompt eg:");
+        sb.AppendLine("`-command <prompt>`");
+        sb.AppendLine($"`@{_botInfo.BotInfo.User} -command <prompt>`");
+        sb.AppendLine("`/gpt -command <prompt>`");
+        sb.AppendLine();
+        sb.AppendLine("You can also use the following commands:");
+        sb.AppendLine(" - `/gpt help` - Display this help");
+        sb.AppendLine(" - `/gpt status` - Get the status of the bot");
+        sb.AppendLine(" - `/gpt commands` - List all commands");
+        sb.AppendLine(" - `/gpt whatsNew` - List the latest changes");
+        sb.AppendLine(" - `/gpt help <command>` - List help for a specific parameter command");
+        
+        sb.AppendLine();
         foreach (var parameter in _parameterManager)
         {
             sb.AppendLine(parameter.BuildShortHelpText(_gptDefaults, command.UserId));

Slack-GPT-Socket/Utilities/LiteDB/UserCommandDB.cs

@@ -15,7 +15,7 @@ public UserCommandDb(ILiteDatabase database)
         _commands.EnsureIndex(x => x.Command);
         _commands.EnsureIndex(x => x.UserId);
     }
-
+    
     /// <inheritdoc />
     public GptUserCommand? FindCommand(string command, string? userId = null)
     {

docker-compose.yml

@@ -8,7 +8,9 @@ services:
     labels:
       - "com.centurylinklabs.watchtower.scope=slack-gpt"
     volumes:
-      - ./appsettings.json:/app/appsettings.json
+      # See appsettings.json.example for configuration this file is required
+      - ./appsettings.json:/app/appsettings.json 
+      - slack-gpt-liteDB:/app/app.db
 
   watchtower-slack-gpt:
     image: containrrr/watchtower