aibash-wx 0.1.0__tar.gz

aibash_wx-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 github/W1412X
+
+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.
+

aibash_wx-0.1.0/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: aibash-wx
+Version: 0.1.0
+Summary: AI-powered shell command generator
+Author: github/W1412X
+License: MIT
+Project-URL: Homepage, https://github.com/W1412X/aibash
+Project-URL: Repository, https://github.com/W1412X/aibash
+Keywords: ai,bash,shell,command,generator
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Utilities
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>=5.4.1
+Requires-Dist: requests>=2.25.1
+Requires-Dist: urllib3>=1.26.0
+Dynamic: license-file
+
+# AIBash
+
+AI 驱动的 Shell 命令生成工具
+
+## 简介
+
+AIBash 是一个智能命令行工具，能够根据自然语言描述生成对应的 Shell 命令。支持 OpenAI API 和本地 Ollama 模型。
+
+**注意**: 命令行内的所有提示信息均为英文，以避免字符编码问题。文档提供中英文两种版本。
+
+## 功能特性
+
+- 🤖 **AI 命令生成**: 根据自然语言描述生成 Shell 命令
+- 🔄 **交互式选择**: 支持执行、修改或放弃生成的命令
+- 📝 **历史记录**: 保存命令执行历史和输出，提供上下文支持
+- ⚙️ **灵活配置**: 支持多种配置选项（模型、密钥、系统信息等）
+- 🌐 **多平台支持**: 支持 macOS、Windows、Linux
+- 🔌 **多模型支持**: 支持 OpenAI API 和 Ollama 本地模型
+
+## 安装
+
+### 从源码安装
+
+```bash
+git clone https://github.com/W1412X/aibash.git
+cd aibash
+pip install -e .
+```
+
+### 使用 pip 安装
+
+```bash
+pip install aibash
+```
+
+## 快速开始
+
+### 1. 配置
+
+首次使用前需要配置模型连接信息。配置文件位于 `~/.aibash/config.yaml`。
+
+#### OpenAI API 配置示例
+
+```yaml
+model:
+  provider: openai
+  api_base: https://api.openai.com/v1
+  api_key: your-api-key-here
+  model_name: gpt-3.5-turbo
+
+history:
+  enabled: true
+  max_records: 50
+  include_output: true
+
+system_info: "Linux 5.15.0 (x86_64)"
+use_default_prompt: true
+```
+
+#### Ollama 配置示例
+
+```yaml
+model:
+  provider: ollama
+  api_base: http://localhost:11434
+  api_key: ""  # Ollama 不需要密钥
+  model_name: llama2
+
+history:
+  enabled: true
+  max_records: 50
+  include_output: true
+
+system_info: "Linux 5.15.0 (x86_64)"
+use_default_prompt: true
+```
+
+### 2. 使用
+
+```bash
+# 基本用法
+aibash -l "列出当前目录下的所有文件"
+
+# 指定配置文件
+aibash --config /path/to/config.yaml -l "查找包含test的文件"
+
+# 查看帮助
+aibash -h
+
+# 初始化配置（首次使用）
+aibash --init
+
+# 查看命令历史
+aibash --history
+
+# 清空命令历史
+aibash --clear-history
+
+# 测试 AI 连接
+aibash --test
+```
+
+## 命令行选项
+
+- `-l, --lang QUERY`: 自然语言描述，用于生成 shell 命令
+- `--config PATH`: 指定配置文件路径（默认: ~/.aibash/config.yaml）
+- `--init`: 交互式初始化配置文件
+- `--history`: 查看命令执行历史
+- `--clear-history`: 清空命令执行历史
+- `--test`: 测试 AI 连接
+- `-h, --help`: 显示帮助信息
+- `-v, --version`: 显示版本信息
+
+生成命令后，你可以选择：
+
+- `[e]` 执行命令 - 直接执行生成的命令
+- `[c]` 复制到剪贴板 - 将命令复制到剪贴板
+- `[m]` 修改命令 - 修改命令后再执行
+- `[s]` 跳过/放弃 - 不执行命令
+- `[h]` 显示帮助 - 显示帮助信息
+
+## 配置说明
+
+### 模型配置
+
+- `provider`: 模型提供商 (`openai` 或 `ollama`)
+- `api_base`: API 基础 URL
+- `api_key`: API 密钥（Ollama 可为空）
+- `model_name`: 模型名称
+
+### 历史记录配置
+
+- `enabled`: 是否启用历史记录
+- `max_records`: 最大记录数
+- `include_output`: 是否包含命令输出
+- `history_file`: 历史记录文件路径（自动设置）
+
+### 其他配置
+
+- `system_info`: 系统信息（用于生成更准确的命令）
+- `custom_prompt`: 自定义 prompt 模板
+- `use_default_prompt`: 是否使用默认 prompt
+
+## 自定义 Prompt
+
+你可以自定义 prompt 模板来更好地控制 AI 的行为。在配置文件中设置 `custom_prompt`，并使用以下占位符：
+
+- `{system_info}`: 系统信息
+- `{history_context}`: 历史上下文
+- `{user_query}`: 用户查询
+
+示例：
+
+```yaml
+custom_prompt: |
+  你是一个专业的命令行助手。
+  系统: {system_info}
+  {history_context}
+  用户需求: {user_query}
+  请生成对应的shell命令：
+use_default_prompt: false
+```
+
+## 项目结构
+
+```
+aibash/
+├── aibash/
+│   ├── __init__.py
+│   ├── config.py          # 配置管理
+│   ├── ai_client.py       # AI 模型客户端
+│   ├── history.py         # 历史记录管理
+│   ├── interactive.py     # 交互式选择
+│   ├── prompt.py          # Prompt 管理
+│   └── main.py            # 主程序入口
+├── setup.py
+├── requirements.txt
+└── README.md
+```
+
+## 开发
+
+### 运行测试
+
+```bash
+python -m aibash.main -l "测试命令"
+```
+
+### 构建分发包
+
+```bash
+python setup.py sdist bdist_wheel
+```
+
+## 文档
+
+- [中文文档](README.md) - 本文档
+- [English Documentation](README_EN.md) - English version
+
+## 许可证
+
+MIT License
+
+## 作者
+
+github/W1412X
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+

aibash_wx-0.1.0/README.md

@@ -0,0 +1,211 @@
+# AIBash
+
+AI 驱动的 Shell 命令生成工具
+
+## 简介
+
+AIBash 是一个智能命令行工具，能够根据自然语言描述生成对应的 Shell 命令。支持 OpenAI API 和本地 Ollama 模型。
+
+**注意**: 命令行内的所有提示信息均为英文，以避免字符编码问题。文档提供中英文两种版本。
+
+## 功能特性
+
+- 🤖 **AI 命令生成**: 根据自然语言描述生成 Shell 命令
+- 🔄 **交互式选择**: 支持执行、修改或放弃生成的命令
+- 📝 **历史记录**: 保存命令执行历史和输出，提供上下文支持
+- ⚙️ **灵活配置**: 支持多种配置选项（模型、密钥、系统信息等）
+- 🌐 **多平台支持**: 支持 macOS、Windows、Linux
+- 🔌 **多模型支持**: 支持 OpenAI API 和 Ollama 本地模型
+
+## 安装
+
+### 从源码安装
+
+```bash
+git clone https://github.com/W1412X/aibash.git
+cd aibash
+pip install -e .
+```
+
+### 使用 pip 安装
+
+```bash
+pip install aibash
+```
+
+## 快速开始
+
+### 1. 配置
+
+首次使用前需要配置模型连接信息。配置文件位于 `~/.aibash/config.yaml`。
+
+#### OpenAI API 配置示例
+
+```yaml
+model:
+  provider: openai
+  api_base: https://api.openai.com/v1
+  api_key: your-api-key-here
+  model_name: gpt-3.5-turbo
+
+history:
+  enabled: true
+  max_records: 50
+  include_output: true
+
+system_info: "Linux 5.15.0 (x86_64)"
+use_default_prompt: true
+```
+
+#### Ollama 配置示例
+
+```yaml
+model:
+  provider: ollama
+  api_base: http://localhost:11434
+  api_key: ""  # Ollama 不需要密钥
+  model_name: llama2
+
+history:
+  enabled: true
+  max_records: 50
+  include_output: true
+
+system_info: "Linux 5.15.0 (x86_64)"
+use_default_prompt: true
+```
+
+### 2. 使用
+
+```bash
+# 基本用法
+aibash -l "列出当前目录下的所有文件"
+
+# 指定配置文件
+aibash --config /path/to/config.yaml -l "查找包含test的文件"
+
+# 查看帮助
+aibash -h
+
+# 初始化配置（首次使用）
+aibash --init
+
+# 查看命令历史
+aibash --history
+
+# 清空命令历史
+aibash --clear-history
+
+# 测试 AI 连接
+aibash --test
+```
+
+## 命令行选项
+
+- `-l, --lang QUERY`: 自然语言描述，用于生成 shell 命令
+- `--config PATH`: 指定配置文件路径（默认: ~/.aibash/config.yaml）
+- `--init`: 交互式初始化配置文件
+- `--history`: 查看命令执行历史
+- `--clear-history`: 清空命令执行历史
+- `--test`: 测试 AI 连接
+- `-h, --help`: 显示帮助信息
+- `-v, --version`: 显示版本信息
+
+生成命令后，你可以选择：
+
+- `[e]` 执行命令 - 直接执行生成的命令
+- `[c]` 复制到剪贴板 - 将命令复制到剪贴板
+- `[m]` 修改命令 - 修改命令后再执行
+- `[s]` 跳过/放弃 - 不执行命令
+- `[h]` 显示帮助 - 显示帮助信息
+
+## 配置说明
+
+### 模型配置
+
+- `provider`: 模型提供商 (`openai` 或 `ollama`)
+- `api_base`: API 基础 URL
+- `api_key`: API 密钥（Ollama 可为空）
+- `model_name`: 模型名称
+
+### 历史记录配置
+
+- `enabled`: 是否启用历史记录
+- `max_records`: 最大记录数
+- `include_output`: 是否包含命令输出
+- `history_file`: 历史记录文件路径（自动设置）
+
+### 其他配置
+
+- `system_info`: 系统信息（用于生成更准确的命令）
+- `custom_prompt`: 自定义 prompt 模板
+- `use_default_prompt`: 是否使用默认 prompt
+
+## 自定义 Prompt
+
+你可以自定义 prompt 模板来更好地控制 AI 的行为。在配置文件中设置 `custom_prompt`，并使用以下占位符：
+
+- `{system_info}`: 系统信息
+- `{history_context}`: 历史上下文
+- `{user_query}`: 用户查询
+
+示例：
+
+```yaml
+custom_prompt: |
+  你是一个专业的命令行助手。
+  系统: {system_info}
+  {history_context}
+  用户需求: {user_query}
+  请生成对应的shell命令：
+use_default_prompt: false
+```
+
+## 项目结构
+
+```
+aibash/
+├── aibash/
+│   ├── __init__.py
+│   ├── config.py          # 配置管理
+│   ├── ai_client.py       # AI 模型客户端
+│   ├── history.py         # 历史记录管理
+│   ├── interactive.py     # 交互式选择
+│   ├── prompt.py          # Prompt 管理
+│   └── main.py            # 主程序入口
+├── setup.py
+├── requirements.txt
+└── README.md
+```
+
+## 开发
+
+### 运行测试
+
+```bash
+python -m aibash.main -l "测试命令"
+```
+
+### 构建分发包
+
+```bash
+python setup.py sdist bdist_wheel
+```
+
+## 文档
+
+- [中文文档](README.md) - 本文档
+- [English Documentation](README_EN.md) - English version
+
+## 许可证
+
+MIT License
+
+## 作者
+
+github/W1412X
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+

aibash_wx-0.1.0/aibash/__init__.py

@@ -0,0 +1,9 @@
+"""
+AIBash - AI-powered shell command generator
+
+Author: github/W1412X
+"""
+
+__version__ = "0.1.0"
+__author__ = "github/W1412X"
+

aibash_wx-0.1.0/aibash/agents/__init__.py

@@ -0,0 +1,11 @@
+"""
+Agent 模块
+
+提供各种 AI Agent 实现
+"""
+
+from .openai_agent import OpenAIAgent
+from .ollama_agent import OllamaAgent
+from .agent_builder import AgentBuilder
+
+__all__ = ['OpenAIAgent', 'OllamaAgent', 'AgentBuilder']

aibash_wx-0.1.0/aibash/agents/agent_builder.py

@@ -0,0 +1,48 @@
+"""
+Agent Builder - 工厂模式创建 Agent
+"""
+
+from typing import Optional
+from ..interfaces.ai_agent import AIAgent
+from ..config import ModelConfig
+from .openai_agent import OpenAIAgent
+from .ollama_agent import OllamaAgent
+
+
+class AgentBuilder:
+    """Agent 构建器"""
+    
+    @staticmethod
+    def build_agent(config: ModelConfig, **kwargs) -> Optional[AIAgent]:
+        """
+        根据配置构建 Agent
+        
+        Args:
+            config: 模型配置
+            **kwargs: 额外参数（temperature, max_tokens, timeout）
+            
+        Returns:
+            AIAgent 实例
+        """
+        provider = config.provider.lower()
+        
+        if provider == "openai":
+            return OpenAIAgent(
+                api_base=config.api_base,
+                api_key=config.api_key,
+                model_name=config.model_name,
+                temperature=kwargs.get('temperature', 0.3),
+                max_tokens=kwargs.get('max_tokens', 500),
+                timeout=kwargs.get('timeout', 30)
+            )
+        elif provider == "ollama":
+            return OllamaAgent(
+                api_base=config.api_base,
+                model_name=config.model_name,
+                temperature=kwargs.get('temperature', 0.3),
+                max_tokens=kwargs.get('max_tokens', 500),
+                timeout=kwargs.get('timeout', 30)
+            )
+        else:
+            raise ValueError(f"Unsupported provider: {provider}")
+

aibash_wx-0.1.0/aibash/agents/ollama_agent.py

@@ -0,0 +1,158 @@
+"""
+Agent 实现 - Ollama
+"""
+
+from typing import Dict, Any
+import requests
+from requests.adapters import HTTPAdapter
+from urllib3.util.retry import Retry
+
+from ..interfaces.ai_agent import AIAgent
+
+
+class OllamaAgent(AIAgent):
+    """Ollama API Agent"""
+    
+    def __init__(
+        self,
+        api_base: str,
+        model_name: str,
+        temperature: float = 0.3,
+        max_tokens: int = 500,
+        timeout: int = 30
+    ):
+        """
+        初始化 Ollama Agent
+        
+        Args:
+            api_base: API 基础 URL
+            model_name: 模型名称
+            temperature: 温度参数
+            max_tokens: 最大 token 数
+            timeout: 超时时间
+        """
+        self.api_base = api_base.rstrip('/')
+        self.model_name = model_name
+        self.temperature = temperature
+        self.max_tokens = max_tokens
+        self.timeout = timeout
+        
+        # 创建带重试的 session
+        self.session = requests.Session()
+        retry_strategy = Retry(
+            total=3,
+            backoff_factor=1,
+            status_forcelist=[429, 500, 502, 503, 504]
+        )
+        adapter = HTTPAdapter(max_retries=retry_strategy)
+        self.session.mount("http://", adapter)
+        self.session.mount("https://", adapter)
+    
+    def generate_command(self, prompt: str, **kwargs) -> str:
+        """生成命令"""
+        # 优先尝试 OpenAI 兼容 API
+        openai_compat_url = f"{self.api_base}/v1/chat/completions"
+        
+        temperature = kwargs.get('temperature', self.temperature)
+        max_tokens = kwargs.get('max_tokens', self.max_tokens)
+        timeout = kwargs.get('timeout', self.timeout)
+        
+        try:
+            data = {
+                "model": self.model_name,
+                "messages": [
+                    {"role": "user", "content": prompt}
+                ],
+                "temperature": temperature,
+                "max_tokens": max_tokens
+            }
+            
+            response = self.session.post(
+                openai_compat_url,
+                json=data,
+                timeout=timeout
+            )
+            
+            if response.status_code == 200:
+                result = response.json()
+                content = result.get("choices", [{}])[0].get("message", {}).get("content", "")
+                if content:
+                    return self._extract_command(content)
+        except Exception:
+            pass  # 回退到传统 API
+        
+        # 使用传统 Ollama API
+        url = f"{self.api_base}/api/generate"
+        
+        data = {
+            "model": self.model_name,
+            "prompt": prompt,
+            "stream": False,
+            "options": {
+                "temperature": temperature,
+                "num_predict": max_tokens
+            }
+        }
+        
+        try:
+            response = self.session.post(
+                url,
+                json=data,
+                timeout=timeout
+            )
+            response.raise_for_status()
+            
+            result = response.json()
+            content = result.get("response", "")
+            
+            if not content:
+                raise Exception("AI returned empty content")
+            
+            return self._extract_command(content)
+            
+        except requests.exceptions.RequestException as e:
+            raise Exception(f"Ollama API request failed: {e}")
+        except Exception as e:
+            raise Exception(f"Failed to generate command: {e}")
+    
+    def test_connection(self) -> bool:
+        """测试连接"""
+        try:
+            # 检查模型是否存在
+            url = f"{self.api_base}/api/tags"
+            response = self.session.get(url, timeout=5)
+            if response.status_code == 200:
+                models = response.json().get("models", [])
+                model_names = [m.get("name", "") for m in models]
+                return self.model_name in model_names
+            return False
+        except Exception:
+            return False
+    
+    def get_model_info(self) -> Dict[str, Any]:
+        """获取模型信息"""
+        return {
+            "provider": "ollama",
+            "model": self.model_name,
+            "api_base": self.api_base
+        }
+    
+    def _extract_command(self, content: str) -> str:
+        """从 AI 输出中提取命令"""
+        content = content.strip()
+        
+        # 移除 markdown 代码块
+        if content.startswith("```"):
+            lines = content.split("\n")
+            if len(lines) > 1:
+                content = "\n".join(lines[1:])
+            if content.endswith("```"):
+                content = content[:-3]
+        
+        content = content.strip()
+        lines = content.split("\n")
+        command = lines[0].strip()
+        command = command.lstrip("$").lstrip(">").strip()
+        
+        return command
+