aisk 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -39,7 +39,7 @@ def get_command(nl_input):
39
39
 
40
40
  def main():
41
41
  if len(sys.argv) < 2:
42
- print("用法: ask '你的需求'")
42
+ print("用法: aisk '你的需求'")
43
43
  return
44
44
 
45
45
  user_query = " ".join(sys.argv[1:])
@@ -0,0 +1,113 @@
1
+ Metadata-Version: 2.4
2
+ Name: aisk
3
+ Version: 0.1.1
4
+ Summary: AI-powered terminal command assistant
5
+ Author-email: it_zhouyu <497269678@qq.com>
6
+ License: MIT
7
+ Requires-Python: >=3.8
8
+ Description-Content-Type: text/markdown
9
+ Requires-Dist: openai>=1.0.0
10
+
11
+ # aisk 🚀
12
+
13
+ **aisk** 是一个基于 AI 的终端命令助手。只需用自然语言描述你的需求,它就能为你生成相应的 Shell 命令,并支持一键执行。
14
+
15
+ ## ✨ 特性
16
+
17
+ * **自然语言转命令**:不再需要苦记复杂的 `tar`、`find` 或 `ffmpeg` 参数。
18
+ * **交互式执行**:生成命令后,你可以选择立即执行、复制或取消。
19
+ * **高度可配置**:支持自定义 API Key、Base URL 以及模型(默认支持通义千问)。
20
+ * **轻量快捷**:基于 Python 开发,极速响应。
21
+
22
+ ---
23
+
24
+ ## 📦 安装
25
+
26
+ ### 方式 1:直接通过 PyPI 安装 (推荐)
27
+
28
+ 这是最简单的安装方式,适用于大多数用户:
29
+
30
+ ```bash
31
+ pip install aisk
32
+
33
+ ```
34
+
35
+ ### 方式 2:从源码安装
36
+
37
+ 如果你想参与开发或尝试最新版本:
38
+
39
+ ```bash
40
+ git clone https://github.com/it-zhouyu/aisk.git
41
+ cd aisk
42
+ pip install .
43
+
44
+ ```
45
+
46
+ ---
47
+
48
+ ## ⚙️ 配置
49
+
50
+ 在使用之前,请确保你已配置环境变量。建议将以下内容添加到你的 `.zshrc` 或 `.bash_profile` 中:
51
+
52
+ ```bash
53
+ # 必填:你的 API Key
54
+ export ASK_API_KEY="your_api_key_here"
55
+
56
+ # 选填:自定义 Base URL (默认为通义千问)
57
+ export ASK_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
58
+
59
+ # 选填:自定义模型 (默认为 qwen-max)
60
+ export ASK_MODEL_NAME="qwen-max"
61
+
62
+ ```
63
+
64
+ ---
65
+
66
+ ## 💡 使用方法
67
+
68
+ 直接在终端输入 `aisk` 加上你的需求:
69
+
70
+ ### 1. 查找文件
71
+
72
+ ```bash
73
+ aisk 帮我找到当前目录下所有大于 100MB 的 mp4 文件
74
+
75
+ ```
76
+
77
+ ### 2. 压缩/解压
78
+
79
+ ```bash
80
+ aisk 把当前文件夹打包成 tar.gz 格式,排除 node_modules
81
+
82
+ ```
83
+
84
+ ### 3. 系统操作
85
+
86
+ ```bash
87
+ aisk 查看并杀死占用 8080 端口的进程
88
+
89
+ ```
90
+
91
+ ---
92
+
93
+ ## 🛠 交互逻辑
94
+
95
+ 生成命令后,`aisk` 会提示:
96
+
97
+ * **Enter** 或 **Y**: 确认并立即执行命令。
98
+ * **N**: 取消执行。
99
+ * **Esc/其他**: 退出程序。
100
+
101
+ ---
102
+
103
+ ## 📄 开源协议
104
+
105
+ 本项目采用 [MIT](https://www.google.com/search?q=LICENSE) 协议。
106
+
107
+ ---
108
+
109
+ ### 🤝 贡献
110
+
111
+ 如果你有任何改进建议,欢迎提交 Issue 或 Pull Request!
112
+
113
+ **Made with ❤️ by [it_zhouyu**](mailto:497269678@qq.com)
@@ -0,0 +1,7 @@
1
+ aisk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
+ aisk/main.py,sha256=yba1SE-9oHqhc_FiOUqvcW-7hE3KXcuCHSCx37-TylE,2241
3
+ aisk-0.1.1.dist-info/METADATA,sha256=19MR51co-oaAX8TZe0nChqBvGsTdoWbe3LfCgStZYeM,2365
4
+ aisk-0.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
5
+ aisk-0.1.1.dist-info/entry_points.txt,sha256=L76aCeq2QjxrebdEnfW78_mrnS4O_S73UFqzn_RHp3w,40
6
+ aisk-0.1.1.dist-info/top_level.txt,sha256=ufRu-BYkWWaW_IPtlE7HelkdWNYZme5yQm4br8rk0_Y,5
7
+ aisk-0.1.1.dist-info/RECORD,,
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ aisk = aisk.main:main
@@ -0,0 +1 @@
1
+ aisk
@@ -1,113 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: aisk
3
- Version: 0.1.0
4
- Summary: AI-powered terminal command assistant
5
- Author-email: it_zhouyu <497269678@qq.com>
6
- License: MIT
7
- Requires-Python: >=3.8
8
- Description-Content-Type: text/markdown
9
- Requires-Dist: openai>=1.0.0
10
-
11
- # 🚀 Ask-CLI
12
-
13
- **让 AI 成为你的终端翻译官。** `Ask-CLI` 是一个极简的命令行工具,它可以将你的自然语言需求(中文或英文)直接转换为 macOS/Linux 终端命令。
14
-
15
- 不再需要去 Google 或询问 ChatGPT “如何查找并杀死占用 8080 端口的进程”,只需输入:
16
-
17
- `ask "杀死8080端口进程"`
18
-
19
- ---
20
-
21
- ## ✨ 特性
22
-
23
- * **自然语言转命令**:基于大模型(默认支持通义千问 Qwen),精准生成 Shell 命令。
24
- * **一键执行**:生成命令后,**直接按回车(Enter)** 即可执行,极致流畅。
25
- * **安全确认**:支持按 `Esc` 或 `n` 快速取消,防止误操作。
26
- * **高度可配置**:支持自定义 API Key、Base URL 以及模型名称。
27
- * **极简安装**:符合 Python 标准打包规范,支持 `pip` 全局安装。
28
-
29
- ---
30
-
31
- ## 📦 安装
32
-
33
- ### 1. 克隆并安装
34
-
35
- 在本地克隆仓库后,进入项目根目录执行:
36
-
37
- ```bash
38
- pip install .
39
-
40
- ```
41
-
42
- ### 2. 配置环境变量
43
-
44
- 为了让工具正常工作,你需要配置以下环境变量(建议添加到你的 `~/.zshrc` 或 `~/.bash_profile` 中):
45
-
46
- ```bash
47
- # 必填:你的 API Key
48
- export ASK_API_KEY="your-api-key-here"
49
-
50
- # 选填:如果你使用中转站或阿里云 DashScope
51
- export ASK_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"
52
-
53
- # 选填:指定使用的模型名称
54
- export ASK_MODEL_NAME="qwen-max"
55
-
56
- ```
57
-
58
- 最后执行 `source ~/.zshrc` 使配置生效。
59
-
60
- ---
61
-
62
- ## 🛠 使用说明
63
-
64
- 直接在终端输入 `ask` 加上你的需求:
65
-
66
- ```bash
67
- ask "查找当前目录下大于 100M 的文件"
68
-
69
- ```
70
-
71
- ### 交互快捷键:
72
-
73
- * **[Enter] 回车**:确认并立即执行推荐的命令(默认选项)。
74
- * **[Esc] 或 [n]**:取消执行并退出。
75
- * **其他任意键**:终止操作。
76
-
77
- ---
78
-
79
- ## 示例展示
80
-
81
- ```text
82
- 🔍 正在检索命令: 查看最近10条系统日志...
83
-
84
- 💡 推荐命令: log show --last 10m | tail -n 10
85
-
86
- 是否立即执行该命令? (Y/n): [用户按回车]
87
- Yes
88
- 🚀 正在执行...
89
- ... (命令输出内容)
90
-
91
- ```
92
-
93
- ---
94
-
95
- ## 🤝 贡献与反馈
96
-
97
- 如果你有任何想法、Bug 反馈或想要增加新功能,欢迎提交 **Issue** 或 **Pull Request**!
98
-
99
- 1. Fork 本仓库
100
- 2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)
101
- 3. 提交你的修改 (`git commit -m 'Add some AmazingFeature'`)
102
- 4. 推送到分支 (`git push origin feature/AmazingFeature`)
103
- 5. 开启一个 Pull Request
104
-
105
- ---
106
-
107
- ## 📄 开源协议
108
-
109
- 本项目采用 [MIT](https://www.google.com/search?q=LICENSE) 协议。
110
-
111
- ---
112
-
113
- > **Tip:** 如果你在使用过程中发现生成的命令不符合预期,可以尝试在描述中增加更多上下文,比如 `ask "用 brew 安装 git 并且不交互"`。
@@ -1,7 +0,0 @@
1
- ask_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
2
- ask_cli/main.py,sha256=ceOq_wU6hYqAWwYpi2Qyr5plIbbh5JtFp59DQCADT5Q,2240
3
- aisk-0.1.0.dist-info/METADATA,sha256=rei-Ldukb8BlBftr3XSUcsPrYclUlAMHvi9tOj7k_Ss,2961
4
- aisk-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
5
- aisk-0.1.0.dist-info/entry_points.txt,sha256=xwpa4ScYSXOh7nvwNoqjNqBW0VfhUfKcxD1gYkDqgAc,42
6
- aisk-0.1.0.dist-info/top_level.txt,sha256=TcsADgdq8gdCBpkOYf8yEPdhyhz-3UdF2vjJKyTU2js,8
7
- aisk-0.1.0.dist-info/RECORD,,
@@ -1,2 +0,0 @@
1
- [console_scripts]
2
- ask = ask_cli.main:main
@@ -1 +0,0 @@
1
- ask_cli
File without changes
File without changes