yaicli 0.0.3__tar.gz → 0.0.5__tar.gz

{yaicli-0.0.3 → yaicli-0.0.5}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.3
+current_version = 0.0.5
 commit = True
 tag = True
 

{yaicli-0.0.3 → yaicli-0.0.5}/CHANGELOG.md

@@ -1,4 +1,17 @@
 
+---
+## [0.0.4](https://github.com/belingud/yaicli/compare/v0.0.3..v0.0.4) - 2025-04-02
+
+### 🚜 Refactor
+
+- simplify multi-line statements for better readability - ([4870bb7](https://github.com/belingud/yaicli/commit/4870bb7460682791ca79bbe2bcc0cef94bf51c26)) - Belingud
+- rename ShellAI to yaicli and improve CLI help handling - ([dad0905](https://github.com/belingud/yaicli/commit/dad090540a7c1f8c8b30e3c688643a76e504b0c0)) - Belingud
+
+### ⚙️ Miscellaneous Tasks
+
+- update yaicli version to 0.0.3 - ([a689a02](https://github.com/belingud/yaicli/commit/a689a02b1c5e0cb278484267ef71f5f3acec8203)) - Belingud
+
+
 ---
 ## [0.0.3](https://github.com/belingud/yaicli/compare/v0.0.2..v0.0.3) - 2025-04-02
 

yaicli-0.0.5/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,230 @@
+# 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/README_wind.md

@@ -0,0 +1,195 @@
+# YAICLI - Your AI Command Line Interface
+
+YAICLI is a powerful command-line AI assistant tool that allows you to interact with Large Language Models (LLMs) through your terminal. It provides multiple operation modes for daily conversations, generating and executing shell commands, and quick one-time queries.
+
+## Features
+
+### Multiple Operation Modes
+
+1. **Chat Mode**
+   - Interactive conversation interface
+   - Markdown-formatted responses
+   - Streaming output display
+
+2. **Execute Mode**
+   - Automatically generates shell commands from natural language descriptions
+   - Detects current operating system and shell environment to generate appropriate commands
+   - Automatically filters unnecessary Markdown formatting from command output
+   - Confirmation mechanism before execution for safety
+
+3. **Temp Mode (One-shot)**
+   - Quick single queries without maintaining a session
+
+### Intelligent Environment Detection
+
+- Automatically detects operating system (Windows, MacOS, Linux and its distributions)
+- Automatically detects shell type (bash, zsh, PowerShell, cmd, etc.)
+- Customizes prompts and commands based on your environment
+
+### User Experience
+
+- Streaming response display for real-time AI output viewing
+- Keyboard shortcuts (e.g., Ctrl+I to switch modes)
+- Command confirmation mechanism to prevent accidental execution
+
+## Requirements
+
+- Python 3.9+
+- Supported operating systems: Windows, MacOS, Linux
+
+## Dependencies
+
+```
+configparser
+json
+platform
+subprocess
+time
+jmespath
+requests
+typer
+distro
+prompt_toolkit
+```
+
+## Installation
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/yourusername/yaicli.git
+   cd yaicli
+   ```
+
+2. Create virtual environment and install dependencies:
+   ```bash
+   uv sync
+   ```
+
+
+## Configuration
+
+The first time you run YAICLI, it will create a default configuration file at `~/.config/yaicli/config.ini`. You'll need to edit this file and add your API key.
+
+Example 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
+```
+
+## Usage
+
+### Basic Usage
+
+```bash
+# One-shot mode (default): Send a prompt and get a response
+ai "How do I check memory usage on a Linux system?"
+
+# Chat mode: Start an interactive chat session
+ai --chat
+
+# Execute mode: Generate and execute shell commands
+ai --shell "Create a directory named project and create src and docs subdirectories in it"
+
+# Enable verbose output
+ai --verbose "Explain how Docker works"
+```
+
+### Interactive Commands
+
+In chat or execute mode:
+
+- Press `Ctrl+I` to switch between chat and execute modes
+- Type `exit` or `quit` to exit the application
+
+### Mode Descriptions
+
+1. **Chat Mode (--chat)**
+   ```bash
+   ai --chat
+   ```
+   Starts an interactive session where you can converse with the AI. Responses will be displayed in Markdown format.
+
+2. **Execute Mode (--shell)**
+   ```bash
+   ai --shell "Find all files larger than 100MB"
+   ```
+   The AI will generate appropriate shell commands and execute them after your confirmation.
+
+3. **One-shot Mode (default)**
+   ```bash
+   ai "Explain the difference between TCP and UDP"
+   ```
+   Sends a single query, provides the response, and exits.
+
+## Advanced Usage
+
+### Custom System Recognition
+
+If you want to specify a particular operating system or shell, you can modify the configuration file:
+
+```ini
+[core]
+# ...other configuration...
+SHELL_NAME=bash  # Force bash shell command syntax
+OS_NAME=Ubuntu   # Force commands targeting Ubuntu
+```
+
+### Custom API Endpoint
+
+YAICLI uses the OpenAI API by default, but you can use compatible APIs by modifying the configuration:
+
+```ini
+[core]
+BASE_URL=https://your-api-endpoint/v1
+COMPLETION_PATH=/chat/completions
+ANSWER_PATH=custom.json.path.to.content
+```
+
+## Technical Implementation
+
+YAICLI is built using several Python libraries:
+
+- **Typer**: Provides the command-line interface
+- **prompt_toolkit**: Provides interactive command-line input experience
+- **requests**: Handles API requests
+- **jmespath**: Parses JSON responses
+
+## Limitations and Notes
+
+- Requires a valid OpenAI API key or compatible API
+- Commands generated in execute mode should be carefully reviewed before execution
+- API calls may incur charges depending on your service provider and model
+
+## Contributing
+
+Contributions of code, issue reports, or feature suggestions are welcome.
+
+## License
+
+Apache License 2.0
+
+---
+
+*YAICLI - Making your terminal smarter*