OPENX/DOCUMENTATION

把 Agent 用起来,
不用先读完源码。

从安装、模型路由到 SDK 和自托管。这里只保留真正需要的东西。

快速开始

OPENX Code 是最直接的使用方式:在一个已初始化的仓库中运行 openx,用自然语言描述任务,Agent 会读取项目、修改文件并运行验证命令。

当前版本:v0.3 · Stage 1。接口和配置仍可能调整,模型能力由各 Provider 决定。

安装

$ npm install -g @openx/cli
$ cd your-project
$ openx init

从源码运行时:

$ node src/cli/openx.js --help

Provider 配置

OPENX 支持 MiniMax、OpenAI、Anthropic、DeepSeek 和 Ollama。配置放在 ~/.openx/config.toml,API Key 只通过环境变量或系统密钥管理注入。

[providers.minimax]
base_url = "https://api.minimaxi.com/v1"
api_key_env = "MINIMAX_API_KEY"
model = "MiniMax-M3"

[providers.ollama]
base_url = "http://127.0.0.1:11434/v1"
api_key_env = "OLLAMA_API_KEY"

命令行

  • openx:在当前仓库启动 Agent。
  • openx ask "解释这个包":只读分析,不修改文件。
  • openx "修复这个测试并运行":执行修改与验证。
  • openx --provider ollama:为本次任务指定 Provider。

Web IDE

Web IDE 适合团队和自托管环境。项目通过 HTTPS 上传,Agent 在服务端运行,代码默认不离开你的网络。

Desktop

Desktop 面向本地长任务和并行 Agent。安装包与版本记录见 桌面版下载页。

SDK

Stage 2 将开放 TypeScript SDK 和 JSON-RPC API,用于把 Thread / Turn / Item 嵌入自己的产品。

import { OpenX } from "@openx/sdk"

const openx = new OpenX({ locale: "zh-CN" })
await openx.run("重构登录页")

自托管

企业内网只需部署 Gateway,把 MiniMax 或 OpenAI 的企业端点接进来;本地模型走 Ollama。Server 默认关闭公网回传。

安全

Agent 只能在已批准的工作区写文件。危险命令、密钥读取和网络请求需要人工确认;API Key 不写入仓库、不进入日志。