xiaozhou-chat 1.0.27 → 1.0.28

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.
Files changed (2) hide show
  1. package/README.md +72 -53
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,37 +1,48 @@
1
1
  # xiaozhou-chat
2
2
 
3
- CLI chatbot based on NewAPI with advanced features like Project Context, Multi-Profiles, and AI Tools.
4
- 基于 NewAPI 的高级命令行聊天工具，支持项目上下文感知、多环境配置及 AI 自动化工具。
3
+ ![NPM Version](https://img.shields.io/npm/v/xiaozhou-chat)
4
+ ![License](https://img.shields.io/npm/l/xiaozhou-chat)
5
+ ![Node Version](https://img.shields.io/node/v/xiaozhou-chat)
6
+
7
+ **A powerful CLI chatbot based on NewAPI, designed for developers.**
8
+ 基于 NewAPI 的高级命令行聊天工具，专为开发者打造。支持项目上下文感知、多环境配置、MCP 协议及 AI 自动化工具。
5
9
 
6
10
  ---
7
11
 
8
- ## ✨ 特性 (Features)
12
+ ## ✨ 核心特性 (Features)
13
+
14
+ ### 🤖 智能交互与开发
15
+ - **AI 编程助手**：内置文件读写 (`read_file`, `write_file`) 和命令执行 (`run_command`)，可让 AI 帮你重构代码、运行测试。
16
+ - **项目感知**：通过 `/scan` 自动扫描目录结构，智能读取 `package.json` 等关键文件，让 AI 瞬间理解项目全貌。
17
+ - **智能提交**：`/commit` 自动分析暂存区 (`git diff --cached`) 代码变更，生成符合 Conventional Commits 规范的提交信息。
18
+ - **上下文压缩**：`/compress` 利用 AI 对长对话进行深度摘要，保留关键技术细节与决策，大幅节省 Token。
19
+
20
+ ### ⚙️ 灵活配置与管理
21
+ - **多环境切换**：支持 Profiles (`/profile`)，一键在不同 API Key、模型或 BaseURL 之间切换（如：开发环境/生产环境）。
22
+ - **MCP 协议支持**：完整集成 [Model Context Protocol](https://modelcontextprotocol.io/)，可连接外部 MCP Server 扩展能力（如连接数据库、Notion 等）。
23
+ - **配置隔离**：支持项目级 (`./.newapi-chat-config.json`) 和全局级 (`~/.newapi-chat-config.json`) 配置文件，互不干扰。
9
24
 
10
- - **🤖 多模型/多环境管理**：支持通过 `/profile` (或 `/切换模型`) 快速切换不同的 API Key 和模型配置。
11
- - **📂 项目感知**：通过 `/scan` 自动扫描项目结构、读取 `package.json` 和 `README.md` (智能大文件摘要)，让 AI 理解你的项目。
12
- - **🛠️ AI 编程助手**：内置文件读写 (`read_file`, `write_file`) 和命令执行 (`run_command`) 工具，AI 可以帮你重构代码、运行测试。
13
- - **🛡️ 安全机制**：`write_file` 覆盖文件前自动创建 `.bak` 备份；敏感文件自动排除；网络请求失败自动指数退避重试。
14
- - **🚀 效率工具**：`/commit` 自动分析代码变更并生成 Git Commit Message；`/token` 实时监控上下文消耗。
15
- - **🎨 交互优化**：
16
- - **Ctrl+C 中断**：生成过程中按 `Ctrl+C` 仅中断当前输出，不退出程序。
17
- - **Markdown 渲染**：终端内完美渲染 Markdown（代码高亮、表格、粗体等）。
18
- - **Esc 快捷键**：按 `Esc` 清除当前输入，空行时按 `Esc` 退出程序。
19
- - **⚙️ 灵活配置**：支持全局配置及项目级配置文件 (`.newapi-chat-config.json`)，可随项目隔离环境。
20
- - **🔌 MCP 支持**：集成 Model Context Protocol，可连接外部 MCP Server 扩展能力。
25
+ ### 🛡️ 稳健与体验
26
+ - **环境自适应**：自动检测并清洗冲突的环境变量（如代理设置），内置指数退避重试机制，确保网络请求稳定。
27
+ - **极致体验**：
28
+ - **无缝打字**：防并发锁设计，解决 AI 生成时的光标跳动问题。
29
+ - **Markdown 渲染**：终端内完美渲染代码高亮、表格、粗体等。
30
+ - **快捷键支持**：`Ctrl+C` 优雅中断生成，`Esc` 快速清空输入。
31
+ - **安全写文件**：覆盖文件前自动创建 `.bak` 备份。
21
32
 
22
33
  ---
23
34
 
24
- ## 📦 安装与使用 (Installation & Usage)
35
+ ## 📦 安装 (Installation)
25
36
 
26
37
  ### 方式一：在当前项目中使用 (推荐)
27
- 无需全局安装，直接在你的项目中添加并初始化配置：
38
+ 无需全局安装，直接集成到你的项目中：
28
39
 
29
40
  1. **安装依赖**
30
41
  ```bash
31
42
  npm install xiaozhou-chat
32
43
  ```
33
44
 
34
- 2. **初始化配置** (自动在当前目录生成配置文件)
45
+ 2. **初始化配置**
35
46
  ```bash
36
47
  npx xiaozhou-chat init
37
48
  ```
@@ -42,7 +53,7 @@ CLI chatbot based on NewAPI with advanced features like Project Context, Multi-P
42
53
  ```
43
54
 
44
55
  ### 方式二：全局安装
45
- 如果你希望在任何目录下都能使用：
56
+ 如果你希望在任何目录下随时呼出 AI 助手：
46
57
 
47
58
  ```bash
48
59
  npm i -g xiaozhou-chat
@@ -51,72 +62,80 @@ xiaozhou-chat
51
62
 
52
63
  ---
53
64
 
54
- ## 💬 常用命令 (Commands)
65
+ ## 💬 命令指南 (Commands)
55
66
 
56
- 在对话中输入 `/` 开头的命令即可触发功能。支持中文别名。
67
+ 在对话中输入 `/` 开头的命令即可触发功能。
57
68
 
58
- ### 🔧 配置管理
59
- | 命令 | 中文别名 | 说明 |
69
+ ### � 效率工具
70
+ | 命令 | 别名 | 功能说明 |
60
71
  |---|---|---|
61
- | `/init` | `/初始化配置` | (交互式) 在当前目录生成 `.newapi-chat-config.json` |
62
- | `/config` | `/配置` | 查看或修改当前配置 (如 `/config set model gpt-4`) |
63
- | `/profile` | `/切换模型` | 管理多套配置 (详情见下文) |
64
- | `/system` | - | 设置系统提示词 (System Prompt) |
65
-
66
- ### 🧠 上下文与文件
67
- | 命令 | 中文别名 | 说明 |
72
+ | `/commit` | - | **AI 自动提交**：分析暂存区代码 -> 生成 Commit Message -> 确认提交 |
73
+ | `/compress` | - | **智能压缩**：AI 总结当前对话历史，释放 Token 空间 |
74
+ | `/scan` | `/当前项目结构` | 扫描并加载项目结构到上下文 |
75
+ | `/load <file>` | - | 加载指定文件内容（支持大文件行号选择） |
76
+ | `/paste` | - | 进入多行粘贴模式（输入 `---` 结束） |
77
+
78
+ ### � 配置与管理
79
+ | 命令 | 别名 | 功能说明 |
68
80
  |---|---|---|
69
- | `/scan` | `/当前项目结构` | 扫描当前目录结构并加载关键文件到上下文 |
70
- | `/load <file>` | - | 加载指定文件内容给 AI (支持大文件行号选择) |
71
- | `/save <file>` | - | 将 AI 回复中的代码块保存为本地文件 |
72
- | `/paste` | - | 进入多行粘贴模式 (避免回车直接发送) |
81
+ | `/config` | `/配置` | 查看或修改配置 (如 `/config apiKey sk-xxx`) |
82
+ | `/profile` | `/切换模型` | 切换配置环境 (如 `/profile use gpt4`) |
83
+ | `/init` | `/初始化配置` | 在当前目录生成配置文件 |
84
+ | `/system` | - | 设置系统提示词 (System Prompt) |
85
+ | `/mcp` | - | 查看已连接的 MCP 服务器状态 |
73
86
 
74
- ### 🛠️ 工具与扩展
87
+ ### 📊 其他
75
88
  | 命令 | 说明 |
76
89
  |---|---|
77
- | `/commit` | 自动执行 `git add -A` 并利用 AI 生成提交信息 |
78
- | `/token` | 查看当前会话 Token 估算与预警 |
79
- | `/compress` | 智能压缩对话历史，节省 Token |
80
- | `/mcp` | 管理 MCP 服务器连接 (如连接外部数据库工具) |
81
- | `/clear` | 清空当前对话历史 (保留 System Prompt) |
82
- | `/history` | 查看历史记录 (支持 Markdown 渲染) |
83
- | `/export` | 导出对话记录为 Markdown |
90
+ | `/token` | 查看当前 Token 消耗估算 |
91
+ | `/clear` | 清空对话历史 |
92
+ | `/history` | 查看最近的对话记录 |
93
+ | `/help` | 查看帮助菜单 |
84
94
 
85
95
  ---
86
96
 
87
97
  ## ⚙️ 配置文件 (Configuration)
88
98
 
89
- 工具会按以下优先级读取配置：
90
- 1. **项目级配置**：`./.newapi-chat-config.json` (推荐，由 `init` 生成)
91
- 2. **用户级配置**：`~/.newapi-chat-config.json`
99
+ 配置文件优先级：**项目级** > **全局级**。
92
100
 
93
- **配置文件示例 (`.newapi-chat-config.json`)：**
101
+ **`.newapi-chat-config.json` 示例：**
94
102
  ```json
95
103
  {
96
- "apiKey": "sk-xxxx",
104
+ "apiKey": "sk-your-api-key",
97
105
  "baseUrl": "https://api.newapi.pro/v1",
98
106
  "model": "claude-3-5-sonnet",
107
+ "systemPrompt": "你是一个资深的全栈工程师...",
99
108
  "profiles": {
100
109
  "default": { "model": "claude-3-5-sonnet" },
101
- "gpt4": { "model": "gpt-4", "apiKey": "sk-special..." }
110
+ "gpt4": { "model": "gpt-4", "apiKey": "sk-special-key..." },
111
+ "local": { "baseUrl": "http://localhost:11434/v1", "model": "llama3" }
112
+ },
113
+ "mcpServers": {
114
+ "filesystem": {
115
+ "command": "npx",
116
+ "args": ["-y", "@modelcontextprotocol/server-filesystem", "/Users/me/projects"]
117
+ }
102
118
  }
103
119
  }
104
120
  ```
105
121
 
106
- > **注意**：建议将 `.newapi-chat-config.json` 添加到 `.gitignore` 中，防止 API Key 泄露。
122
+ > **安全提示**：请务必将 `.newapi-chat-config.json` 添加到 `.gitignore` 中，防止密钥泄露。
107
123
 
108
124
  ---
109
125
 
110
126
  ## 🛠️ 本地开发 (Development)
111
127
 
112
- ### 依赖安装
113
128
  ```bash
129
+ # 安装依赖
114
130
  npm install
115
- ```
116
131
 
117
- ### 构建与打包
118
- - **Windows**: `npm run build:win` -> `dist/newapi-chat.exe`
119
- - **macOS**: `npm run build:mac` -> `dist/xiaozhou-chat`
132
+ # 链接到全局进行测试
133
+ npm link
134
+ xiaozhou-chat
135
+
136
+ # 构建可执行文件
137
+ npm run build:mac # or build:win
138
+ ```
120
139
 
121
140
  ---
122
141
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "xiaozhou-chat",
3
- "version": "1.0.27",
3
+ "version": "1.0.28",
4
4
  "description": "CLI chatbot based on NewAPI",
5
5
  "bin": {
6
6
  "xiaozhou-chat": "bin/cli.js"