xberg

环境要求

• macOS/Linux 用户需安装 Homebrew
• Windows 用户需安装 Scoop
• 使用 Docker 模式需本地有 Docker 环境
• 作为 Rust 库使用需 Rust 项目与 tokio 异步运行时

安装与启动步骤

1. 1安装命令行工具

   在 macOS 或 Linux 上用 Homebrew 安装 xberg CLI。安装完成后即可使用 extract、serve、mcp 等 14 个命令。

   brew install xberg-io/tap/xberg

   复制

2. 2Windows 端安装

   Windows 用户通过 Scoop 安装同一二进制，两条命令需按顺序执行，第一条是添加 xberg 软件源。

   scoop bucket add xberg https://github.com/xberg-io/scoop-bucket
   scoop install xberg

   复制

3. 3拉取 Docker 镜像

   从 GitHub 容器仓库拉取最新镜像，容器可在 API、CLI、MCP 三种模式间选择运行，示例见官方 Docker 指南。

   docker pull ghcr.io/xberg-io/xberg:latest

   复制

4. 4提取单份文档

   用 extract 命令解析文档并输出内容，支持 101 种格式。把 document.pdf 换成你自己的文件路径即可。

   xberg extract document.pdf

   复制

5. 5启动 REST API

   以 HTTP POST 方式提供统一解析入口，返回 JSON 或 Markdown，支持大文件流式处理，监听 8000 端口。

   xberg serve --host 0.0.0.0 --port 8000

   复制

6. 6启动 MCP 服务

   以 stdio 传输启动 MCP 服务器，对外提供 9 个工具、3 个提示与 4 类资源，供 Claude、Cursor 等智能体调用。

   xberg mcp --transport stdio

   复制

7. 7配置 MCP 客户端

   把这段 JSON 加入 Claude Desktop 或 Cursor 的 MCP 配置文件，客户端就能自动拉起 xberg 服务。

   {
     "mcpServers": {
       "xberg": { "command": "xberg", "args": ["mcp"] }
     }
   }

   复制

8. 8作为 Rust 库调用

   在 Rust 项目中直接调用异步 extract 接口，需 tokio 运行时，完整示例见 README 的 Quick Start 段落。

   use xberg::{extract, ExtractInput, ExtractionConfig};
   
   #[tokio::main]
   async fn main() -> xberg::Result<()> {
       let config = ExtractionConfig::default();
       let output = extract(
           ExtractInput::from_uri("document.pdf"),
           &config
       ).await?;
   
       println!("{}", output.results[0].content);
       Ok(())
   }

   复制

关键配置

如何确认成功

运行 xberg version 能输出版本号即安装成功；serve 模式可发 POST 请求拿到 JSON/Markdown 结果。

常见问题

注意事项

• README 由 alef 工具自动生成，请勿直接编辑该文件。
• CLI 完整用法与 Docker 示例需查阅官方文档 docs.xberg.io 对应页面。
• Docker 镜像可在 API、CLI、MCP 三种模式下运行。