⚡️add help-ai command for AI generated help responses (#66)

* ⚡️add help-ai command for AI generated help responses

* ⚡️update help-ai command for improved user interaction

* ⚡️add environment variable support for openai api key retrieval

* ✨add anthropic api key env support, refactor anthropic service

Author: ming1in

README.md

@@ -41,6 +41,16 @@ git-ai-commit --version # verify installation
 git-ai-commit config --setup
 ```
 
+3. Your done, happy committing! Check out our fun range of command, the LLM can even help you, just run...
+
+```bash
+git-ai-commit help-ai [question?]
+
+# or get help the ol fashion way
+
+git-ai-commit --help
+```
+
 ## ⚡️ Quick Start: Setup Git Hook
 
 To quickly setup your [`prepare-commit-msg`](<https://git-scm.com/docs/githooks#_prepare_commit_msg>) git hook, execute the command below.

ai_commit_msg/cli/help_ai_handler.py

@@ -0,0 +1,36 @@
+from ai_commit_msg.services.openai_service import OpenAiService
+
+
+def help_ai_handler(args, help_menu):
+    user_message = " ".join(args.message)
+
+    if not user_message:
+        print(
+            "Let me know what you need help with \n\n git-ai-commit help-ai [message]"
+        )
+        return
+
+    prompt = [
+        {
+            "role": "system",
+            "content": f"""
+Hey GPT, based on the follow documentation on the CLI's arguments
+
+{help_menu}
+
+what are set of arguments and options should i use if someone requests for help?
+
+Please only respond with the exact command that should be used and nothing else.
+""",
+        },
+        {
+            "role": "user",
+            "content": user_message,
+        },
+    ]
+
+    ai_gen_commit_msg = OpenAiService().chat_with_openai(prompt)
+
+    print(ai_gen_commit_msg)
+
+    return

ai_commit_msg/main.py

@@ -4,6 +4,7 @@
 import os
 from typing import Sequence
 
+from ai_commit_msg.cli.help_ai_handler import help_ai_handler
 from ai_commit_msg.cli.summary_handler import summary_handler
 from ai_commit_msg.cli.config_handler import config_handler, handle_config_setup
 from ai_commit_msg.cli.gen_ai_commit_message_handler import (
@@ -88,6 +89,13 @@ def main(argv: Sequence[str] = sys.argv[1:]) -> int:
     # Help command
     subparsers.add_parser("help", help="Display this help message")
 
+    help_ai_parser = subparsers.add_parser(
+        "help-ai", help="🤖 Get help from AI to find the right command for you"
+    )
+    help_ai_parser.add_argument(
+        "message", nargs=argparse.REMAINDER, help="Additional message for help"
+    )
+
     # Hook command
     hook_parser = subparsers.add_parser(
         "hook", help="🪝 Run the prepare-commit-msg hook to generate commit messages"
@@ -132,10 +140,20 @@ def main(argv: Sequence[str] = sys.argv[1:]) -> int:
 
     args = parser.parse_args(argv)
 
+    def get_full_help_menu():
+        full_help_menu = "\nAvailable commands:\n"
+        for name, subparser in subparsers.choices.items():
+            full_help_menu += f"\n{name}:\n"
+            full_help_menu += subparser.format_help()
+
+        return full_help_menu
+
     if args.command == "config":
         config_handler(args)
     elif args.command == "help":
-        parser.print_help()
+        print(get_full_help_menu())
+    elif args.command == "help-ai":
+        help_ai_handler(args, help_menu=get_full_help_menu())
     elif args.command == "hook":
         hook_handler(args)
     elif args.command == "summarize" or args.command == "summary":

ai_commit_msg/services/anthropic_service.py

@@ -1,5 +1,7 @@
-from ai_commit_msg.utils.models import ANTHROPIC_MODEL_LIST
+import os
 import anthropic
+
+from ai_commit_msg.utils.models import ANTHROPIC_MODEL_LIST
 from ai_commit_msg.services.config_service import ConfigService
 from ai_commit_msg.utils.error import map_error
 
@@ -8,7 +10,7 @@ class AnthropicService:
     api_key = ""
 
     def __init__(self):
-        self.api_key = ConfigService().get_anthropic_api_key()
+        self.api_key = AnthropicService.get_anthropic_api_key()
 
         if self.api_key is None or self.api_key == "":
             raise Exception(
@@ -19,6 +21,20 @@ def __init__(self):
             api_key=self.api_key,
         )
 
+    @staticmethod
+    def get_anthropic_api_key():
+
+        local_api_key = ConfigService().get_anthropic_api_key()
+
+        if local_api_key != "":
+            return local_api_key
+
+        env_api_key = os.environ.get("ANTHROPIC_API_KEY")
+        if env_api_key != "":
+            return env_api_key
+
+        return ""
+
     def chat_completion(self, messages):
         select_model = ConfigService.get_model()
 

ai_commit_msg/services/openai_service.py

@@ -1,6 +1,7 @@
-from logging import Logger
-from ai_commit_msg.utils.error import map_error
+import os
 from openai import OpenAI
+
+from ai_commit_msg.utils.error import map_error
 from ai_commit_msg.services.config_service import ConfigService
 from ai_commit_msg.services.local_db_service import (
     LocalDbService,
@@ -43,7 +44,18 @@ def chat_with_openai(self, messages):
     @staticmethod
     def get_openai_api_key():
         raw_json_db = LocalDbService().get_db()[CONFIG_COLLECTION_KEY]
-        return raw_json_db["openai_api_key"]
+
+        # if the key is set in the local db, use that...
+        local_api_key = raw_json_db["openai_api_key"]
+        if local_api_key != "":
+            return local_api_key
+
+        # ...otherwise, check the environment variable
+        env_api_key = os.environ.get("OPENAI_API_KEY")
+        if env_api_key != "":
+            return env_api_key
+
+        return ""
 
     @staticmethod
     def set_openai_api_key(api_key):