Quickstart

五分钟跑起来

从克隆仓库到第一次对话,只需要四步。

环境要求

  • Python 3.11+(推荐用 uv 管理依赖)
  • Node.js 20+(构建 WebUI 前端用,start.sh 首次启动会自动安装并构建)
  • 任一模型 API Key(OpenAI / Anthropic / DeepSeek / 智谱等 100+ 提供商均可,经 litellm 统一接入)
  • macOS / Linux / Windows 全平台支持

① 克隆与安装

bash
git clone https://github.com/1292917512/AnelfAgent.git
cd AnelfAgent
uv sync

② 配置模型

bash
cp config/llm_clients.example.json config/llm_clients.json
cp config/app_config.example.json config/app_config.json
cp config/mcp_servers.example.json config/mcp_servers.json
# 编辑 llm_clients.json 填入 API Key(一个聊天模型 + 一个 embedding 模型即可起步)
# 也可以先全部跳过,启动后在 WebUI 配置中心点选填写,保存即热生效

③ 启动

bash
./start.sh
# 浏览器打开 → http://127.0.0.1:8092/webui/

④ 接入频道(可选)

按需启用频道适配器,让 AI 走进你的消息流:

频道方式说明
QQ 等适配器适配器可自主开发,按需接入消息平台并填入凭证
WebUI内置开箱即用,无需配置
HTTP / CLI内置API 与命令行直接对话
提示:启动后打开 WebUI 的「状态」面板可以看到所有实体(工具/模型/频道)的注册情况,哪一步没起来一眼就能定位。
下一步:读一读 核心能力 和 架构设计,了解怎么把 AnelfAgent 用出花来。