yaicli 0.0.7__py3-none-any.whl → 0.0.10__py3-none-any.whl

pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "yaicli"
+version = "0.0.10"
+description = "A simple CLI tool to interact with LLM"
+authors = [{ name = "belingud", email = "im.victor@qq.com" }]
+readme = "README.md"
+requires-python = ">=3.9"
+license = { file = "LICENSE" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+keywords = [
+    "cli",
+    "llm",
+    "ai",
+    "chatgpt",
+    "openai",
+    "gpt",
+    "llms",
+    "openai",
+    "terminal",
+    "interactive",
+    "interact",
+    "interact with llm",
+    "interact with chatgpt",
+    "interact with openai",
+    "interact with gpt",
+    "interact with llms",
+]
+dependencies = [
+    "distro>=1.9.0",
+    "jmespath>=1.0.1",
+    "prompt-toolkit>=3.0.50",
+    "requests>=2.32.3",
+    "rich>=13.9.4",
+    "typer>=0.15.2",
+]
+[project.urls]
+Homepage = "https://github.com/belingud/yaicli"
+Repository = "https://github.com/belingud/yaicli"
+Documentation = "https://github.com/belingud/yaicli"
+
+[project.scripts]
+ai = "yaicli:app"
+
+[tool.uv]
+resolution = "highest"
+
+[dependency-groups]
+dev = ["bump2version>=1.0.1", "pytest>=8.3.5", "ruff>=0.11.2"]
+
+[tool.ruff]
+line-length = 120
+select = ["E", "F", "W", "I", "B", "C90"]
+ignore = ["E501"]
+
+
+[build-system]
+requires = ["hatchling>=1.18.0"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+exclude = ["test_*.py", "tests/*", ".gitignore"]
+include = ["yaicli.py", "pyproject.toml"]

{yaicli-0.0.7.dist-info → yaicli-0.0.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yaicli
-Version: 0.0.7
+Version: 0.0.10
 Summary: A simple CLI tool to interact with LLM
 Project-URL: Homepage, https://github.com/belingud/yaicli
 Project-URL: Repository, https://github.com/belingud/yaicli
@@ -223,7 +223,14 @@ 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) like ChatGPT's gpt-4o through your terminal. It offers multiple operation modes for everyday conversations, generating and executing shell commands, and one-shot quick queries.
+[![PyPI version](https://img.shields.io/pypi/v/yaicli?style=for-the-badge)](https://pypi.org/project/yaicli/)
+![GitHub License](https://img.shields.io/github/license/belingud/yaicli?style=for-the-badge)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/yaicli?logo=pypi&style=for-the-badge)
+![Pepy Total Downloads](https://img.shields.io/pepy/dt/yaicli?style=for-the-badge&logo=python)
+
+YAICLI is a compact yet potent command-line AI assistant, allowing you to engage with Large Language Models (LLMs) such as ChatGPT's gpt-4o directly via your terminal. It offers multiple operation modes for everyday conversations, generating and executing shell commands, and one-shot quick queries.
+
+Support regular and deep thinking models.
 
 > [!WARNING] 
 > This is a work in progress, some features could change or be removed in the future.
@@ -252,6 +259,9 @@ YAICLI is a powerful command-line AI assistant tool that enables you to interact
 - **Keyboard Shortcuts**:
   - Tab to switch between Chat and Execute modes
 
+- **History**:
+  - Save and recall previous queries
+
 ## Installation
 
 ### Prerequisites
@@ -291,6 +301,7 @@ The default configuration file is located at `~/.config/yaicli/config.ini`. Look
 
 ```ini
 [core]
+PROVIDER=OPENAI
 BASE_URL=https://api.openai.com/v1
 API_KEY=your_api_key_here
 MODEL=gpt-4o
@@ -322,6 +333,58 @@ Below are the available configuration options and override environment variables
 - **ANSWER_PATH**: Json path expression to extract answer from response, default: choices[0].message.content, env: AI_ANSWER_PATH
 - **STREAM**: Enable/disable streaming responses, default: true, env: AI_STREAM
 
+Default config of `COMPLETION_PATH` and `ANSWER_PATH` is OpenAI compatible. If you are using OpenAI or other OpenAI compatible LLM provider, you can use the default config.
+
+If you wish to use other providers that are not compatible with the openai interface, you can use the following config:
+
+- claude:
+  - BASE_URL: https://api.anthropic.com/v1
+  - COMPLETION_PATH: /messages
+  - ANSWER_PATH: content.0.text
+- cohere:
+  - BASE_URL: https://api.cohere.com/v2
+  - COMPLETION_PATH: /chat
+  - ANSWER_PATH: message.content.[0].text
+- google:
+  - BASE_URL: https://generativelanguage.googleapis.com/v1beta/openai
+  - COMPLETION_PATH: /chat/completions
+  - ANSWER_PATH: choices[0].message.content
+
+You can use google OpenAI complete endpoint and leave `COMPLETION_PATH` and `ANSWER_PATH` as default. BASE_URL: https://generativelanguage.googleapis.com/v1beta/openai. See https://ai.google.dev/gemini-api/docs/openai
+
+Claude also has a testable OpenAI-compatible interface, you can just use Calude endpoint and leave `COMPLETION_PATH` and `ANSWER_PATH` as default. See: https://docs.anthropic.com/en/api/openai-sdk
+
+If you not sure how to config `COMPLETION_PATH` and `ANSWER_PATH`, here is a guide:
+1. **Find the API Endpoint**:
+   - Visit the documentation of the LLM provider you want to use.
+   - Find the API endpoint for the completion task. This is usually under the "API Reference" or "Developer Documentation" section.
+2. **Identify the Response Structure**:
+   - Look for the structure of the response. This typically includes fields like `choices`, `completion`, etc.
+3. **Identify the Path Expression**:
+   Forexample, claude response structure like this:
+   ```json
+      {
+      "content": [
+        {
+          "text": "Hi! My name is Claude.",
+          "type": "text"
+        }
+      ],
+      "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
+      "model": "claude-3-7-sonnet-20250219",
+      "role": "assistant",
+      "stop_reason": "end_turn",
+      "stop_sequence": null,
+      "type": "message",
+      "usage": {
+        "input_tokens": 2095,
+        "output_tokens": 503
+      }
+    }
+   ```
+    We are looking for the `text` field, so the path should be 1.Key `content`, 2.First obj `[0]`, 3.Key `text`. So it should be `content.[0].text`.
+
+
 ## Usage
 
 ### Basic Usage

yaicli-0.0.10.dist-info/RECORD

@@ -0,0 +1,7 @@
+pyproject.toml,sha256=A7V65XMQYQCKkQjQAblk0YfMu300eE2HkDXGf_85CZU,1451
+yaicli.py,sha256=jCM121KssbZWNAmC5-v-tVQtTUCfn_6MWOAC3KUuNys,18539
+yaicli-0.0.10.dist-info/METADATA,sha256=h-p0RxU90dWoFZeipw1RlXP1VnXmRoWo6gy9t0bUL1E,25860
+yaicli-0.0.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+yaicli-0.0.10.dist-info/entry_points.txt,sha256=gdduQwAuu_LeDqnDU81Fv3NPmD2tRQ1FffvolIP3S1Q,34
+yaicli-0.0.10.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+yaicli-0.0.10.dist-info/RECORD,,

yaicli.py

@@ -2,7 +2,6 @@ import configparser
 import json
 import platform
 import subprocess
-import time
 from os import getenv
 from os.path import basename, pathsep
 from pathlib import Path
@@ -30,7 +29,7 @@ Rules:
 5. Return NOTHING except the ready-to-run command"""
 
 DEFAULT_PROMPT = (
-    "You are yaili, a system management and programing assistant, "
+    "You are YAICLI, a system management and programing assistant, "
     "You are managing {_os} operating system with {_shell} shell. "
     "Your responses should be concise and use Markdown format, "
     "unless the user explicitly requests more details."
@@ -71,6 +70,7 @@ class CasePreservingConfigParser(configparser.RawConfigParser):
 class CLI:
     CONFIG_PATH = Path("~/.config/yaicli/config.ini").expanduser()
     DEFAULT_CONFIG_INI = """[core]
+PROVIDER=openai
 BASE_URL=https://api.openai.com/v1
 API_KEY=
 MODEL=gpt-4o
@@ -166,6 +166,50 @@ STREAM=true"""
             return "powershell.exe" if is_powershell else "cmd.exe"
         return basename(getenv("SHELL", "/bin/sh"))
 
+    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.
+        This method removes markdown formatting from the command.
+        It handles various formats including:
+        - Commands surrounded by ``` (plain code blocks)
+        - Commands with language specifiers like ```bash, ```zsh, etc.
+        - Commands with specific examples like ```ls -al```
+
+        example:
+        ```bash\nls -la\n``` ==> ls -al
+        ```zsh\nls -la\n``` ==> ls -al
+        ```ls -al``` ==> ls -al
+        ls -al ==> ls -al
+        ```\ncd /tmp\nls -la\n``` ==> cd /tmp\nls -la
+        ```bash\ncd /tmp\nls -la\n``` ==> cd /tmp\nls -la
+        """
+        if not command or not command.strip():
+            return ""
+
+        # Handle commands that are already without code blocks
+        if "```" not in command:
+            return command.strip()
+
+        # Handle code blocks with or without language specifiers
+        lines = command.strip().split("\n")
+
+        # Check if it's a single-line code block like ```ls -al```
+        if len(lines) == 1 and lines[0].startswith("```") and lines[0].endswith("```"):
+            return lines[0][3:-3].strip()
+
+        # Handle multi-line code blocks
+        if lines[0].startswith("```"):
+            # Remove the opening ``` line (with or without language specifier)
+            content_lines = lines[1:]
+
+            # If the last line is a closing ```, remove it
+            if content_lines and content_lines[-1].strip() == "```":
+                content_lines = content_lines[:-1]
+
+            # Join the remaining lines and strip any extra whitespace
+            return "\n".join(line.strip() for line in content_lines if line.strip())
+
     def post(self, message: list[dict[str, str]]) -> requests.Response:
         """Post message to LLM API and return response"""
         url = self.config.get("BASE_URL", "").rstrip("/") + "/" + self.config.get("COMPLETION_PATH", "").lstrip("/")
@@ -187,44 +231,75 @@ STREAM=true"""
             raise typer.Exit(code=1) from None
         return response
 
-    def _print(self, response: requests.Response, stream: bool = True) -> str:
-        """Print response from LLM and return full completion"""
+    def get_reasoning_content(self, delta: dict) -> Optional[str]:
+        # reasoning: openrouter
+        # reasoning_content: infi-ai/deepseek
+        for k in ("reasoning_content", "reasoning"):
+            if k in delta:
+                return delta[k]
+        return None
+
+    def _print_stream(self, response: requests.Response) -> str:
+        """Print response from LLM in streaming mode"""
         full_completion = ""
-        if stream:
-            with Live() as live:
-                for line in response.iter_lines():
-                    # Skip empty lines
-                    if not line:
-                        continue
+        in_reasoning = False
 
-                    # Process server-sent events
-                    data = line.decode("utf-8")
-                    if not data.startswith("data: "):
-                        continue
+        with Live() as live:
+            for line in response.iter_lines():
+                if not line:
+                    continue
+
+                data = line.decode("utf-8")
+                if not data.startswith("data: "):
+                    continue
 
-                    # Extract data portion
-                    data = data[6:]
-                    if data == "[DONE]":
-                        break
+                data = data[6:]
+                if data == "[DONE]":
+                    break
 
-                    # Parse JSON and update display
-                    try:
-                        json_data = json.loads(data)
-                        content = json_data["choices"][0]["delta"].get("content", "")
+                try:
+                    json_data = json.loads(data)
+                    if not json_data.get("choices"):
+                        continue
+
+                    delta = json_data["choices"][0]["delta"]
+                    reason = self.get_reasoning_content(delta)
+
+                    if reason is not None:
+                        # reasoning started
+                        if not in_reasoning:
+                            in_reasoning = True
+                            full_completion = "> Reasoning:\n> "
+                        full_completion += reason.replace("\n", "\n> ")
+                    else:
+                        # reasoning stoped
+                        if in_reasoning:
+                            in_reasoning = False
+                            full_completion += "\n\n"
+                        content = delta.get("content", "") or ""
                         full_completion += content
-                        live.update(Markdown(markup=full_completion), refresh=True)
-                    except json.JSONDecodeError:
-                        self.console.print("[red]Error decoding response JSON[/red]")
-                        if self.verbose:
-                            self.console.print(f"[red]Error: {data}[/red]")
+                    live.update(Markdown(markup=full_completion), refresh=True)
+                except json.JSONDecodeError:
+                    self.console.print("[red]Error decoding response JSON[/red]")
+                    if self.verbose:
+                        self.console.print(f"[red]Error: {data}[/red]")
+
+        return full_completion
 
-                    time.sleep(0.01)
+    def _print_non_stream(self, response: requests.Response) -> str:
+        """Print response from LLM in non-streaming mode"""
+        full_completion = jmespath.search(self.config.get("ANSWER_PATH", "choices[0].message.content"), response.json())
+        self.console.print(Markdown(full_completion))
+        return full_completion
+
+    def _print(self, response: requests.Response, stream: bool = True) -> str:
+        """Print response from LLM and return full completion"""
+        if stream:
+            # Streaming response
+            full_completion = self._print_stream(response)
         else:
             # Non-streaming response
-            full_completion = jmespath.search(
-                self.config.get("ANSWER_PATH", "choices[0].message.content"), response.json()
-            )
-            self.console.print(Markdown(full_completion))
+            full_completion = self._print_non_stream(response)
         self.console.print()  # Add a newline after the response to separate from the next input
         return full_completion
 
@@ -238,11 +313,22 @@ STREAM=true"""
             qmark = ""
         return [("class:qmark", qmark), ("class:question", " {} ".format(">"))]
 
+    def _check_history_len(self) -> None:
+        """Check history length and remove oldest messages if necessary"""
+        if len(self.history) > self.max_history_length:
+            self.history = self.history[-self.max_history_length :]
+
     def _run_repl(self) -> None:
         """Run REPL loop, handling user input and generating responses, saving history, and executing commands"""
         # Show REPL instructions
         self._setup_key_bindings()
-        self.console.print("[bold]Starting REPL loop[/bold]")
+        self.console.print("""
+██    ██  █████  ██  ██████ ██      ██
+ ██  ██  ██   ██ ██ ██      ██      ██
+  ████   ███████ ██ ██      ██      ██
+   ██    ██   ██ ██ ██      ██      ██
+   ██    ██   ██ ██  ██████ ███████ ██
+""")
         self.console.print("[bold]Press TAB to change in chat and exec mode[/bold]")
         self.console.print("[bold]Type /clear to clear chat history[/bold]")
         self.console.print("[bold]Type /his to see chat history[/bold]")
@@ -280,43 +366,35 @@ STREAM=true"""
             # Get response from LLM
             response = self.post(message)
             self.console.print("\n[bold green]Assistant:[/bold green]")
-            content = self._print(response, stream=self.config["STREAM"] == "true")
+            try:
+                content = self._print(response, stream=self.config["STREAM"] == "true")
+            except Exception as e:
+                self.console.print(f"[red]Error: {e}[/red]")
+                continue
 
             # Add user input and assistant response to history
             self.history.append({"role": "user", "content": user_input})
             self.history.append({"role": "assistant", "content": content})
 
             # Trim history if needed
-            if len(self.history) > self.max_history_length * 2:
-                self.history = self.history[-self.max_history_length * 2 :]
+            self._check_history_len()
 
             # Handle command execution in exec mode
             if self.current_mode == EXEC_MODE:
+                content = self._filter_command(content)
+                if not content:
+                    self.console.print("[bold red]No command generated[/bold red]")
+                    continue
                 self.console.print(f"\n[bold magenta]Generated command:[/bold magenta] {content}")
                 if Confirm.ask("Execute this command?", default=False):
-                    returncode = subprocess.call(content, shell=True)
-                    if returncode != 0:
-                        self.console.print(f"[bold red]Command failed with return code {returncode}[/bold red]")
+                    subprocess.call(content, shell=True)
 
         self.console.print("[bold green]Exiting...[/bold green]")
 
-    def run(self, chat: bool, shell: bool, prompt: str) -> None:
-        self.load_config()
-        if not self.config.get("API_KEY"):
-            self.console.print("[bold red]API key not set[/bold red]")
-            self.console.print(
-                "[bold red]Please set API key in ~/.config/yaicli/config.ini or environment variable[/bold red]"
-            )
-            raise typer.Exit(code=1)
+    def _run_once(self, prompt: str, shell: bool = False) -> None:
+        """Run once with given prompt"""
         _os = self.detect_os()
         _shell = self.detect_shell()
-
-        # Handle chat mode
-        if chat:
-            self.current_mode = CHAT_MODE
-            self._run_repl()
-            return
-
         # Create appropriate system prompt based on mode
         system_prompt = SHELL_PROMPT if shell else DEFAULT_PROMPT
         system_content = system_prompt.format(_os=_os, _shell=_shell)
@@ -330,10 +408,14 @@ STREAM=true"""
         # Get response from LLM
         response = self.post(message)
         self.console.print("\n[bold green]Assistant:[/bold green]")
-        content = self._print(response, stream=(not shell and self.config["STREAM"] == "true"))
+        content = self._print(response, stream=self.config["STREAM"] == "true")
 
         # Handle shell mode execution
         if shell:
+            content = self._filter_command(content)
+            if not content:
+                self.console.print("[bold red]No command generated[/bold red]")
+                return
             self.console.print(f"\n[bold magenta]Generated command:[/bold magenta] {content}")
             if Confirm.ask("Execute this command?", default=False):
                 returncode = subprocess.call(content, shell=True)
@@ -341,6 +423,24 @@ STREAM=true"""
                     self.console.print(f"[bold red]Command failed with return code {returncode}[/bold red]")
 
 
+    def run(self, chat: bool, shell: bool, prompt: str) -> None:
+        """Run the CLI"""
+        self.load_config()
+        if not self.config.get("API_KEY"):
+            self.console.print("[bold red]API key not set[/bold red]")
+            self.console.print(
+                "[bold red]Please set API key in ~/.config/yaicli/config.ini or environment variable[/bold red]"
+            )
+            raise typer.Exit(code=1)
+
+        # Handle chat mode
+        if chat:
+            self.current_mode = CHAT_MODE
+            self._run_repl()
+        else:
+            self._run_once(prompt, shell)
+
+
 @app.command()
 def main(
     ctx: typer.Context,

yaicli-0.0.7.dist-info/RECORD

@@ -1,6 +0,0 @@
-yaicli.py,sha256=Wsi6VWGw3FfCkl8d6AR6p3nY8QbdZM0bx8JXFNrfZP8,14538
-yaicli-0.0.7.dist-info/METADATA,sha256=EHpi_s3X6a31V6z2EuGQ9hOgh1Karxi07f-H6Vbeekg,23101
-yaicli-0.0.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-yaicli-0.0.7.dist-info/entry_points.txt,sha256=gdduQwAuu_LeDqnDU81Fv3NPmD2tRQ1FffvolIP3S1Q,34
-yaicli-0.0.7.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-yaicli-0.0.7.dist-info/RECORD,,