docs: 完善项目文档
- README.md: 重写中文文档，补充特性说明、项目结构、使用指南 - README.en.md: 重写英文文档，与中文版对齐 - CHANGELOG.md: 补充 v5.0.0 更新日志 - CONTRIBUTING.md: 新增贡献指南 - HELP.md: 更新使用指南，适配 v5.0.0
This commit is contained in:
shuiyu1123 committed
1 parent
139fce720c
commit
4b0c739c07
5 files changed
+714
-187
No files matched your search
@@ -1,80 +1,154 @@
|
||||
# 小狸 Pro-CLI 使用指南
|
||||
|
||||
## 基本操作
|
||||
|
||||
### 启动和退出
|
||||
- 启动程序: 运行 `python ai_cli.py`
|
||||
- 退出程序: 输入 `/quit`
|
||||
|
||||
### 帮助命令
|
||||
- `/help` - 显示帮助信息
|
||||
|
||||
## AI引擎管理
|
||||
|
||||
### 切换AI引擎
|
||||
- `/model spark` - 切换到讯飞星火AI引擎
|
||||
|
||||
## 聊天记录管理
|
||||
|
||||
### 保存聊天记录
|
||||
- `/chat save <名称>` - 将当前对话保存为指定名称的聊天记录
|
||||
|
||||
### 查看聊天记录
|
||||
- `/chat list` - 显示所有已保存的聊天记录
|
||||
|
||||
### 加载聊天记录
|
||||
- `/chat open <名称>` - 加载指定名称的聊天记录并继续对话
|
||||
|
||||
## 插件工具
|
||||
|
||||
AI可以自动调用以下工具来帮助您完成各种任务：
|
||||
|
||||
### 文件管理工具␍
|
||||
- 功能：读取、写入、追加、删除、复制、移动文件和目录操作␍
|
||||
- 用法示例：␍
|
||||
- `file_manager list` - 列出当前目录内容␍
|
||||
- `file_manager read test.txt` - 读取文件内容␍
|
||||
- `file_manager write test.txt 内容` - 写入文件␍
|
||||
- `file_manager append test.txt 内容` - 追加内容到文件␍
|
||||
- `file_manager delete test.txt` - 删除文件␍
|
||||
- `file_manager create test.txt` - 创建空文件␍
|
||||
- `file_manager mkdir new_dir` - 创建目录␍
|
||||
- `file_manager copy source.txt dest.txt` - 复制文件␍
|
||||
- `file_manager move source.txt dest.txt` - 移动文件␍
|
||||
- `file_manager info test.txt` - 查看文件信息␍
|
||||
- `file_manager tree` - 显示目录树结构␍
|
||||
␍
|
||||
### 音频播放工具␍
|
||||
- 功能：播放音频文件␍
|
||||
- 用法示例：␍
|
||||
- `audio_player play` - 播放Ciallo～(∠・ω- )⌒☆-.mp3音频文件␍
|
||||
- `/ciallo` - 播放音频文件␍
|
||||
␍
|
||||
## 基本操作命令␍
|
||||
␍
|
||||
### 系统信息命令␍
|
||||
- `/about` - 显示程序信息和版本详情␍
|
||||
␍
|
||||
## 使用技巧␍
|
||||
␍
|
||||
1. **自然语言交互**：直接用自然语言与AI对话，AI会理解您的意图并自动调用相应工具。␍
|
||||
␍
|
||||
2. **工具调用**：当AI需要执行特定任务时，会自动调用相应的插件工具，并在屏幕上显示执行结果。␍
|
||||
␍
|
||||
3. **聊天记录管理**：可以随时保存当前对话，在需要时加载之前的对话继续交流。␍
|
||||
␍
|
||||
4. **路径操作**：␍
|
||||
- 支持用户主目录下的绝对路径操作␍
|
||||
- 支持项目目录和当前目录下的相对路径操作␍
|
||||
- 文件大小限制为50MB␍
|
||||
␍
|
||||
5. **等待动画**：AI思考时会显示随机的温馨句子，每5秒更换一次。␍
|
||||
␍
|
||||
6. **插件命令**：可以使用 `/命令名` 直接调用插件功能，如 `/file`、`/read`、`/write`、`/ciallo` 等。␍
|
||||
␍
|
||||
## 注意事项␍
|
||||
␍
|
||||
- 请勿尝试访问系统关键目录（如Windows系统目录、/etc等）␍
|
||||
- 文件操作大小限制为50MB␍
|
||||
- 音频播放需要系统支持相应的音频格式␍
|
||||
- 可以随时使用 `/help` 命令查看帮助信息
|
||||
# 小狸 Pro-CLI 使用指南
|
||||
|
||||
## 快速上手
|
||||
|
||||
### 启动
|
||||
|
||||
```bash
|
||||
# TUI 模式（默认）
|
||||
python -m xiaoli
|
||||
|
||||
# CLI 模式
|
||||
python -m xiaoli --cli
|
||||
|
||||
# 指定引擎
|
||||
python -m xiaoli --engine ollama
|
||||
```
|
||||
|
||||
### 基本操作
|
||||
|
||||
- **退出程序**: 输入 `/quit` 或 `Ctrl+C`
|
||||
- **查看帮助**: 输入 `/help`
|
||||
- **查看版本**: 输入 `/about`
|
||||
|
||||
---
|
||||
|
||||
## AI 引擎管理
|
||||
|
||||
### 切换引擎
|
||||
|
||||
```
|
||||
/model ollama # 切换到 Ollama 本地模型
|
||||
/model mimo # 切换到小米 MiMo
|
||||
/model glm # 切换到智谱 GLM
|
||||
/model qwq # 切换到 QwQ 深度思考
|
||||
```
|
||||
|
||||
### 查看可用引擎
|
||||
|
||||
```
|
||||
/engine list
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 聊天记录管理
|
||||
|
||||
| 命令 | 说明 |
|
||||
|------|------|
|
||||
| `/chat save <名称>` | 保存当前对话 |
|
||||
| `/chat list` | 列出所有保存的对话 |
|
||||
| `/chat open <名称>` | 加载历史对话 |
|
||||
|
||||
---
|
||||
|
||||
## 内置工具
|
||||
|
||||
小狸会根据你的自然语言描述自动选择合适的工具。以下是主要工具：
|
||||
|
||||
### 代码编辑器 (`code_editor`)
|
||||
|
||||
用于精准的代码编辑操作：
|
||||
|
||||
- **替换代码** — 指定文件和要替换的内容
|
||||
- **批量编辑** — 一次修改多处
|
||||
- **查看代码** — 按行号范围查看
|
||||
|
||||
### 代码搜索 (`code_search`)
|
||||
|
||||
用于理解和搜索代码库：
|
||||
|
||||
- **项目结构** — 查看目录树
|
||||
- **搜索代码** — 按关键词搜索文件
|
||||
- **符号提取** — 提取函数、类定义
|
||||
- **代码统计** — 代码行数、文件数统计
|
||||
|
||||
### Git 操作 (`git_tools`)
|
||||
|
||||
- `status` — 查看状态
|
||||
- `diff` — 查看变更
|
||||
- `log` — 查看提交历史
|
||||
- `commit <消息>` — 提交更改
|
||||
|
||||
### 文件管理 (`file_manager`)
|
||||
|
||||
| 操作 | 说明 |
|
||||
|------|------|
|
||||
| `list` | 列出目录内容 |
|
||||
| `read <路径>` | 读取文件 |
|
||||
| `write <路径> -c "内容"` | 写入文件 |
|
||||
| `append <路径> -c "内容"` | 追加内容 |
|
||||
| `delete <路径>` | 删除文件 |
|
||||
| `mkdir <路径>` | 创建目录 |
|
||||
| `copy <源> <目标>` | 复制文件 |
|
||||
| `move <源> <目标>` | 移动文件 |
|
||||
| `info <路径>` | 查看文件信息 |
|
||||
| `tree` | 显示目录树 |
|
||||
|
||||
### 命令执行 (`cmd_executor`)
|
||||
|
||||
直接在沙箱中执行系统命令，支持超时控制。
|
||||
|
||||
### AI 搜索 (`ai_search`)
|
||||
|
||||
使用 AI 进行智能搜索和问答。
|
||||
|
||||
---
|
||||
|
||||
## 自然语言交互
|
||||
|
||||
你不需要记住命令格式，直接用自然语言描述需求即可：
|
||||
|
||||
```
|
||||
"帮我看看 src/app.py 的第 10 到 20 行"
|
||||
"搜索项目里所有用到 requests.get 的地方"
|
||||
"提交代码，消息是修复登录bug"
|
||||
"统计一下这个项目的代码量"
|
||||
```
|
||||
|
||||
AI 会自动理解你的意图并调用合适的工具。
|
||||
|
||||
---
|
||||
|
||||
## 远程连接
|
||||
|
||||
### 启动 WebSocket 服务
|
||||
|
||||
```
|
||||
/remote start <端口> <密码>
|
||||
```
|
||||
|
||||
### 代理模式
|
||||
|
||||
```
|
||||
/remote proxy <中继地址> <服务器密码> <本地端口> <本地密码>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 使用技巧
|
||||
|
||||
1. **TUI 模式** — 默认启动 TUI 图形界面，体验更好；使用 `--cli` 切换到传统模式
|
||||
2. **引擎选择** — 本地开发用 `ollama`，深度思考用 `qwq`，通用场景用 `mimo`
|
||||
3. **代码编辑** — 描述需求即可，AI 会自动使用代码编辑器
|
||||
4. **Git 工作流** — 自然语言描述，AI 自动执行 Git 操作
|
||||
5. **插件扩展** — 可以自行开发插件，详见 [开发文档](开发文档/开发文档.md)
|
||||
|
||||
---
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 文件操作大小限制为 50MB
|
||||
- 代码执行在沙箱环境中，有超时限制
|
||||
- 音频播放需要系统支持相应格式
|
||||
- TUI 模式需要安装 `textual` 和 `rich`
|
||||
Reference in new issue
Block a user