Skip to main content

Documentation Index

Fetch the complete documentation index at: https://algolia.com/llms.txt

Use this file to discover all available pages before exploring further.

Usage
algolia crawler test <crawler_id> --url <url> [-F <file>] [flags]

Examples

Test the URL “https://www.example.com” against the crawler with the ID “my-crawler”:
algolia crawler test my-crawler --url https://www.example.com
Test the URL “https://www.example.com” against the crawler with the ID “my-crawler” and override the configuration with the file “config.json”:
algolia crawler test my-crawler --url https://www.example.com -F config.json

Flags

-F, --config
The configuration file to use to override the crawler’s configuration. (use ”-” to read from standard input)
--dry-run
Validate and preview the test request without sending it
-u, --url
The URL to test.

Output formatting flags

--allow-missing-template-keys
If true, ignore errors in templates due to missing fields or map keys. This only applies to golang and jsonpath output formats.
-o, --output
Output format. One of: (json, jsonl, ndjson, jsonpath, jsonpath-as-json, jsonpath-file).
--template
Template string or path to a template file to use when —output=jsonpath, —output=jsonpath-file.
Last modified on May 12, 2026