xiaozhou-chat 1.0.4 → 1.0.7

package/README.md

@@ -1,162 +1,117 @@
-```markdown
 # xiaozhou-chat
 
-CLI chatbot based on NewAPI.
+CLI chatbot based on NewAPI with advanced features like Project Context, Multi-Profiles, and AI Tools.
+基于 NewAPI 的高级命令行聊天工具，支持项目上下文感知、多环境配置及 AI 自动化工具。
 
 ---
 
-## ✨ 特性
-- 基于 NewAPI 的命令行聊天工具
-- 支持自定义模型与 Base URL
-- 自动保存历史记录（项目根目录优先）
-- Node.js 18+ 支持
+## ✨ 特性 (Features)
 
----
-
-## 📦 安装
-
-全局安装：
-```bash
-npm i -g xiaozhou-chat
-```
+- **🤖 多模型/多环境管理**：支持通过 `/profile` (或 `/切换模型`) 快速切换不同的 API Key 和模型配置。
+- **📂 项目感知**：通过 `/scan` 自动扫描项目结构、读取 `package.json` 和 `README.md` (智能大文件摘要)，让 AI 理解你的项目。
+- **🛠️ AI 编程助手**：内置文件读写 (`read_file`, `write_file`) 和命令执行 (`run_command`) 工具，AI 可以帮你重构代码、运行测试。
+- **🛡️ 安全机制**：`write_file` 覆盖文件前自动创建 `.bak` 备份，防止代码丢失；网络请求失败自动指数退避重试。
+- **🚀 效率工具**：`/commit` 自动分析代码变更并生成 Git Commit Message；`/token` 实时监控上下文消耗。
+- **🎨 视觉优化**：支持 Markdown 渲染 (终端内显示粗体/颜色)，流式输出平滑打字机效果。
+- **⚙️ 灵活配置**：支持全局配置及项目级配置文件 (`.newapi-chat-config.json`)，可随项目隔离环境。
+- **🔌 MCP 支持**：集成 Model Context Protocol，可连接外部 MCP Server 扩展能力。
+- **📦 跨平台**：支持 macOS (DMG/Binary) 和 Windows 打包。
 
 ---
 
-## ⚙️ 配置
+## 📦 安装 (Installation)
 
-### 环境变量（推荐）
-必填：
+### 全局安装
 ```bash
-export NEWAPI_API_KEY="你的Key"
+npm i -g xiaozhou-chat
 ```
 
-可选：
+### 快速开始
+在任意终端输入：
 ```bash
-export NEWAPI_BASE_URL="https://api.newapi.pro/v1"
-export NEWAPI_MODEL="gpt-3.5-turbo"
+xiaozhou-chat
 ```
 
-### 配置说明表
-
-| 变量名 | 是否必填 | 说明 | 示例 |
-|---|---|---|---|
-| NEWAPI_API_KEY | 必填 | NewAPI 的 API Key | `sk-xxxx` |
-| NEWAPI_BASE_URL | 可选 | NewAPI 请求地址 | `https://api.newapi.pro/v1` |
-| NEWAPI_MODEL | 可选 | 默认模型 | `gpt-3.5-turbo` |
-
 ---
 
-## 📁 配置与历史记录位置
-
-**项目根目录判定规则：**
-从当前目录向上查找最近的 `package.json`，其所在目录为项目根目录。
-
-### ✅ 配置文件优先级
-1. 项目根目录：
-   - `.newapi-chat-config.json`
-   - `newapi-chat.config.json`
-2. 用户目录：
-   - `~/.newapi-chat-config.json`
-
-### ✅ 历史记录保存位置
-- 优先保存到项目根目录：
-  ```
-  <项目根>/.newapi-chat-history.json
-  ```
-- 无写入权限时回退：
-  ```
-  ~/.newapi-chat-history.json
-  ```
-
-### ✅ 历史导出（Markdown）
-- 优先导出到项目根目录：
-  ```
-  <项目根>/newapi-chat-history.md
-  ```
-- 无写入权限时回退：
-  ```
-  ~/newapi-chat-history.md
-  ```
+## 💬 常用命令 (Commands)
 
----
-
-## 🚀 使用
-
-### 基础启动
-```bash
-xiaozhou-chat
-```
+在对话中输入 `/` 开头的命令即可触发功能。支持中文别名。
 
-### 自定义模型与地址
-```bash
-xiaozhou-chat --model gpt-4 --base-url https://api.newapi.pro/v1
-```
-
----
-
-## 🧰 CLI 参数说明
+### 🔧 配置管理
+| 命令 | 中文别名 | 说明 |
+|---|---|---|
+| `/init` | `/初始化配置` | 在当前目录生成 `newapi-chat.config.json` 配置文件 |
+| `/config` | `/配置` | 查看或修改当前配置 (如 `/config set model gpt-4`) |
+| `/profile` | `/切换模型` | 管理多套配置 (详情见下文) |
+| `/system` | - | 设置系统提示词 (System Prompt) |
 
-| 参数 | 说明 | 示例 |
+### 🧠 上下文与文件
+| 命令 | 中文别名 | 说明 |
 |---|---|---|
-| --model | 指定模型 | `--model gpt-4` |
-| --base-url | 指定 API 地址 | `--base-url https://api.newapi.pro/v1` |
+| `/scan` | `/当前项目结构` | 扫描当前目录结构并加载关键文件到上下文 |
+| `/load <file>` | - | 加载指定文件内容给 AI |
+| `/save <file>` | - | 将 AI 回复中的代码块保存为本地文件 |
+| `/paste` | - | 进入多行粘贴模式 (避免回车直接发送) |
+
+### 🛠️ 工具与扩展
+| 命令 | 说明 |
+|---|---|
+| `/commit` | 自动执行 `git add -A` 并利用 AI 生成提交信息 |
+| `/token` | 查看当前会话 Token 估算与预警 (每次回复后自动显示真实消耗) |
+| `/compress` | 智能压缩对话历史，节省 Token |
+| `/mcp` | 管理 MCP 服务器连接 (如连接外部数据库工具) |
+| `/clear` | 清空当前对话历史 (保留 System Prompt) |
+| `/history` | 查看历史记录 (支持 Markdown 渲染) |
+| `/export` | 导出对话记录为 Markdown |
 
 ---
 
-## 💬 使用示例
-
-启动后输入内容即可对话：
+## 🤖 多环境配置 (Profiles)
 
-```
-$ xiaozhou-chat
-> 你好
-你好！有什么可以帮你？
-> 介绍一下 NewAPI
-NewAPI 是一个兼容 OpenAI 接口的网关服务...
-```
+支持保存多套配置（例如：开发环境用 `gpt-3.5`，生产环境用 `gpt-4`，或者区分不同的 API Key）。
 
-退出方式：
-- `Ctrl + C`
-- 或输入 `exit`
+**常用操作：**
+1. **查看列表**：`/profile list` 或 `/切换模型`
+2. **创建配置**：`/profile add gpt4` (复制当前配置为 gpt4)
+3. **切换配置**：`/profile use gpt4` 或 `/切换模型 gpt4`
 
 ---
 
-## 🪟 Windows 打包
+## ⚙️ 配置文件 (Configuration)
 
-安装 pkg：
-```bash
-npm i -g pkg
-```
-
-执行打包：
-```bash
-npm run build:win
-```
+工具会按以下优先级读取配置：
+1. **项目级配置**：`./newapi-chat.config.json` (推荐使用 `/init` 生成)
+2. **用户级配置**：`~/.newapi-chat-config.json`
 
-生成文件：
-```
-dist/newapi-chat.exe
-```
-
----
-
-## 🧩 脚本说明
-
-`package.json` 中包含：
+**配置文件示例 (`newapi-chat.config.json`)：**
 ```json
-"scripts": {
-  "build:win": "pkg . --targets node18-win-x64 --output dist/newapi-chat.exe"
+{
+  "apiKey": "sk-xxxx",
+  "baseUrl": "https://api.newapi.pro/v1",
+  "model": "claude-3-5-sonnet",
+  "profiles": {
+    "default": { "model": "claude-3-5-sonnet" },
+    "gpt4": { "model": "gpt-4", "apiKey": "sk-special..." }
+  }
 }
 ```
 
 ---
 
-## 🧾 依赖
+## 🛠️ 打包与构建 (Build)
+
+### 依赖安装
+```bash
+npm install
+```
 
-- minimist
+### 打包命令
+- **Windows**: `npm run build:win` -> `dist/newapi-chat.exe`
+- **macOS**: `npm run build:mac` -> `dist/xiaozhou-chat`
+- **macOS DMG**: `npm run pack:dmg` -> `release/xiaozhou-chat_1.0.0_x64.dmg`
 
 ---
 
 ## 📄 许可证
 MIT
-```