Getting Started

How to get started with Xiaogpt

1

Clone Repository

Run `git clone https://github.com/yihong0618/xiaogpt` to download the source code.

2

Configure Environment

Set environment variables or create a config.yaml file with Xiaomi account credentials, hardware model, and API keys for LLMs such as OpenAI.

3

Run with Docker

Use the command `docker run -e OPENAI_API_KEY=<key> -e XIAOGPT_HOSTNAME=<host-ip> yihong0618/xiaogpt --account=<account> --password=<pass> --hardware=<model>` ensuring port 9527 is mapped.

4

Connect Xiaomi Speaker

Configure the Xiaomi AI Speaker to connect to the host IP and port 9527 for voice playback.

5

Test CLI

After installing dependencies via pdm or pip, run the `xiaogpt` CLI script to verify functionality.