how-cli 0.1.0__tar.gz

how_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Rudransh Joshi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

how_cli-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include requirements.txt
+include README.md

how_cli-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: how-cli
+Version: 0.1.0
+Summary: An AI-based CLI assistant to help you with command line & shell.
+Home-page: https://github.com/FireHead90544/how-cli
+Author: Rudransh Joshi (FireHead90544)
+Author-email: rudranshjoshi1806@gmail.com
+License: MIT
+Project-URL: Issue Tracker, https://github.com/FireHead90544/how-cli/issues
+Platform: any
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer
+Requires-Dist: langchain
+Requires-Dist: langchain-google-genai
+
+# how-cli
+An AI-based CLI assistant to help you with command line & shell.
+
+
+## Demo 
+Would be adding install instructions and better demo soon, until then check this out.
+### Setup
+![image](https://github.com/user-attachments/assets/87d3ba64-ecb7-43c6-9863-a62c39396ac5)
+
+### Inferences
+![image](https://github.com/user-attachments/assets/7af58310-183a-429b-aa66-e6abe36713fb)
+![image](https://github.com/user-attachments/assets/20062ac2-1057-4139-9f60-990bd41605da)
+
+
+## Installation
+**1. Using `pip`**
+  - Ensure python is installed on your system. (Tested against Python 3.11+)
+  - Install the package using pip.
+  ```bash
+  pip install -U how-cli
+  ```
+**2. Manual Installation**
+  - Clone the repository & cd into it
+  ```bash
+  git clone https://github.com/FireHead90544/how-cli && cd how-cli
+  ```
+  - Ensure you're in a virtual environment.
+  - Install the application.
+  ```bash
+  pip install -e .
+  ```
+
+
+## Usage
+```console
+$ how [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+* `-v, --version`: Shows the version of the application
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.
+
+**Commands**:
+* `setup`: Sets up the configuration required to run...
+* `to`: Sends the task to the LLM for analysis.
+
+
+## `how setup`
+Sets up the configuration required to run the application.
+Set the LLM Provider & the corresponding API Key.
+
+**Usage**:
+```console
+$ how setup [OPTIONS]
+```
+
+**Options**:
+* `--interactive / --no-interactive`: Whether to use interactive mode for setting up configuration?  [default: interactive]
+* `--provider TEXT`: The LLM Provider, needs to be passed explicitly if using --no-interactive mode.
+* `--api-key TEXT`: The API Key for the LLM provider, needs to be passed explicitly if using --no-interactive mode.
+* `--help`: Show this message and exit.
+
+
+## `how to`
+Sends the task to the LLM for analysis.
+Returns the commands to be executed in order to achieve that.
+
+**Usage**:
+```console
+$ how to [OPTIONS] TASK
+```
+
+**Arguments**:
+* `TASK`: The command line task to perform.  [required]
+
+**Options**:
+* `--help`: Show this message and exit.
+
+
+## Providers
+`how-cli` uses ChatModels as they support chat messages as opposed to TextModels and below model providers and their corresponding models are available to use.
+
+| Provider | Model | Package |
+|:--------:|:-----:|:-------:|
+| Google   | `gemini-1.5-flash` | `langchain-google-genai` |

how_cli-0.1.0/README.md

@@ -0,0 +1,87 @@
+# how-cli
+An AI-based CLI assistant to help you with command line & shell.
+
+
+## Demo 
+Would be adding install instructions and better demo soon, until then check this out.
+### Setup
+![image](https://github.com/user-attachments/assets/87d3ba64-ecb7-43c6-9863-a62c39396ac5)
+
+### Inferences
+![image](https://github.com/user-attachments/assets/7af58310-183a-429b-aa66-e6abe36713fb)
+![image](https://github.com/user-attachments/assets/20062ac2-1057-4139-9f60-990bd41605da)
+
+
+## Installation
+**1. Using `pip`**
+  - Ensure python is installed on your system. (Tested against Python 3.11+)
+  - Install the package using pip.
+  ```bash
+  pip install -U how-cli
+  ```
+**2. Manual Installation**
+  - Clone the repository & cd into it
+  ```bash
+  git clone https://github.com/FireHead90544/how-cli && cd how-cli
+  ```
+  - Ensure you're in a virtual environment.
+  - Install the application.
+  ```bash
+  pip install -e .
+  ```
+
+
+## Usage
+```console
+$ how [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+* `-v, --version`: Shows the version of the application
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.
+
+**Commands**:
+* `setup`: Sets up the configuration required to run...
+* `to`: Sends the task to the LLM for analysis.
+
+
+## `how setup`
+Sets up the configuration required to run the application.
+Set the LLM Provider & the corresponding API Key.
+
+**Usage**:
+```console
+$ how setup [OPTIONS]
+```
+
+**Options**:
+* `--interactive / --no-interactive`: Whether to use interactive mode for setting up configuration?  [default: interactive]
+* `--provider TEXT`: The LLM Provider, needs to be passed explicitly if using --no-interactive mode.
+* `--api-key TEXT`: The API Key for the LLM provider, needs to be passed explicitly if using --no-interactive mode.
+* `--help`: Show this message and exit.
+
+
+## `how to`
+Sends the task to the LLM for analysis.
+Returns the commands to be executed in order to achieve that.
+
+**Usage**:
+```console
+$ how to [OPTIONS] TASK
+```
+
+**Arguments**:
+* `TASK`: The command line task to perform.  [required]
+
+**Options**:
+* `--help`: Show this message and exit.
+
+
+## Providers
+`how-cli` uses ChatModels as they support chat messages as opposed to TextModels and below model providers and their corresponding models are available to use.
+
+| Provider | Model | Package |
+|:--------:|:-----:|:-------:|
+| Google   | `gemini-1.5-flash` | `langchain-google-genai` |

how_cli-0.1.0/how/__init__.py

@@ -0,0 +1 @@
+from how.core import __version__, __author__

how_cli-0.1.0/how/__main__.py

@@ -0,0 +1,4 @@
+from how.how import app
+
+if __name__ == "__main__":
+    app()

how_cli-0.1.0/how/core/__init__.py

@@ -0,0 +1,6 @@
+"""
+Package containing the core modules of the project.
+"""
+
+__version__ = "0.1.0"
+__author__ = "Rudransh Joshi (FireHead90544)"

how_cli-0.1.0/how/core/chains.py

@@ -0,0 +1,4 @@
+from how.core.template import PROMPT_TEMPLATE
+from how.core.llm import LLM
+
+HOW_CLI_CHAIN = PROMPT_TEMPLATE | LLM

how_cli-0.1.0/how/core/config.py

@@ -0,0 +1,50 @@
+import json
+from pathlib import Path
+
+class Config:
+    """
+    Manages the configuration of the application.
+    Config file is stored in the user's home directory.
+    """
+    def __init__(self):
+        self.config_dir = Path.home() / ".how"
+        self.config_file = self.config_dir / "config.json"
+        self.__init_config()
+
+    def __init_config(self):
+        """
+        Initialize the configuration directory & file if they don't exist.
+        """
+        if not self.config_dir.exists():
+            self.config_dir.mkdir()
+        
+        if not self.config_file.exists():
+            with open(self.config_file, "w") as f:
+                json.dump({"provider": "", "api_key": ""}, f, indent=4)
+
+    def setup(self, provider: str, api_key: str):
+        """
+        Set the LLM Provider & the corresponding API Key.
+        """
+        with open(self.config_file, "w") as f:
+            json.dump({"provider": provider, "api_key": api_key}, f, indent=4)
+
+    @property
+    def values(self):
+        """
+        Get the configuration values.
+        """
+        with open(self.config_file) as f:
+            return json.load(f)
+        
+    def is_ready(self):
+        """
+        Check if the configuration file is ready to use.
+        """
+        try:
+            assert self.values.get("provider")
+            assert self.values.get("api_key")
+        except:
+            return False
+
+        return True

how_cli-0.1.0/how/core/llm.py

@@ -0,0 +1,9 @@
+from how.core.config import Config
+from how.core.providers import LLM_PROVIDERS
+
+llm_config = Config().values
+
+LLM = LLM_PROVIDERS.get(llm_config.get("provider"))['provider'](
+    model = LLM_PROVIDERS.get(llm_config.get("provider"))['model'],
+    api_key = llm_config.get("api_key")
+)

how_cli-0.1.0/how/core/parser.py

@@ -0,0 +1,4 @@
+from how.core.schema import Result
+from langchain_core.output_parsers import JsonOutputParser
+
+PARSER = JsonOutputParser(pydantic_object=Result)

how_cli-0.1.0/how/core/prompts.py

@@ -0,0 +1,50 @@
+import json
+import platform
+
+SYSTEM_PROMPT = f"""You're a command line assistant, your goal is to help users by giving them a series of cli commands to run to achieve a certain task.
+You should only provide the series of commands to run and not the explanation of what each command does and they should be specific to system's user first, unless asked explicitly for another system.
+If you can't provide the commands, DO NOT TRY TO MAKE UP the commands, instead, set a lower confidence score and return the status.
+
+System Info: {platform.system()} {platform.release()}
+"""
+
+FEW_SHOT_EXAMPLES = [
+    {
+        "task": "search for a string in a file",
+        "output": json.dumps(
+            {
+                "status": "success",
+                "commands": ["cat <filename> | grep <string>"],
+                "confidence": 1.0,
+            }
+        ),
+    },
+    {
+        "task": "create a new branch and push that to remote",
+        "output": json.dumps(
+            {
+                "status": "success",
+                "commands": [
+                    "git checkout -b <brach_name>",
+                    "git push origin <branch_name>",
+                ],
+                "confidence": 1.0,
+            }
+        ),
+    },
+    {
+        "task": "use someone else's dotfiles",
+        "output": json.dumps(
+            {
+                "status": "success",
+                "commands": [
+                    "git clone <repo_url>",
+                    "cd <repo_name>",
+                    "cp .* ~",
+                    "source ~/.*",
+                ],
+                "confidence": 0.87,
+            }
+        ),
+    }
+]

how_cli-0.1.0/how/core/providers.py

@@ -0,0 +1,8 @@
+import os
+from langchain_google_genai import ChatGoogleGenerativeAI
+
+os.environ["GRPC_VERBOSITY"] = "NONE"
+
+LLM_PROVIDERS = {
+    "Gemini": { "provider": ChatGoogleGenerativeAI, "model": "gemini-1.5-flash" },
+}

how_cli-0.1.0/how/core/schema.py

@@ -0,0 +1,6 @@
+from langchain_core.pydantic_v1 import BaseModel, Field
+
+class Result(BaseModel):
+    commands: list[str] = Field(description="Commands to run in sequential order")
+    confidence: float = Field(description="Value between 0-1 (with precision of two decimal places) representing a confidence score about the success rate, not leading to any errors or interventions.")
+    status: str = Field(description="Status of the response (can be 'success' or anything else in case of error)")

how_cli-0.1.0/how/core/template.py

@@ -0,0 +1,19 @@
+from how.core.prompts import SYSTEM_PROMPT, FEW_SHOT_EXAMPLES
+from how.core.parser import PARSER
+from langchain_core.prompts import ChatPromptTemplate, FewShotChatMessagePromptTemplate
+
+example_template = ChatPromptTemplate.from_messages([
+    ("human", "How to {task}?"),
+    ("ai", "{output}")
+])
+
+few_shot_examples_template = FewShotChatMessagePromptTemplate(
+    example_prompt=example_template,
+    examples=FEW_SHOT_EXAMPLES
+)
+
+PROMPT_TEMPLATE = ChatPromptTemplate.from_messages([
+    ("system", SYSTEM_PROMPT + "\n{format_instructions}"),
+    few_shot_examples_template,
+    ("human", "How to {task}?")
+]).partial(format_instructions=PARSER.get_format_instructions())

how_cli-0.1.0/how/formatting.py

@@ -0,0 +1,36 @@
+from rich.console import Console
+from rich.panel import Panel
+from rich.text import Text
+from rich.table import Table
+from rich import box
+
+
+def display_result(task: str, result: dict):
+    console = Console()
+
+    task_panel = Panel(
+        Text(task, style="bold magenta"),
+        title="Task",
+        border_style="cyan",
+        expand=False,
+    )
+    console.print(task_panel)
+
+    if result["status"] != "success":
+        console.print(f"Status: [bold red]{result['status']}[/bold red]")
+        return
+
+    command_table = Table(box=box.ROUNDED, expand=True, show_header=False)
+    command_table.add_column("Commands", style="green")
+    for command in result["commands"]:
+        command_table.add_row(command)
+
+    confidence_panel = Panel(
+        f"{result['confidence']:.2%}",
+        title="Confidence Score",
+        border_style="yellow",
+        expand=False,
+    )
+
+    console.print(Panel(command_table, title="Commands", border_style="green"))
+    console.print(confidence_panel)

how_cli-0.1.0/how/how.py

@@ -0,0 +1,82 @@
+import typer
+from typing_extensions import Annotated
+from rich.prompt import Prompt
+from how.core.config import Config
+from how.formatting import display_result
+from how import __version__
+
+app = typer.Typer(
+    name="how",
+    help="An AI-based CLI assistant to help you with command line & shell.",
+)
+config = Config()
+
+def get_version(value: bool):
+    """
+    Callback to get the version of the application.
+    """
+    if value:
+        typer.echo(f"v{__version__}")
+        raise typer.Exit()
+
+@app.callback()
+def show_version(
+    version: bool = typer.Option(False, "--version", "-v", help="Shows the version of the application", callback=get_version)
+):
+    """
+    Shows the version of the application.
+    """
+    pass
+
+
+@app.command()
+def to(
+    task: Annotated[str, typer.Argument(help="The command line task to perform.")]
+):
+    """
+    Sends the task to the LLM for analysis.
+    Returns the commands to be executed in order to achieve that.
+    """
+    if not config.is_ready():
+        typer.secho("Please setup the configuration first using `how setup`", fg="red", bold=True)
+        raise typer.Abort()
+
+    from how.infer import get_result
+    result = get_result(task)
+    display_result(task, result)
+
+
+@app.command()
+def setup(
+    interactive: Annotated[bool, typer.Option(help="Whether to use interactive mode for setting up configuration?")] = True,
+    provider: Annotated[str, typer.Option(help="The LLM Provider, needs to be passed explicitly if using --no-interactive mode.")] = "",
+    api_key: Annotated[str, typer.Option(help="The API Key for the LLM provider, needs to be passed explicitly if using --no-interactive mode.")] = ""
+):
+    """
+    Sets up the configuration required to run the application.
+    Set the LLM Provider & the corresponding API Key.
+    """
+    from how.core.providers import LLM_PROVIDERS
+    
+    if not interactive:
+        if not provider or not api_key:
+            typer.secho("Please set the --provider and --api-key", fg="red", bold=True)
+            raise typer.Abort()
+        if provider not in LLM_PROVIDERS.keys():
+            typer.secho("LLM Provider not available yet. Please select from the available options.", fg="red", bold=True)
+            raise typer.Abort()
+    else:
+        provider = Prompt.ask("Select the LLM Provider", choices=list(LLM_PROVIDERS.keys()))
+        api_key = Prompt.ask(f"Enter {provider} API Key", password=True)
+
+        typer.confirm("Do you want to save the configuration?", abort=True)
+
+    # Test the API Key & Save the configuration only if it works
+    try:
+        llm = LLM_PROVIDERS.get(provider)["provider"](model=LLM_PROVIDERS.get(provider)['model'], api_key=api_key)
+        llm.invoke("Hi!")
+    except:
+        typer.secho("Invalid API Key for the given provider. Please try again.", fg="red", bold=True)
+        raise typer.Abort()
+
+    config.setup(provider, api_key)

how_cli-0.1.0/how/infer.py

@@ -0,0 +1,28 @@
+import warnings
+from how.core.chains import HOW_CLI_CHAIN
+from how.core.parser import PARSER
+
+def get_result(task: str) -> dict[str, str | list | float]:
+    """Invokes the chain with the given task and returns the result.
+
+    Args:
+        task (str): The task to perform.
+
+    Returns:
+        dict: The result of the chain.
+    """
+    tries = 3
+    parsed = {"status": "error", "commands": [], "confidence": 0.0}
+
+    while tries > 0:
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore")
+            res = HOW_CLI_CHAIN.invoke({ "task": task })
+
+        try:
+            parsed = PARSER.invoke(res)
+            break
+        except Exception as e:
+            tries -= 1
+
+    return parsed

how_cli-0.1.0/how_cli.egg-info/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.1
+Name: how-cli
+Version: 0.1.0
+Summary: An AI-based CLI assistant to help you with command line & shell.
+Home-page: https://github.com/FireHead90544/how-cli
+Author: Rudransh Joshi (FireHead90544)
+Author-email: rudranshjoshi1806@gmail.com
+License: MIT
+Project-URL: Issue Tracker, https://github.com/FireHead90544/how-cli/issues
+Platform: any
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer
+Requires-Dist: langchain
+Requires-Dist: langchain-google-genai
+
+# how-cli
+An AI-based CLI assistant to help you with command line & shell.
+
+
+## Demo 
+Would be adding install instructions and better demo soon, until then check this out.
+### Setup
+![image](https://github.com/user-attachments/assets/87d3ba64-ecb7-43c6-9863-a62c39396ac5)
+
+### Inferences
+![image](https://github.com/user-attachments/assets/7af58310-183a-429b-aa66-e6abe36713fb)
+![image](https://github.com/user-attachments/assets/20062ac2-1057-4139-9f60-990bd41605da)
+
+
+## Installation
+**1. Using `pip`**
+  - Ensure python is installed on your system. (Tested against Python 3.11+)
+  - Install the package using pip.
+  ```bash
+  pip install -U how-cli
+  ```
+**2. Manual Installation**
+  - Clone the repository & cd into it
+  ```bash
+  git clone https://github.com/FireHead90544/how-cli && cd how-cli
+  ```
+  - Ensure you're in a virtual environment.
+  - Install the application.
+  ```bash
+  pip install -e .
+  ```
+
+
+## Usage
+```console
+$ how [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+* `-v, --version`: Shows the version of the application
+* `--install-completion`: Install completion for the current shell.
+* `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
+* `--help`: Show this message and exit.
+
+**Commands**:
+* `setup`: Sets up the configuration required to run...
+* `to`: Sends the task to the LLM for analysis.
+
+
+## `how setup`
+Sets up the configuration required to run the application.
+Set the LLM Provider & the corresponding API Key.
+
+**Usage**:
+```console
+$ how setup [OPTIONS]
+```
+
+**Options**:
+* `--interactive / --no-interactive`: Whether to use interactive mode for setting up configuration?  [default: interactive]
+* `--provider TEXT`: The LLM Provider, needs to be passed explicitly if using --no-interactive mode.
+* `--api-key TEXT`: The API Key for the LLM provider, needs to be passed explicitly if using --no-interactive mode.
+* `--help`: Show this message and exit.
+
+
+## `how to`
+Sends the task to the LLM for analysis.
+Returns the commands to be executed in order to achieve that.
+
+**Usage**:
+```console
+$ how to [OPTIONS] TASK
+```
+
+**Arguments**:
+* `TASK`: The command line task to perform.  [required]
+
+**Options**:
+* `--help`: Show this message and exit.
+
+
+## Providers
+`how-cli` uses ChatModels as they support chat messages as opposed to TextModels and below model providers and their corresponding models are available to use.
+
+| Provider | Model | Package |
+|:--------:|:-----:|:-------:|
+| Google   | `gemini-1.5-flash` | `langchain-google-genai` |

how_cli-0.1.0/how_cli.egg-info/SOURCES.txt

@@ -0,0 +1,25 @@
+LICENSE
+MANIFEST.in
+README.md
+requirements.txt
+setup.py
+how/__init__.py
+how/__main__.py
+how/formatting.py
+how/how.py
+how/infer.py
+how/core/__init__.py
+how/core/chains.py
+how/core/config.py
+how/core/llm.py
+how/core/parser.py
+how/core/prompts.py
+how/core/providers.py
+how/core/schema.py
+how/core/template.py
+how_cli.egg-info/PKG-INFO
+how_cli.egg-info/SOURCES.txt
+how_cli.egg-info/dependency_links.txt
+how_cli.egg-info/entry_points.txt
+how_cli.egg-info/requires.txt
+how_cli.egg-info/top_level.txt

how_cli-0.1.0/how_cli.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

how_cli-0.1.0/how_cli.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+how = how.how:app

how_cli-0.1.0/how_cli.egg-info/requires.txt

@@ -0,0 +1,3 @@
+typer
+langchain
+langchain-google-genai

how_cli-0.1.0/how_cli.egg-info/top_level.txt

@@ -0,0 +1 @@
+how

how_cli-0.1.0/requirements.txt

@@ -0,0 +1,3 @@
+typer
+langchain
+langchain-google-genai

how_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

how_cli-0.1.0/setup.py

@@ -0,0 +1,31 @@
+from how import __version__, __author__
+from setuptools import setup, find_packages
+
+with open("README.md", "r") as f:
+    readme = f.read()
+
+with open("requirements.txt", "r") as f:
+    requirements = f.read().strip().splitlines()
+
+setup(
+    name="how-cli",
+    version=__version__,
+    description="An AI-based CLI assistant to help you with command line & shell.",
+    long_description=readme,
+    long_description_content_type="text/markdown",
+    url="https://github.com/FireHead90544/how-cli",
+    project_urls={
+        "Issue Tracker": "https://github.com/FireHead90544/how-cli/issues",
+    },
+    author=__author__,
+    author_email="rudranshjoshi1806@gmail.com",
+    platforms="any",
+    license="MIT",
+    packages=find_packages(),
+    install_requires=requirements,
+    entry_points={
+        "console_scripts": [
+            "how=how.how:app",
+        ]
+    }
+)