文档智能框架

Installation

CLI & Deployment

<details> <summary><strong>CLI Tool</strong></summary>

brew install xberg-io/tap/xberg

Windows users can install the same binary through Scoop:

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

14 commands: extract, batch, detect, formats, version, cache, tree-sitter, doctor, serve, mcp, api, embed, chunk, and completions.

See CLI usage guide for detailed documentation.

</details>

<details> <summary><strong>Docker</strong></summary>

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

Run in API, CLI, or MCP modes. See Docker guide for examples.

</details>

<details> <summary><strong>REST API Server</strong></summary>

xberg serve --host 0.0.0.0 --port 8000

One POST endpoint handles all formats. Returns JSON or Markdown. Stream large files. See API server guide.

</details>

<details> <summary><strong>MCP Server</strong></summary>

xberg mcp --transport stdio

9 tools (extract, extract_batch, detect_mime_type, cache_stats, list_formats, cache_clear, get_version, cache_manifest, cache_warm). 3 prompts (extract_document, extract_with_ocr, semantic_search). 4 resources (formats, models, OCR languages, embedding presets).

Add to Claude Desktop or Cursor:

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

See MCP integration guide.

</details>

Deployment Modes

Quick Start

Extract text from a document:

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(())
}

Common use cases — see Quick start guide for language-specific examples, OCR, batch processing, and API configuration.

---

CLI Reference

<details> <summary><strong>All 14 commands</strong></summary>

Run xberg --help or xberg <command> --help for detailed options.

</details>

---

Language Packages

<details open> <summary><strong>Python</strong></summary>

pip install xberg

See Python README for full documentation.

</details>

<details> <summary><strong>Node.js / TypeScript</strong></summary>

npm install @xberg-io/xberg

See Node.js README for full documentation.

</details>

<details> <summary><strong>Rust</strong></summary>

cargo add xberg

See Rust README for full documentation.

</details>

<details> <summary><strong>Go</strong></summary>

go get github.com/xberg-io/xberg/packages/go@latest

⚠️ The repository root is not a Go module — go get github.com/xberg-io/xberg will fail. Always target the /packages/go subdirectory as shown above.

See Go README for full documentation.

</details>

<details> <summary><strong>Java</strong></summary>

Available on Maven Central as io.xberg:xberg. See Java README for the dependency snippet.

</details>

<details> <summary><strong>C#</strong></summary>

dotnet add package XbergIo.Xberg

See C# README for full documentation.

</details>

<details> <summary><strong>Ruby</strong></summary>

gem install xberg

See Ruby README for full documentation.

</details>

<details> <summary><strong>PHP</strong></summary>

composer require xberg-io/xberg

See PHP README for full documentation.

</details>

<details> <summary><strong>Elixir</strong></summary>

Add {:xberg, "~> 1.0"} to your mix.exs dependencies. See Elixir README for full documentation.

</details>

<details> <summary><strong>WebAssembly</strong></summary>

npm install @xberg-io/xberg-wasm

See WebAssembly README for full documentation.

</details>

<details> <summary><strong>Kotlin (Android)</strong></summary>

Available on Maven Central as io.xberg:xberg-android. See Kotlin README for the dependency snippet.

</details>

<details> <summary><strong>Swift</strong></summary>

Add via Swift Package Manager. See Swift README for full documentation.

</details>

<details> <summary><strong>Dart / Flutter</strong></summary>

dart pub add xberg

See Dart README for full documentation.

</details>

<details> <summary><strong>Zig</strong></summary>

Add via zig fetch. See Zig README for full documentation.

</details>

<details> <summary><strong>C/C++ (FFI)</strong></summary>

Build from source as part of this workspace. See C (FFI) README for full documentation.

</details>

Supported File Formats (107 formats · 141 file extensions · 56 MIME aliases)

107 formats across 140 unique file extensions, with 56 compatibility MIME aliases, intelligent format detection, and comprehensive metadata extraction.

Office Documents

Images (OCR-Enabled)

Audio & Video

Web & Data

Email & Archives

Academic & Scientific