Quick Start

🚧 This page is a work in progress. English documentation is being translated.

Prerequisites

• Python 3.12+
• pip or uv
• AI Provider API Key

Installation

Linux / macOS

git clone https://github.com/Grabrun/YuanBot.git
cd YuanBot
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
yuanbot version

Windows

git clone https://github.com/Grabrun/YuanBot.git
cd YuanBot
python -m venv .venv
.venv\Scripts\activate
pip install -e ".\[dev]"
yuanbot version

Quick Start

yuanbot start

For detailed information, please refer to the Chinese documentation.

---

English translation coming soon. 🌸