wehub-resource-sync
130 lines
3.0 KiB
Plaintext
130 lines
3.0 KiB
Plaintext
---
|
|
title: "快速上手 - Xiaozhi Client"
|
|
description: "快速入门指南将会向你展示最快速的安装、配置、启动方式。"
|
|
---
|
|
|
|
# 快速上手
|
|
|
|
快速入门指南将会向你展示最快速的安装、配置、启动方式。
|
|
|
|
完成本指南后，你将拥有一个可以自由集成不同 MCP 的服务，允许你可有控制提供给小智的 MCP 工具。
|
|
|
|
<Callout type="info">
|
|
**前期准备**:
|
|
在开始之前，你至少需要有一个小智硬件设备，并已添加至小智官方服务端。
|
|
</Callout>
|
|
|
|
## 环境准备
|
|
|
|
请先安装好 node 与 pnpm。
|
|
|
|
<Callout type="info">如果你已经准备好 node & pnpm 可以跳过此步骤</Callout>
|
|
|
|
<Steps>
|
|
## 安装Node
|
|
请前往 [Node官方安装地址](https://nodejs.org/en/download) 进行安装，并验证安装是否成功。
|
|
|
|
以下为 node:24 + pnpm 的安装方式
|
|
|
|
<Tabs items={['macos / linux', 'windows']}>
|
|
<Tab>
|
|
```bash
|
|
# 下载并安装 nvm:
|
|
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
|
|
|
|
# 重启shell
|
|
\. "$HOME/.nvm/nvm.sh"
|
|
|
|
# 下载并安装 Node.js:
|
|
nvm install 22
|
|
|
|
# 验证 Node.js 版本:
|
|
node -v # 应该打印出 "v22.19.0".
|
|
|
|
# 下载并安装 pnpm:
|
|
corepack enable pnpm
|
|
|
|
# 验证 pnpm 版本:
|
|
pnpm -v
|
|
```
|
|
</Tab>
|
|
|
|
<Tab>
|
|
```bash
|
|
# 下载并安装 Chocolatey:
|
|
powershell -c "irm https://community.chocolatey.org/install.ps1|iex"
|
|
|
|
# 下载并安装 Node.js:
|
|
choco install nodejs --version="22.19.0"
|
|
|
|
# 验证 Node.js 版本:
|
|
node -v # 应该打印出 "v22.19.0".
|
|
|
|
# 下载并安装 pnpm:
|
|
corepack enable pnpm
|
|
|
|
# 验证 pnpm 版本:
|
|
pnpm -v
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## 安装 xiaozhi-client 命令行工具
|
|
<Tabs items={['pnpm', 'npm']}>
|
|
<Tab>
|
|
```bash
|
|
pnpm install -g xiaozhi-client
|
|
```
|
|
</Tab>
|
|
<Tab>
|
|
```bash
|
|
npm install -g xiaozhi-client
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## 创建应用
|
|
<Tabs items={['pnpm', 'npm']}>
|
|
<Tab>
|
|
```bash
|
|
# 创建应用
|
|
xiaozhi create my-app
|
|
|
|
# 进入应用目录
|
|
cd my-app
|
|
|
|
# 安装依赖
|
|
pnpm install
|
|
```
|
|
</Tab>
|
|
<Tab>
|
|
```bash
|
|
# 创建应用
|
|
xiaozhi create my-app
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## 设置小智接入点
|
|
小智AI配置MCP接入点的 [使用说明](https://ccnphfhqs21z.feishu.cn/wiki/HiPEwZ37XiitnwktX13cEM5KnSb)
|
|
|
|
`xiaozhi config set` 命令用于设置配置项，格式为 `<配置键名> <配置值>`。
|
|
|
|
```bash
|
|
# 设置 MCP 端点配置
|
|
xiaozhi config set mcpEndpoint "wss://api.xiaozhi.me/mcp/?token=YOUR_TOKEN"
|
|
```
|
|
|
|
<Callout type="info">
|
|
**提示**: 请从小智服务端获取实际的接入点地址，替换上面的示例 URL。
|
|
</Callout>
|
|
|
|
## 启动服务
|
|
```bash
|
|
xiaozhi start
|
|
```
|
|
|
|
## 验证是否成功
|
|
最后，请前往小智服务端，检查对应的接入点，刷新后是否能获取到工具列表
|
|
</Steps>
|