xAgent 使用手册

English: README.en.md

这是 xAgent 官方使用手册项目，基于 Docusaurus、TypeScript 和 Markdown / MDX 构建。

内容定位：先介绍 xAgent 是一个多用户智能工作门户，并说明免费二进制版本用于产品体验和评估；再从功能入手说明菜单、任务、文件、工具、技能、外部连接、触发器和常见问题。技术实现细节、命令和配置只作为维护和定制时的补充，不作为主阅读路径。

本地开发

要求 Node.js 20+。

npm install
npm run start

构建

npm run build

本地预览构建产物

npm run serve

Cloudflare Workers 部署

当前仓库按 Cloudflare Workers Static Assets 部署。

Workers Git 构建配置：

Build command: npm run build
Deploy command: npx --yes wrangler@latest deploy
Build output directory: build
Root directory: /
Node version: 20 或更高

仓库根目录的 wrangler.jsonc 声明了 Worker 名称和静态资源目录：

{
  "name": "xagent-docs",
  "compatibility_date": "2026-07-07",
  "assets": {
    "directory": "./build"
  }
}

如果 Cloudflare 控制台中的 Worker 名称不是 xagent-docs，需要同步修改 wrangler.jsonc 中的 name。

Cloudflare Pages 部署

Cloudflare Pages 可使用以下配置：

Framework preset: Docusaurus 或 None
Build command: npm run build
Build output directory: build
Node version: 20

内容结构

• docs/getting-started/：项目介绍、快速开始和第一次使用路径。
• docs/user-guide/：面向用户的主要使用手册。
• docs/developer-guide/：扩展开发和维护说明，默认不放入普通用户阅读路径。
• docs/architecture/：技术参考和架构边界，默认不放入普通用户阅读路径。
• docs/reference/：命令、配置、术语和排错参考。

搜索

当前使用 @easyops-cn/docusaurus-search-local 提供本地搜索。修改插件配置或升级 Docusaurus 后，必须运行 npm run build 验证兼容性。