OpenRath

环境要求

• Python 环境（PyPI 包 openrath，需可执行 pip）
• pip 包管理器
• 运行 LLM 示例需 OpenAI 兼容的 API Key、Base URL 与模型名
• 运行 example/ 目录示例需先克隆源码仓库
• 源码开发方式需使用 uv 工具

安装与启动步骤

1. 1安装 OpenRath

   用 pip 从 PyPI 安装 openrath 主包，这是最基础的安装方式。

   pip install openrath

   复制

2. 2按需安装可选集成

   需要沙箱或外部记忆服务时再装，普通使用可跳过这两条命令。

   pip install "openrath[opensandbox]"
   pip install "openrath[openviking]"

   复制

3. 3克隆源码与示例

   想跑 example/ 学习阶梯必须克隆仓库，并按开发依赖同步环境。

   git clone https://github.com/Rath-Team/OpenRath.git
   cd OpenRath
   uv sync --group dev --group docs

   复制

4. 4配置模型访问

   大多数 LLM 示例使用 OpenAI 兼容环境变量，把示例值换成你自己的真实密钥与网关地址。

   export OPENAI_API_KEY=sk-...
   export OPENAI_BASE_URL=https://your-gateway/v1
   export OPENAI_DEFAULT_MODEL=your-model-name

   复制

5. 5运行第一个示例

   执行编号 01 的入门脚本，验证 Agent 能构建、调用并流式返回结果。

   python example/01_hello_agent.py

   复制

关键配置

如何确认成功

执行 python example/01_hello_agent.py，终端能看到 Agent 流式输出的回复且无报错，即表示安装与配置成功。

常见问题

注意事项

• 可选依赖 openrath[opensandbox] 与 openrath[openviking] 按需安装，不用可跳过。
• ~/.openrath/config.json 的具体字段 README 未给出，建议优先使用环境变量方式。
• example/ 是编号递进的学习阶梯，公共代码放在 _shared/ 中。
• 生产级完整场景见 Rath-Team/OpenRath-Example 仓库。