Skip to content

Commit

Permalink
docs: usage
Browse files Browse the repository at this point in the history
  • Loading branch information
sobird committed Feb 19, 2025
1 parent 531cb69 commit 773ca05
Showing 1 changed file with 37 additions and 7 deletions.
44 changes: 37 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,48 @@ Run your XiaoZhi AI on the terminal
[size]: https://packagephobia.com/badge?p=@sobird/xiaozhi
[size-url]: https://packagephobia.com/result?p=@sobird/xiaozhi

## 本地开发
## Usage

**Install [sox](https://sourceforge.net/projects/sox/)**

Configure sox environment variables

```sh
# 安装依赖
pnpm install
# installed successfully
sox --version
sox: SoX v
```

# 运行项目
pnpm start
**Install [Node.js](https://nodejs.org/)**
```sh
# installed successfully
node -v
v22.1.0
```

**Install XiaoZhi AI**

# 或者 将命令安装到全局
```sh
npm i -g @sobird/xiaozhi

# Run xzai on the terminal and start a chat
xzai
```
**Note:** Press the spacebar to start chatting(No need to keep pressing), Press the spacebar again to complete the voice input.


## Develop
```sh
# clone repo
git clone https://github.com/sobird/xiaozhi.git
# install deps
pnpm install
# start run
pnpm start
# or npm link to xzai cli to global
npm link

# 在终端运行
# Run on the terminal
xzai
```

Expand Down

0 comments on commit 773ca05

Please sign in to comment.