yaicli 0.0.4__py3-none-any.whl → 0.0.5__py3-none-any.whl

yaicli-0.0.5.dist-info/METADATA

@@ -0,0 +1,244 @@
+Metadata-Version: 2.4
+Name: yaicli
+Version: 0.0.5
+Summary: A simple CLI tool to interact with LLM
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: distro>=1.9.0
+Requires-Dist: jmespath>=1.0.1
+Requires-Dist: prompt-toolkit>=3.0.50
+Requires-Dist: requests>=2.32.3
+Requires-Dist: rich>=13.9.4
+Requires-Dist: typer>=0.15.2
+Description-Content-Type: text/markdown
+
+# YAICLI - Your AI Command Line Interface
+
+YAICLI is a powerful command-line AI assistant tool that enables you to interact with Large Language Models (LLMs) through your terminal. It offers multiple operation modes for everyday conversations, generating and executing shell commands, and one-shot quick queries.
+
+## Features
+
+- **Multiple Operation Modes**:
+  - **Chat Mode (💬)**: Interactive conversation with the AI assistant
+  - **Execute Mode (🚀)**: Generate and execute shell commands specific to your OS and shell
+  - **Temp Mode**: Quick queries without entering interactive mode
+
+- **Smart Environment Detection**:
+  - Automatically detects your operating system and shell
+  - Customizes responses and commands for your specific environment
+
+- **Rich Terminal Interface**:
+  - Markdown rendering for formatted responses
+  - Streaming responses for real-time feedback
+  - Color-coded output for better readability
+
+- **Configurable**:
+  - Customizable API endpoints
+  - Support for different LLM providers
+  - Adjustable response parameters
+
+- **Keyboard Shortcuts**:
+  - Tab to switch between Chat and Execute modes
+
+## Installation
+
+### Prerequisites
+
+- Python 3.9 or higher
+- pip (Python package manager)
+
+### Install from PyPI
+
+```bash
+# Install by pip
+pip install yaicli
+
+# Install by pipx
+pipx install yaicli
+
+# Install by uv
+uv tool install yaicli
+```
+
+### Install from Source
+
+```bash
+git clone https://github.com/yourusername/yaicli.git
+cd yaicli
+pip install .
+```
+
+## Configuration
+
+On first run, YAICLI will create a default configuration file at `~/.config/yaicli/config.ini`. You'll need to edit this file to add your API key and customize other settings.
+
+Just run `ai`, and it will create the config file for you. Then you can edit it to add your api key.
+
+### Configuration File
+
+```ini
+[core]
+BASE_URL=https://api.openai.com/v1
+API_KEY=your_api_key_here
+MODEL=gpt-4o
+
+# default run mode, default: temp
+# chat: interactive chat mode
+# exec: shell command generation mode
+# temp: one-shot mode
+DEFAULT_MODE=temp
+
+# auto detect shell and os
+SHELL_NAME=auto
+OS_NAME=auto
+
+# if you want to use custom completions path, you can set it here
+COMPLETION_PATH=/chat/completions
+# if you want to use custom answer path, you can set it here
+ANSWER_PATH=choices[0].message.content
+
+# true: streaming response
+# false: non-streaming response
+STREAM=true
+```
+
+### Configuration Options
+
+- **BASE_URL**: API endpoint URL (default: OpenAI API)
+- **API_KEY**: Your API key for the LLM provider
+- **MODEL**: The model to use (e.g., gpt-4o, gpt-3.5-turbo), default: gpt-4o
+- **DEFAULT_MODE**: Default operation mode (chat, exec, or temp), default: temp
+- **SHELL_NAME**: Shell to use (auto for automatic detection), default: auto
+- **OS_NAME**: OS to use (auto for automatic detection), default: auto
+- **COMPLETION_PATH**: Path for completions endpoint, default: /chat/completions
+- **ANSWER_PATH**: Json path expression to extract answer from response, default: choices[0].message.content
+- **STREAM**: Enable/disable streaming responses
+
+## Usage
+
+### Basic Usage
+
+```bash
+# One-shot mode
+ai "What is the capital of France?"
+
+# Chat mode
+ai --chat
+
+# Shell command generation mode
+ai --shell "Create a backup of my Documents folder"
+
+# Verbose mode for debugging
+ai --verbose "Explain quantum computing"
+```
+
+### Command Line Options
+
+- `<PROMPT>`: Argument
+- `--verbose` or `-V`: Show verbose information
+- `--chat` or `-c`: Start in chat mode
+- `--shell` or `-s`: Generate and execute shell command
+- `--install-completion`: Install completion for the current shell
+- `--show-completion`: Show completion for the current shell, to copy it or customize the installation
+- `--help` or `-h`: Show this message and exit
+
+```bash
+ai -h
+
+ Usage: ai [OPTIONS] [PROMPT]
+
+ yaicli. Your AI interface in cli.
+
+╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│   prompt      [PROMPT]  The prompt send to the LLM                                                                                                       │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --verbose             -V        Show verbose information                                                                                                 │
+│ --chat                -c        Start in chat mode                                                                                                       │
+│ --shell               -s        Generate and execute shell command                                                                                       │
+│ --install-completion            Install completion for the current shell.                                                                                │
+│ --show-completion               Show completion for the current shell, to copy it or customize the installation.                                         │
+│ --help                -h        Show this message and exit.                                                                                              │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+
+
+```
+
+### Interactive Mode
+
+In interactive mode (chat or shell), you can:
+- Type your queries and get responses
+- Use `Tab` to switch between Chat and Execute modes
+- Type 'exit' or 'quit' to exit
+
+### Shell Command Generation
+
+In Execute mode:
+1. Enter your request in natural language
+2. YAICLI will generate an appropriate shell command
+3. Review the command
+4. Confirm to execute or reject
+
+## Examples
+
+### Chat Mode Example
+
+```bash
+$ ai --chat
+💬 > Tell me about the solar system
+
+Assistant:
+Certainly! Here’s a brief overview of the solar system:
+
+ • Sun: The central star of the solar system, providing light and energy.
+ • Planets:
+    • Mercury: Closest to the Sun, smallest planet.
+    • Venus: Second planet, known for its thick atmosphere and high surface temperature.
+    • Earth: Third planet, the only known planet to support life.
+    • Mars: Fourth planet, often called the "Red Planet" due to its reddish appearance.
+    • Jupiter: Largest planet, a gas giant with many moons.
+    • Saturn: Known for its prominent ring system, also a gas giant.
+    • Uranus: An ice giant, known for its unique axial tilt.
+    • Neptune: Another ice giant, known for its deep blue color.
+ • Dwarf Planets:
+    • Pluto: Once considered the ninth planet, now classified as
+
+💬 >
+```
+
+### Execute Mode Example
+
+```bash
+$ ai --shell "Find all PDF files in my Downloads folder"
+
+Generated command: find ~/Downloads -type f -name "*.pdf"
+Execute this command? [y/n]: y
+
+Executing command: find ~/Downloads -type f -name "*.pdf"
+
+/Users/username/Downloads/document1.pdf
+/Users/username/Downloads/report.pdf
+...
+```
+
+## Technical Implementation
+
+YAICLI is built using several Python libraries:
+
+- **Typer**: Provides the command-line interface
+- **Rich**: Provides terminal content formatting and beautiful display
+- **prompt_toolkit**: Provides interactive command-line input experience
+- **requests**: Handles API requests
+- **jmespath**: Parses JSON responses
+
+## Contributing
+
+Contributions of code, issue reports, or feature suggestions are welcome.
+
+## License
+
+[Apache License 2.0](LICENSE)
+
+---
+
+*YAICLI - Making your terminal smarter*

yaicli-0.0.5.dist-info/RECORD

@@ -0,0 +1,6 @@
+yaicli.py,sha256=5yHKni6bIB2k6xzDAcdr-Xk7KNS7_QKmS9XcN1n9Nrk,21497
+yaicli-0.0.5.dist-info/METADATA,sha256=Bx7PwYYH9J99pZIcrkgWhVE8hP3tiB6WGXZgjSw0qi4,9319
+yaicli-0.0.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+yaicli-0.0.5.dist-info/entry_points.txt,sha256=gdduQwAuu_LeDqnDU81Fv3NPmD2tRQ1FffvolIP3S1Q,34
+yaicli-0.0.5.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+yaicli-0.0.5.dist-info/RECORD,,

yaicli.py

@@ -33,7 +33,13 @@ class CasePreservingConfigParser(configparser.RawConfigParser):
         return optionstr
 
 
-class ShellAI:
+class YAICLI:
+    """Main class for YAICLI
+    Chat mode: interactive chat mode
+    One-shot mode:
+        Temp mode: ask a question and get a response once
+        Execute mode: generate and execute shell commands
+    """
     # Configuration file path
     CONFIG_PATH = Path("~/.config/yaicli/config.ini").expanduser()
 
@@ -45,8 +51,8 @@ MODEL=gpt-4o
 
 # default run mode, default: temp
 # chat: interactive chat mode
-# exec: shell command generation mode
-# temp: one-shot mode
+# exec: generate and execute shell commands once
+# temp: ask a question and get a response once
 DEFAULT_MODE=temp
 
 # auto detect shell and os
@@ -69,6 +75,8 @@ STREAM=true"""
         self.session = PromptSession(key_bindings=self.bindings)
         self.current_mode = ModeEnum.CHAT.value
         self.config = {}
+        self.history = []
+        self.max_history_length = 25
 
         # Setup key bindings
         self._setup_key_bindings()
@@ -82,10 +90,19 @@ STREAM=true"""
                 ModeEnum.CHAT.value if self.current_mode == ModeEnum.EXECUTE.value else ModeEnum.EXECUTE.value
             )
 
-    def detect_os(self):
-        """Detect operating system"""
+    def clear_history(self):
+        """Clear chat history"""
+        self.history = []
+
+    def detect_os(self) -> str:
+        """Detect operating system
+        Returns:
+            str: operating system name
+        Raises:
+            typer.Exit: if there is an error with the request
+        """
         if self.config.get("OS_NAME") != "auto":
-            return self.config.get("OS_NAME")
+            return self.config["OS_NAME"]
         current_platform = platform.system()
         if current_platform == "Linux":
             return "Linux/" + distro_name(pretty=True)
@@ -95,10 +112,15 @@ STREAM=true"""
             return "Darwin/MacOS " + platform.mac_ver()[0]
         return current_platform
 
-    def detect_shell(self):
-        """Detect shell"""
-        if self.config.get("SHELL_NAME") != "auto":
-            return self.config.get("SHELL_NAME")
+    def detect_shell(self) -> str:
+        """Detect shell
+        Returns:
+            str: shell name
+        Raises:
+            typer.Exit: if there is an error with the request
+        """
+        if self.config["SHELL_NAME"] != "auto":
+            return self.config["SHELL_NAME"]
         import platform
 
         current_platform = platform.system()
@@ -107,7 +129,13 @@ STREAM=true"""
             return "powershell.exe" if is_powershell else "cmd.exe"
         return basename(getenv("SHELL", "/bin/sh"))
 
-    def build_cmd_prompt(self):
+    def build_cmd_prompt(self) -> str:
+        """Build command prompt
+        Returns:
+            str: command prompt
+        Raises:
+            typer.Exit: if there is an error with the request
+        """
         _os = self.detect_os()
         _shell = self.detect_shell()
         return f"""Your are a Shell Command Generator.
@@ -119,8 +147,13 @@ Rules:
 4. Chain multi-step commands in SINGLE LINE
 5. Return NOTHING except the ready-to-run command"""
 
-    def build_default_prompt(self):
-        """Build default prompt"""
+    def build_default_prompt(self) -> str:
+        """Build default prompt
+        Returns:
+            str: default prompt
+        Raises:
+            typer.Exit: if there is an error with the request
+        """
         _os = self.detect_os()
         _shell = self.detect_shell()
         return (
@@ -130,8 +163,13 @@ Rules:
             "unless the user explicitly requests more details."
         )
 
-    def get_default_config(self):
-        """Get default configuration"""
+    def get_default_config(self) -> dict[str, str]:
+        """Get default configuration
+        Returns:
+            dict: default configuration
+        Raises:
+            typer.Exit: if there is an error with the request
+        """
         config = CasePreservingConfigParser()
         try:
             config.read_string(self.DEFAULT_CONFIG_INI)
@@ -142,8 +180,13 @@ Rules:
             self.console.print(f"[red]Error parsing config: {e}[/red]")
             raise typer.Exit(code=1) from None
 
-    def load_config(self):
-        """Load LLM API configuration"""
+    def load_config(self) -> dict[str, str]:
+        """Load LLM API configuration
+        Returns:
+            dict: configuration
+        Raises:
+            typer.Exit: if there is an error with the request
+        """
         if not self.CONFIG_PATH.exists():
             self.console.print(
                 "[bold yellow]Configuration file not found. Creating default configuration file.[/bold yellow]"
@@ -158,14 +201,28 @@ Rules:
         self.config["STREAM"] = str(self.config.get("STREAM", "true")).lower()
         return self.config
 
-    def _call_api(self, url, headers, data):
-        """Generic API call method"""
+    def _call_api(self, url: str, headers: dict, data: dict) -> requests.Response:
+        """Call the API and return the response.
+        Args:
+            url: API endpoint URL
+            headers: request headers
+            data: request data
+        Returns:
+            requests.Response: response object
+        Raises:
+            requests.exceptions.RequestException: if there is an error with the request
+        """
         response = requests.post(url, headers=headers, json=data)
         response.raise_for_status()  # Raise an exception for non-200 status codes
         return response
 
-    def get_llm_url(self) -> Optional[str]:
-        """Get LLM API URL"""
+    def get_llm_url(self) -> str:
+        """Get LLM API URL
+        Returns:
+            str: LLM API URL
+        Raises:
+            typer.Exit: if API key or base URL is not set
+        """
         base = self.config.get("BASE_URL", "").rstrip("/")
         if not base:
             self.console.print(
@@ -181,25 +238,44 @@ Rules:
         return f"{base}/{COMPLETION_PATH}"
 
     def build_data(self, prompt: str, mode: str = ModeEnum.TEMP.value) -> dict:
-        """Build request data"""
+        """Build request data
+        Args:
+            prompt: user input
+            mode: chat or execute mode
+        Returns:
+            dict: request data
+        """
         if mode == ModeEnum.EXECUTE.value:
             system_prompt = self.build_cmd_prompt()
         else:
             system_prompt = self.build_default_prompt()
+
+        # Build messages list, first add system prompt
+        messages = [{"role": "system", "content": system_prompt}]
+
+        # Add history records in chat mode
+        if mode == ModeEnum.CHAT.value and self.history:
+            messages.extend(self.history)
+
+        # Add current user message
+        messages.append({"role": "user", "content": prompt})
+
         return {
             "model": self.config["MODEL"],
-            "messages": [
-                {"role": "system", "content": system_prompt},
-                {"role": "user", "content": prompt},
-            ],
+            "messages": messages,
             "stream": self.config.get("STREAM", "true") == "true",
             "temperature": 0.7,
             "top_p": 0.7,
             "max_tokens": 200,
         }
 
-    def stream_response(self, response):
-        """Stream response from LLM API"""
+    def stream_response(self, response: requests.Response) -> str:
+        """Stream response from LLM API
+        Args:
+            response: requests.Response object
+        Returns:
+            str: full completion text
+        """
         full_completion = ""
         # Streaming response loop
         with Live(console=self.console) as live:
@@ -223,8 +299,15 @@ Rules:
                             self.console.print(f"[red]Error decoding JSON: {decoded_line}[/red]")
                 time.sleep(0.05)
 
-    def call_llm_api(self, prompt: str):
-        """Call LLM API, return streaming output"""
+        return full_completion
+
+    def call_llm_api(self, prompt: str) -> str:
+        """Call LLM API, return streaming output
+        Args:
+            prompt: user input
+        Returns:
+            str: streaming output
+        """
         url = self.get_llm_url()
         headers = {"Authorization": f"Bearer {self.config['API_KEY']}"}
         data = self.build_data(prompt)
@@ -239,11 +322,18 @@ Rules:
             raise typer.Exit(code=1)
 
         self.console.print("\n[bold green]Assistant:[/bold green]")
-        self.stream_response(response)  # Stream the response
+        assistant_response = self.stream_response(response)  # Stream the response and get the full text
         self.console.print()  # Add a newline after the completion
 
-    def get_command_from_llm(self, prompt):
-        """Request Shell command from LLM"""
+        return assistant_response
+
+    def get_command_from_llm(self, prompt: str) -> Optional[str]:
+        """Request Shell command from LLM
+        Args:
+            prompt: user input
+        Returns:
+            str: shell command
+        """
         url = self.get_llm_url()
         headers = {"Authorization": f"Bearer {self.config['API_KEY']}"}
         data = self.build_data(prompt, mode=ModeEnum.EXECUTE.value)
@@ -265,15 +355,24 @@ Rules:
         content = jmespath.search(ANSWER_PATH, response.json())
         return content.strip()
 
-    def execute_shell_command(self, command):
-        """Execute shell command"""
+    def execute_shell_command(self, command: str) -> int:
+        """Execute shell command
+        Args:
+            command: shell command
+        Returns:
+            int: return code
+        """
         self.console.print(f"\n[bold green]Executing command: [/bold green] {command}\n")
         result = subprocess.run(command, shell=True)
         if result.returncode != 0:
             self.console.print(f"\n[bold red]Command failed with return code: {result.returncode}[/bold red]")
+        return result.returncode
 
     def get_prompt_tokens(self):
-        """Get prompt tokens based on current mode"""
+        """Get prompt tokens based on current mode
+        Returns:
+            list: prompt tokens for prompt_toolkit
+        """
         if self.current_mode == ModeEnum.CHAT.value:
             qmark = "💬"
         elif self.current_mode == ModeEnum.EXECUTE.value:
@@ -283,14 +382,35 @@ Rules:
         return [("class:qmark", qmark), ("class:question", " {} ".format(">"))]
 
     def chat_mode(self, user_input: str):
-        """Interactive chat mode"""
+        """
+        This method handles the chat mode.
+        It adds the user input to the history and calls the API to get a response.
+        It then adds the response to the history and manages the history length.
+        Args:
+            user_input: user input
+        Returns:
+            ModeEnum: current mode
+        """
         if self.current_mode != ModeEnum.CHAT.value:
             return self.current_mode
 
-        self.call_llm_api(user_input)
+        # Add user message to history
+        self.history.append({"role": "user", "content": user_input})
+
+        # Call API and get response
+        assistant_response = self.call_llm_api(user_input)
+
+        # Add assistant response to history
+        if assistant_response:
+            self.history.append({"role": "assistant", "content": assistant_response})
+
+        # Manage history length, keep recent conversations
+        if len(self.history) > self.max_history_length * 2:  # Each conversation has user and assistant messages
+            self.history = self.history[-self.max_history_length * 2 :]
+
         return ModeEnum.CHAT.value
 
-    def _filter_command(self, command):
+    def _filter_command(self, command: str) -> Optional[str]:
         """Filter out unwanted characters from command
 
         The LLM may return commands in markdown format with code blocks.
@@ -335,11 +455,21 @@ Rules:
             return "\n".join(line.strip() for line in content_lines if line.strip())
 
     def execute_mode(self, user_input: str):
-        """Execute mode"""
+        """
+        This method generates a shell command from the user input and executes it.
+        If the user confirms the command, it is executed.
+        Args:
+            user_input: user input
+        Returns:
+            ModeEnum: current mode
+        """
         if user_input == "" or self.current_mode != ModeEnum.EXECUTE.value:
             return self.current_mode
 
         command = self.get_command_from_llm(user_input)
+        if not command:
+            self.console.print("[bold red]No command generated[/bold red]")
+            return self.current_mode
         command = self._filter_command(command)
         if not command:
             self.console.print("[bold red]No command generated[/bold red]")
@@ -357,25 +487,44 @@ Rules:
             if not user_input.strip():
                 continue
 
-            if user_input.lower() in ("exit", "quit"):
+            if user_input.lower() in ("/exit", "/quit", "/q"):
                 break
 
+            # Handle special commands
             if self.current_mode == ModeEnum.CHAT.value:
-                self.chat_mode(user_input)
+                if user_input.lower() == "/clear":
+                    self.clear_history()
+                    self.console.print("[bold yellow]Chat history cleared[/bold yellow]\n")
+                    continue
+                else:
+                    self.chat_mode(user_input)
             elif self.current_mode == ModeEnum.EXECUTE.value:
                 self.execute_mode(user_input)
 
         self.console.print("[bold green]Exiting...[/bold green]")
 
     def run_one_shot(self, prompt: str):
-        """Run one-shot mode with given prompt"""
+        """Run one-shot mode with given prompt
+        Args:
+            prompt (str): Prompt to send to LLM
+        Returns:
+            None
+        """
         if self.current_mode == ModeEnum.EXECUTE.value:
             self.execute_mode(prompt)  # Execute mode for one-shot prompt
         else:
             self.call_llm_api(prompt)
 
     def run(self, chat=False, shell=False, prompt: Optional[str] = None):
-        """Run the CLI application"""
+        """Run the CLI application
+        Args:
+            chat (bool): Whether to run in chat mode
+            shell (bool): Whether to run in shell mode
+            prompt (Optional[str]): Prompt send to LLM
+
+        Returns:
+            None
+        """
         # Load configuration
         self.config = self.load_config()
         if not self.config.get("API_KEY", None):
@@ -434,7 +583,7 @@ def main(
         typer.echo(ctx.get_help())
         raise typer.Exit()
 
-    cli = ShellAI(verbose=verbose)
+    cli = YAICLI(verbose=verbose)
     cli.run(chat=chat, shell=shell, prompt=prompt)
 
 

yaicli-0.0.4.dist-info/METADATA

@@ -1,15 +0,0 @@
-Metadata-Version: 2.4
-Name: yaicli
-Version: 0.0.4
-Summary: A simple CLI tool to interact with LLM
-License-File: LICENSE
-Requires-Python: >=3.8
-Requires-Dist: distro>=1.9.0
-Requires-Dist: jmespath>=1.0.1
-Requires-Dist: prompt-toolkit>=3.0.50
-Requires-Dist: requests>=2.32.3
-Requires-Dist: rich>=13.9.4
-Requires-Dist: typer>=0.15.2
-Description-Content-Type: text/markdown
-
-# llmcli

yaicli-0.0.4.dist-info/RECORD

@@ -1,6 +0,0 @@
-yaicli.py,sha256=CY5TnPQAypGJ1FQLiryGBV4UFc8E1ZQyaNmT7ghw7NU,16741
-yaicli-0.0.4.dist-info/METADATA,sha256=fY81CYJR2jcWmwElOe3rSk-wM4Lk27SZhTPdK0eHw4E,379
-yaicli-0.0.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-yaicli-0.0.4.dist-info/entry_points.txt,sha256=gdduQwAuu_LeDqnDU81Fv3NPmD2tRQ1FffvolIP3S1Q,34
-yaicli-0.0.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-yaicli-0.0.4.dist-info/RECORD,,