Skip to content
Webfold Docs
Esc
↑↓navigate↵open⌘Jpreview
On this page

Quickstart

Scrape a page, crawl a site and convert a document in a few commands.

These commands assume the webfold binary is on your PATH. Webfold has no public download yet, so see Install for the status.

1. Scrape one page

webfold scrape https://example.com
webfold scrape https://example.com --json | jq '{bytes_markdown, blocks_content}'

Progress output goes to stderr. With --json, exactly one JSON object is written to stdout, so it pipes straight into jq.

2. Convert saved HTML, no network

webfold md saved-page.html
webfold scrape ./saved-page.html --json

3. Crawl a site and fold the chrome

webfold crawl https://example.com --max 50
WEBFOLD_EMIT=1 webfold crawl ./saved-site     # print the clean Markdown too

crawl takes a URL or a directory of saved HTML. It reads each page once, counts block signatures across the set, and reports how many blocks were shared template chrome rather than content.

4. Convert a document

webfold convert report.docx
webfold pdf report.pdf
webfold chunk report.pdf --size 4000 --jsonl
webfold search "rust html to markdown" --count 10
webfold search "attention is all you need" --consensus --profile academic

6. Give an agent the same tools

./target/release/webfold-mcp     # stdio MCP server

Next: Scraping and conversion, Crawling and indexing, or the full CLI reference.