| name | wigolo-crawl |
| description | Local-first multi-page crawl with sitemap, BFS, DFS, and URL-map strategies, anchor-fragment dedup, rate limiting, robots.txt respect, and automatic local cache population. Use when the user wants to index documentation, crawl a docs site, extract all pages under a path, or says "crawl", "index this site", "get all the docs", "bulk extract". Prefer when crawled pages should land in a reusable local cache for later `cache` / `find_similar` queries.
|
| license | AGPL-3.0-only |
| metadata | {"author":"KnockOutEZ","version":"0.1.43-beta.2","homepage":"https://github.com/KnockOutEZ/wigolo","repository":"https://github.com/KnockOutEZ/wigolo"} |
wigolo crawl
Crawl sites with configurable strategy, depth, and rate limiting. All pages enter the local cache with embeddings.
Quick Reference
{ "url": "https://docs.example.com", "strategy": "sitemap", "max_pages": 30 }
{ "url": "https://example.com", "strategy": "bfs", "max_depth": 3, "max_pages": 50, "include_patterns": ["^https://example\\.com/docs"] }
{ "url": "https://example.com", "strategy": "map" }
{ "url": "https://app.example.com/docs", "strategy": "bfs", "use_auth": true, "max_pages": 20 }
Parameters
| Parameter | Type | Default | When to use |
|---|
url | string | required | Seed URL |
strategy | string | "bfs" | "sitemap" for doc sites, "map" for URL discovery only |
max_depth | number | 2 | How many link levels to follow |
max_pages | number | 20 | Hard cap on pages fetched |
include_patterns | string[] | none | Regex whitelist — ALWAYS add to stay in scope |
exclude_patterns | string[] | none | Regex blacklist |
use_auth | boolean | false | For authenticated sites |
extract_links | boolean | false | Return inter-page link graph |
max_total_chars | number | 100000 | Total char budget |
max_tokens_out | number | none | Token-budget cap (cl100k-base) |
include_full_markdown | boolean | false | Pages return evidence-only by default |
citation_format | string | "numbered" | "numbered" / "json" / "anthropic_tags" |
Pages are dedup'd by canonical URL (anchor-fragment aware: /intro and /intro#install collapse to one entry).
After Crawling
All crawled pages enter the local cache with embeddings. This means:
cache({ query: "..." }) finds content instantly (no network).find_similar({ url: "..." }) discovers related pages from cached content.- Future searches that hit cached URLs return instantly.
Crawl first, then use cache and find_similar for subsequent lookups.
Anti-Patterns
- DON'T crawl
max_pages: 100 without include_patterns — fetches nav/footer/sitemap noise.
- DON'T use BFS on large doc sites —
strategy: "sitemap" is faster and more complete.
- DON'T crawl when you need one page — use
fetch.
When NOT to use wigolo-crawl
- Login-required crawl beyond what
use_auth covers — handle authentication externally first, then crawl.
See Also
