aisk 0.1.0__tar.gz

aisk-0.1.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: aisk
+Version: 0.1.0
+Summary: AI-powered terminal command assistant
+Author-email: it_zhouyu <497269678@qq.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: openai>=1.0.0
+
+# 🚀 Ask-CLI
+
+**让 AI 成为你的终端翻译官。** `Ask-CLI` 是一个极简的命令行工具，它可以将你的自然语言需求（中文或英文）直接转换为 macOS/Linux 终端命令。
+
+不再需要去 Google 或询问 ChatGPT “如何查找并杀死占用 8080 端口的进程”，只需输入：
+
+`ask "杀死8080端口进程"`
+
+---
+
+## ✨ 特性
+
+* **自然语言转命令**：基于大模型（默认支持通义千问 Qwen），精准生成 Shell 命令。
+* **一键执行**：生成命令后，**直接按回车（Enter）** 即可执行，极致流畅。
+* **安全确认**：支持按 `Esc` 或 `n` 快速取消，防止误操作。
+* **高度可配置**：支持自定义 API Key、Base URL 以及模型名称。
+* **极简安装**：符合 Python 标准打包规范，支持 `pip` 全局安装。
+
+---
+
+## 📦 安装
+
+### 1. 克隆并安装
+
+在本地克隆仓库后，进入项目根目录执行：
+
+```bash
+pip install .
+
+```
+
+### 2. 配置环境变量
+
+为了让工具正常工作，你需要配置以下环境变量（建议添加到你的 `~/.zshrc` 或 `~/.bash_profile` 中）：
+
+```bash
+# 必填：你的 API Key
+export ASK_API_KEY="your-api-key-here"
+
+# 选填：如果你使用中转站或阿里云 DashScope
+export ASK_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
+
+# 选填：指定使用的模型名称
+export ASK_MODEL_NAME="qwen-max"
+
+```
+
+最后执行 `source ~/.zshrc` 使配置生效。
+
+---
+
+## 🛠 使用说明
+
+直接在终端输入 `ask` 加上你的需求：
+
+```bash
+ask "查找当前目录下大于 100M 的文件"
+
+```
+
+### 交互快捷键：
+
+* **[Enter] 回车**：确认并立即执行推荐的命令（默认选项）。
+* **[Esc] 或 [n]**：取消执行并退出。
+* **其他任意键**：终止操作。
+
+---
+
+## 示例展示
+
+```text
+🔍 正在检索命令: 查看最近10条系统日志...
+
+💡 推荐命令: log show --last 10m | tail -n 10
+
+是否立即执行该命令? (Y/n): [用户按回车]
+Yes
+🚀 正在执行...
+... (命令输出内容)
+
+```
+
+---
+
+## 🤝 贡献与反馈
+
+如果你有任何想法、Bug 反馈或想要增加新功能，欢迎提交 **Issue** 或 **Pull Request**！
+
+1. Fork 本仓库
+2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交你的修改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启一个 Pull Request
+
+---
+
+## 📄 开源协议
+
+本项目采用 [MIT](https://www.google.com/search?q=LICENSE) 协议。
+
+---
+
+> **Tip:** 如果你在使用过程中发现生成的命令不符合预期，可以尝试在描述中增加更多上下文，比如 `ask "用 brew 安装 git 并且不交互"`。

aisk-0.1.0/README.md

@@ -0,0 +1,103 @@
+# 🚀 Ask-CLI
+
+**让 AI 成为你的终端翻译官。** `Ask-CLI` 是一个极简的命令行工具，它可以将你的自然语言需求（中文或英文）直接转换为 macOS/Linux 终端命令。
+
+不再需要去 Google 或询问 ChatGPT “如何查找并杀死占用 8080 端口的进程”，只需输入：
+
+`ask "杀死8080端口进程"`
+
+---
+
+## ✨ 特性
+
+* **自然语言转命令**：基于大模型（默认支持通义千问 Qwen），精准生成 Shell 命令。
+* **一键执行**：生成命令后，**直接按回车（Enter）** 即可执行，极致流畅。
+* **安全确认**：支持按 `Esc` 或 `n` 快速取消，防止误操作。
+* **高度可配置**：支持自定义 API Key、Base URL 以及模型名称。
+* **极简安装**：符合 Python 标准打包规范，支持 `pip` 全局安装。
+
+---
+
+## 📦 安装
+
+### 1. 克隆并安装
+
+在本地克隆仓库后，进入项目根目录执行：
+
+```bash
+pip install .
+
+```
+
+### 2. 配置环境变量
+
+为了让工具正常工作，你需要配置以下环境变量（建议添加到你的 `~/.zshrc` 或 `~/.bash_profile` 中）：
+
+```bash
+# 必填：你的 API Key
+export ASK_API_KEY="your-api-key-here"
+
+# 选填：如果你使用中转站或阿里云 DashScope
+export ASK_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
+
+# 选填：指定使用的模型名称
+export ASK_MODEL_NAME="qwen-max"
+
+```
+
+最后执行 `source ~/.zshrc` 使配置生效。
+
+---
+
+## 🛠 使用说明
+
+直接在终端输入 `ask` 加上你的需求：
+
+```bash
+ask "查找当前目录下大于 100M 的文件"
+
+```
+
+### 交互快捷键：
+
+* **[Enter] 回车**：确认并立即执行推荐的命令（默认选项）。
+* **[Esc] 或 [n]**：取消执行并退出。
+* **其他任意键**：终止操作。
+
+---
+
+## 示例展示
+
+```text
+🔍 正在检索命令: 查看最近10条系统日志...
+
+💡 推荐命令: log show --last 10m | tail -n 10
+
+是否立即执行该命令? (Y/n): [用户按回车]
+Yes
+🚀 正在执行...
+... (命令输出内容)
+
+```
+
+---
+
+## 🤝 贡献与反馈
+
+如果你有任何想法、Bug 反馈或想要增加新功能，欢迎提交 **Issue** 或 **Pull Request**！
+
+1. Fork 本仓库
+2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交你的修改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启一个 Pull Request
+
+---
+
+## 📄 开源协议
+
+本项目采用 [MIT](https://www.google.com/search?q=LICENSE) 协议。
+
+---
+
+> **Tip:** 如果你在使用过程中发现生成的命令不符合预期，可以尝试在描述中增加更多上下文，比如 `ask "用 brew 安装 git 并且不交互"`。

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

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: aisk
+Version: 0.1.0
+Summary: AI-powered terminal command assistant
+Author-email: it_zhouyu <497269678@qq.com>
+License: MIT
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: openai>=1.0.0
+
+# 🚀 Ask-CLI
+
+**让 AI 成为你的终端翻译官。** `Ask-CLI` 是一个极简的命令行工具，它可以将你的自然语言需求（中文或英文）直接转换为 macOS/Linux 终端命令。
+
+不再需要去 Google 或询问 ChatGPT “如何查找并杀死占用 8080 端口的进程”，只需输入：
+
+`ask "杀死8080端口进程"`
+
+---
+
+## ✨ 特性
+
+* **自然语言转命令**：基于大模型（默认支持通义千问 Qwen），精准生成 Shell 命令。
+* **一键执行**：生成命令后，**直接按回车（Enter）** 即可执行，极致流畅。
+* **安全确认**：支持按 `Esc` 或 `n` 快速取消，防止误操作。
+* **高度可配置**：支持自定义 API Key、Base URL 以及模型名称。
+* **极简安装**：符合 Python 标准打包规范，支持 `pip` 全局安装。
+
+---
+
+## 📦 安装
+
+### 1. 克隆并安装
+
+在本地克隆仓库后，进入项目根目录执行：
+
+```bash
+pip install .
+
+```
+
+### 2. 配置环境变量
+
+为了让工具正常工作，你需要配置以下环境变量（建议添加到你的 `~/.zshrc` 或 `~/.bash_profile` 中）：
+
+```bash
+# 必填：你的 API Key
+export ASK_API_KEY="your-api-key-here"
+
+# 选填：如果你使用中转站或阿里云 DashScope
+export ASK_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
+
+# 选填：指定使用的模型名称
+export ASK_MODEL_NAME="qwen-max"
+
+```
+
+最后执行 `source ~/.zshrc` 使配置生效。
+
+---
+
+## 🛠 使用说明
+
+直接在终端输入 `ask` 加上你的需求：
+
+```bash
+ask "查找当前目录下大于 100M 的文件"
+
+```
+
+### 交互快捷键：
+
+* **[Enter] 回车**：确认并立即执行推荐的命令（默认选项）。
+* **[Esc] 或 [n]**：取消执行并退出。
+* **其他任意键**：终止操作。
+
+---
+
+## 示例展示
+
+```text
+🔍 正在检索命令: 查看最近10条系统日志...
+
+💡 推荐命令: log show --last 10m | tail -n 10
+
+是否立即执行该命令? (Y/n): [用户按回车]
+Yes
+🚀 正在执行...
+... (命令输出内容)
+
+```
+
+---
+
+## 🤝 贡献与反馈
+
+如果你有任何想法、Bug 反馈或想要增加新功能，欢迎提交 **Issue** 或 **Pull Request**！
+
+1. Fork 本仓库
+2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交你的修改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启一个 Pull Request
+
+---
+
+## 📄 开源协议
+
+本项目采用 [MIT](https://www.google.com/search?q=LICENSE) 协议。
+
+---
+
+> **Tip:** 如果你在使用过程中发现生成的命令不符合预期，可以尝试在描述中增加更多上下文，比如 `ask "用 brew 安装 git 并且不交互"`。

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

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+aisk.egg-info/PKG-INFO
+aisk.egg-info/SOURCES.txt
+aisk.egg-info/dependency_links.txt
+aisk.egg-info/entry_points.txt
+aisk.egg-info/requires.txt
+aisk.egg-info/top_level.txt
+ask_cli/__init__.py
+ask_cli/main.py

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,2 @@
+[console_scripts]
+ask = ask_cli.main:main

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

@@ -0,0 +1 @@
+openai>=1.0.0

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

@@ -0,0 +1 @@
+ask_cli

aisk-0.1.0/ask_cli/main.py

@@ -0,0 +1,74 @@
+import os
+import sys
+import tty
+import termios
+from openai import OpenAI
+
+# 配置环境变量读取
+API_KEY = os.getenv("ASK_API_KEY")
+BASE_URL = os.getenv("ASK_BASE_URL", "https://dashscope.aliyuncs.com/compatible-mode/v1")
+MODEL_NAME = os.getenv("ASK_MODEL_NAME", "qwen-max")
+
+def get_char():
+    """读取单个字符，支持 Esc、回车和普通字母"""
+    fd = sys.stdin.fileno()
+    old_settings = termios.tcgetattr(fd)
+    try:
+        tty.setraw(sys.stdin.fileno())
+        ch = sys.stdin.read(1)
+    finally:
+        termios.tcsetattr(fd, termios.TCSADRAIN, old_settings)
+    return ch
+
+def get_command(nl_input):
+    if not API_KEY:
+        return "Error: 请配置环境变量 ASK_API_KEY"
+    
+    try:
+        client = OpenAI(api_key=API_KEY, base_url=BASE_URL)
+        response = client.chat.completions.create(
+            model=MODEL_NAME,
+            messages=[
+                {"role": "system", "content": "You are a macOS terminal expert. Return ONLY the shell command. No markdown, no explanation."},
+                {"role": "user", "content": nl_input}
+            ]
+        )
+        return response.choices[0].message.content.strip()
+    except Exception as e:
+        return f"Error: {str(e)}"
+
+def main():
+    if len(sys.argv) < 2:
+        print("用法: ask '你的需求'")
+        return
+
+    user_query = " ".join(sys.argv[1:])
+    print(f"🔍 正在检索命令: {user_query}...")
+
+    command = get_command(user_query)
+
+    if command.startswith("Error"):
+        print(f"❌ {command}")
+        return
+
+    print(f"\n💡 推荐命令: \033[1;32m{command}\033[0m")
+    
+    # 提示用户，Y 大写表示默认
+    print("\n是否立即执行该命令? (Y/n): ", end="", flush=True)
+
+    char = get_char()
+    
+    # \r 是回车，\n 是换行。如果用户直接按回车，或者输入 y/Y，则执行
+    if char in ('\r', '\n', 'y', 'Y'):
+        print("Yes") # 回显用户的选择
+        print("🚀 正在执行...\n")
+        os.system(command)
+    # 如果是 Esc (ASCII 27) 或 n/N，则取消
+    elif char in (chr(27), 'n', 'N'):
+        print("No")
+        print("\n已取消执行。")
+    else:
+        print("\n无效输入，已跳过。")
+
+if __name__ == "__main__":
+    main()

aisk-0.1.0/pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "aisk"
+version = "0.1.0"
+description = "AI-powered terminal command assistant"
+readme = "README.md"
+authors = [{ name = "it_zhouyu", email = "497269678@qq.com" }]
+license = { text = "MIT" }
+requires-python = ">=3.8"
+dependencies = [
+    "openai>=1.0.0",
+]
+
+[project.scripts]
+ask = "ask_cli.main:main"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"

aisk-0.1.0/setup.cfg

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