v0.1

Author: jwongster2

README.md

@@ -0,0 +1,40 @@
+# Ask How CLI
+
+A CLI that converts natural language to shell commands using Ollama.
+
+
+## Installation 
+
+Requires:
+- Python3.4+
+- Ollama
+
+```bash
+git clone https://github.com/ColabDog/how-ai-cli.git
+cd how-ai-cli
+pip install .
+```
+
+## Using Ask AI CLI
+
+To use the AI CLI, simply put a "#" in front of the natural language query.
+
+```bash
+how "List all files"
+```
+
+### Design Considerations
+
+Why not a "# List all files"? 
+- Often with CLI programs or instructions, many programs use "#" for commenting so I didn't end up choosing.
+
+Why Ollama?
+- Your CLI shouldn't be fed into into non-local models where possible. Ollama's development team is also fairly impressive in their delivery
+speed and quality of shipping making them a great tool choice.
+
+Why not use instructor?
+- Instructor did not really fit this use case as LLMs tend to be able to reliably produce bash code snippets
+with backticks.
+
+Why not use online LLMs?
+- There are alternative solutions that do this already.

app/__init__.py

@@ -0,0 +1,39 @@
+import subprocess
+import sys
+from app.query_ollama import query_ollama
+from app.extract_bash import extract_bash_commands
+from app.menu import row_based_rich_menu
+
+
+def process_query(query: str):
+    response = query_ollama(query)
+    bash_commands = extract_bash_commands(response)
+    if len(bash_commands) == 0:
+        print("No command could be produced")
+        return 0
+    selected_bash_command = row_based_rich_menu(bash_commands)
+    print(f"Received: {query}")
+    try:
+        result = subprocess.run(selected_bash_command, check=True, shell=True)
+        return result
+    except subprocess.CalledProcessError as e:
+        print(f"An error occurred while executing the command: {e}")
+        return 1
+
+
+def main():
+    if len(sys.argv) > 1:
+        query = " ".join(sys.argv[1:])
+        return process_query(query)
+    else:
+        print("Please provide a query.")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    import argparse
+
+    parser = argparse.ArgumentParser()
+    parser.add_argument("query")
+    args = parser.parse_args()
+    main(args.query)

app/cli.py

@@ -0,0 +1 @@
+DEFAULT_MODEL = "llama:3.1"

app/config.py

@@ -0,0 +1,38 @@
+"""Given an LLM response, extract bash commands.
+"""
+
+import re
+
+
+def extract_bash_commands(llm_response: str) -> list:
+    """
+    Extracts a list of bash commands from a given LLM response.
+
+    Args:
+    llm_response (str): The response from the LLM containing the bash commands.
+
+    Returns:
+    list: A list of the extracted bash commands.
+    """
+    # Start of the bash script in the response
+
+    commands = []
+    pattern = re.compile(r"```(?:bash)?(.*?)```", re.DOTALL)
+    matches = pattern.findall(llm_response)
+    for match in matches:
+        commands.extend(match.strip().split("\n"))
+
+    return commands
+
+
+if __name__ == "__main__":
+    from query_ollama import query_ollama
+
+    user_input = "List files"
+    if user_input.lower() == "exit":
+        print("Exiting. Goodbye!")
+    command = query_ollama(user_input)
+    print(f"Generated command: {command}")
+    commands = extract_bash_commands(command)
+    print("Commands:")
+    print(commands)

app/extract_bash.py

@@ -0,0 +1,31 @@
+from rich.console import Console
+from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.text import Text
+
+console = Console()
+
+
+def row_based_rich_menu(options: list) -> str:
+
+    menu_items = []
+    for i, option in enumerate(options, 1):
+        item = Text.assemble((f"{i}. ", "bold magenta"), (option, "cyan"))
+        menu_items.append(item)
+
+    console.print(
+        Panel(
+            "\n".join(str(item) for item in menu_items),
+            title="[bold blue]Main Menu[/bold blue]",
+            expand=False,
+            border_style="bold green",
+        )
+    )
+
+    choice = Prompt.ask(
+        "[bold yellow]Enter your choice[/bold yellow]",
+        choices=[str(i) for i in range(1, len(options) + 1)],
+        show_choices=False,
+    )
+
+    return options[int(choice) - 1]

app/menu.py

@@ -0,0 +1,56 @@
+"""Query Ollama model
+"""
+
+import requests
+import json
+import subprocess
+
+
+def init_ollama():
+    subprocess.Popen(
+        ["ollama", "start"], stdout=subprocess.PIPE, stderr=subprocess.PIPE
+    )
+    subprocess.Popen(
+        ["ollama", "serve"], stdout=subprocess.PIPE, stderr=subprocess.PIPE
+    )
+
+
+def query_ollama(prompt, stream: bool = True):
+    url = "http://localhost:11434/api/generate"
+    data = {
+        "model": "llama3.1",
+        "prompt": f"Convert the following natural language command to a bash command: {prompt}",
+        "stream": stream,
+    }
+
+    if stream:
+        full_response = ""
+        with requests.post(url, json=data, stream=True) as response:
+            for line in response.iter_lines():
+                if line:
+                    json_response = json.loads(line)
+                    chunk = json_response.get("response", "")
+                    full_response += chunk
+                    print(chunk, end="", flush=True)
+                if json_response.get("done", False):
+                    print()  # Print a newline at the end
+                    break
+        return full_response.strip()
+    else:
+        response = requests.post(url, json=data)
+        if response.status_code == 200:
+            response_text = response.json()["response"].strip()
+            print(response_text)
+            return response_text
+        else:
+            error_message = f"Error: Unable to get response from Ollama. Status code: {response.status_code}"
+            print(error_message)
+            return error_message
+
+
+if __name__ == "__main__":
+    user_input = "List files"
+    if user_input.lower() == "exit":
+        print("Exiting. Goodbye!")
+    command = query_ollama(user_input, True)
+    print(f"Generated command: {command}")

app/query_ollama.py

@@ -0,0 +1,2 @@
+requests
+rich

requirements.txt

@@ -0,0 +1,37 @@
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+with open("requirements.txt", "r") as req_file:
+    requirements = req_file.read().splitlines()
+
+
+setup(
+    name="how",
+    version="0.0.1",
+    author="Jacky W",
+    author_email="[email protected]",
+    description="A CLI tool that uses Ollama to convert natural language to CLI commands.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/yourusername/ollama-cli",
+    packages=find_packages(),
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+    ],
+    python_requires=">=3.4",
+    install_requires=requirements,
+    entry_points={
+        "console_scripts": [
+            "how=app.cli:main",
+        ],
+    },
+)

setup.py

@@ -0,0 +1,21 @@
+Script started on Sun Jul 28 22:31:45 2024
+%                                                                                                            jackywong@Jackys-MBP-2 ask-ai-cli % [?2004hhhistory [?2004l
+ 1178  ls
+ 1179  rm -rf temp
+ 1180  mkdir temp 
+ 1181  cd temp
+ 1182  ls
+ 1183  reflex init --template chat
+ 1184  ls
+ 1185  reflex run 
+ 1186  ls
+ 1187  ls
+ 1188  ls
+ 1189  ls
+ 1190  ls 
+ 1191  sudo sl
+ 1192  sudo ls 
+ 1193  ls
+%                                                                                                            jackywong@Jackys-MBP-2 ask-ai-cli % [?2004heexit[?2004l
+
+Script done on Sun Jul 28 22:32:05 2024