Xberg

crawlberg

Elixir bindings for crawlberg — a high-performance Rust web crawling engine. Uses Rustler NIFs for native BEAM integration with OTP-compatible error tuples and ResourceArc handles.

What This Package Provides

Same crawler as every binding — one Rust engine behind Python, Node.js, Ruby, Go, Java, .NET, PHP, Elixir, Dart, Kotlin Android, Swift, Zig, WASM, and C FFI.
Structured scrape output — HTML, Markdown, metadata, links, assets, response headers, and extraction warnings with consistent field names.
Crawl controls — depth, page limits, concurrency, URL filters, robots/sitemap handling, rate limits, and partial failure reporting.
Rendering path — optional browser rendering for JavaScript-heavy pages; direct HTTP path for fast static pages.
BEAM package — Rustler NIF binding with OTP-compatible error tuples.

Installation

def deps do
  [{:crawlberg, "~> 1.12.0"}]
end

Agent plugin

The crawlberg plugin is available via the xberg-io/crawlberg marketplace.

/plugin marketplace add xberg-io/crawlberg
/plugin install crawlberg@crawlberg

See the plugin guide for all supported runtimes, CLI prerequisites and standalone public skills.

Quick Start

# Simplest case: scrape a single page with default settings.
{:ok, engine} = Crawlberg.create_engine()
{:ok, scrape} = Crawlberg.scrape(engine, "https://example.com/")
IO.puts("Title: #{scrape.metadata.title}")
IO.puts("Status: #{scrape.status_code}")
IO.puts("Links found: #{length(scrape.links)}")

# Crawl from a seed URL, limited to one hop and a handful of pages.
config_json = Jason.encode!(%Crawlberg.CrawlConfig{max_depth: 1, max_pages: 5})
{:ok, crawl_engine} = Crawlberg.create_engine(config_json)
{:ok, crawl} = Crawlberg.crawl(crawl_engine, "https://en.wikipedia.org/wiki/Web_scraping")
IO.puts("Pages crawled: #{length(crawl.pages)}")

API Reference

Full API documentation is available at docs.crawlberg.xberg.io.

Key functions:

create_engine(config?) — Create a crawl engine with optional configuration
scrape(engine, url) — Scrape a single URL
crawl(engine, url) — Crawl a website following links
map_urls(engine, url) — Discover all pages on a site
batch_scrape(engine, urls) — Scrape multiple URLs concurrently
batch_crawl(engine, urls) — Crawl multiple seed URLs concurrently

Contributing

Contributions are welcome! Please see our Contributing Guide for details.

Part of Xberg.io

Xberg — the open-source content-intelligence engine: text, tables, and metadata from 101 formats (115 file extensions), with OCR, transcription, and code intelligence. MIT.
Xberg Pro — a complete self-hosted content-intelligence backend in a single container. Commercial.
Xberg Enterprise — the distributed, governed content-intelligence platform, scaled on Kubernetes with team governance and support. Commercial.
crawlberg — web crawling and scraping with HTML→Markdown and headless-Chrome fallback.
html-to-markdown — fast, lossless HTML→Markdown engine.
liter-llm — universal LLM API client with native bindings for 14 languages and 165 providers.
tree-sitter-language-pack — tree-sitter grammars and code-intelligence primitives.
alef — the polyglot binding generator that produces every per-language binding across the 5 polyglot repos.
Discord — community, roadmap, announcements.

License

This project is licensed under MIT License.