快速开始

环境要求

• Python 3.12+
• astral-uv — Python 包管理
• pnpm — WebUI 前端构建
• 一个 LLM API Key（OpenAI Compatible / DeepSeek / Claude / GLM 等）

安装

git clone https://github.com/AI1379/nahida-bot.git
cd nahida-bot

# 安装 Python 后端依赖
uv sync

# 如需 Telegram Channel，安装可选依赖
uv sync --group telegram

# WebUI 前端（可选，但推荐）
pnpm webui:build    # 输出到 webui/dist/，Gateway 启动时自动挂载

最小配置

复制 config.yaml 并填入你的 API 信息：

# config.yaml
app_name: "Nahida Bot"
log_level: "INFO"

providers:
  default:
    type: "openai-compatible"
    api_key: "${LLM_API_KEY}"
    base_url: "${LLM_BASE_URL}"
    stream_responses: true
    models:
      - "${LLM_MODEL}"

default_provider: default

telegram:
  bot_token: "${TELEGRAM_BOT_TOKEN}"

配置支持 ${VAR} 和 ${VAR:default} 环境变量插值，可选 .env 文件加载。完整配置参考请参阅 配置参考。

启动

uv run nahida-bot start

启动后可以通过 WebUI 访问 http://127.0.0.1:6185 管理面板。

CLI 命令

nahida-bot version                # 显示版本信息
nahida-bot start [--debug]        # 启动应用（含 Gateway + WebUI）
nahida-bot config                 # 显示当前配置
nahida-bot config schema          # 显示配置 schema（含插件 schema）
nahida-bot config validate        # 校验配置文件
nahida-bot doctor                 # 运行诊断检查
nahida-bot gateway                # 仅启动 Gateway（WebAPI + WebUI）

下一步

• 配置参考 — 完整的 YAML 配置说明
• 架构总览 — 了解 Nahida Bot 的分层架构设计
• 开发规范 — 代码风格、测试、类型检查规范
• 路线图 — 项目阶段规划与验收清单