xiaozhi-client 1.9.1 → 1.9.2-beta.1

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.
package/README.md CHANGED
@@ -15,23 +15,6 @@
15
15
 
16
16
  <img src="https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docs/images/qq-group-qrcode.jpg" alt="QQ群" width="300"/>
17
17
 
18
- ## 快速开始
19
-
20
- 你可以阅读文档 [xiaozhi-client.shenjingnan.com](https://xiaozhi-client.shenjingnan.com) 快速上手!
21
-
22
- ![效果图](https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docs/images/preview.png)
23
-
24
- ## 目录
25
-
26
- 1. [Xiaozhi Client](#xiaozhi-client)
27
- 1. [目录](#目录)
28
- 2. [功能特色](#功能特色)
29
- 3. [快速上手](#快速上手)
30
- 1. [使用 Docker 运行](#使用-docker-运行)
31
- 7. [Web UI 配置界面](#web-ui-配置界面)
32
- 1. [功能特性](#功能特性)
33
- 2. [启动 Web UI](#启动-web-ui)
34
-
35
18
  ## 功能特色
36
19
 
37
20
  - 支持 小智(xiaozhi.me) 官方服务器接入点
@@ -45,8 +28,16 @@
45
28
  - 支持 通过模板创建 xiaozhi-client 项目 (xiaozhi create \<my-app\> --template hello-world)
46
29
  - 支持 后台运行(xiaozhi start -d)
47
30
 
31
+ ![Web UI 配置界面](https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docs/images/web-ui-preview.png)
32
+
33
+ ![效果图](https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docs/images/preview.png)
34
+
48
35
  ## 快速上手
49
36
 
37
+ 你可以阅读文档 [xiaozhi-client.shenjingnan.com](https://xiaozhi-client.shenjingnan.com) 快速上手!
38
+
39
+ ### 本地安装
40
+
50
41
  > 前置条件:请先完成 node:22(LTS) 与 pnpm 的安装
51
42
 
52
43
  ```bash
@@ -68,7 +59,7 @@ xiaozhi config set mcpEndpoint "<从小智服务端获取到的接入点地址>"
68
59
  # 启动服务
69
60
  xiaozhi start
70
61
 
71
- # 最后,请前往小智服务端,检查对应的接入点,刷新后是否能获取到工具列表
62
+ # 浏览器打开 http://localhost:9999 如果你使用的是NAS部署请使用 http://<部署设备的IP地址>:9999
72
63
  ```
73
64
 
74
65
  ### 使用 Docker 运行
@@ -119,37 +110,6 @@ docker-compose logs -f
119
110
  docker-compose down
120
111
  ```
121
112
 
122
- ## Web UI 配置界面
123
-
124
- xiaozhi-client 提供了一个现代化的 Web UI 界面,让配置 MCP 服务更加直观和便捷。
125
-
126
- ![Web UI 配置界面](https://raw.githubusercontent.com/shenjingnan/xiaozhi-client/main/docs/images/web-ui-preview.png)
127
-
128
- ### 功能特性
129
-
130
- - 🎨 **现代化界面**:基于 React + TypeScript + Tailwind CSS 构建
131
- - 🔧 **可视化配置**:直观的界面操作,无需手动编辑 JSON 文件
132
- - 🚀 **实时连接状态**:实时显示与小智服务器的连接状态
133
- - 📦 **MCP 服务管理**:
134
- - 添加/编辑/删除 MCP 服务
135
- - 支持本地服务和 SSE 服务
136
- - 支持批量导入配置
137
- - ⚙️ **配置管理**:
138
- - 编辑连接参数(心跳间隔、超时时间等)
139
- - 管理 ModelScope API Key
140
-
141
- ### 启动 Web UI
142
-
143
- ```bash
144
- # 启动 Web 配置界面
145
- xiaozhi ui
146
-
147
- # 或者在启动服务时同时启动 Web UI
148
- xiaozhi start -u
149
- ```
150
-
151
- 启动后访问 <http://localhost:9999> 进行可视化配置。
152
-
153
113
  ## 贡献者
154
114
 
155
115
  ![Contributors](https://contrib.rocks/image?repo=shenjingnan/xiaozhi-client&max=100&columns=10)