Skip to main content
Usage
algolia rules import <index> -F <file> [flags]

Examples

Import rules from the “rules.ndjson” file to the “MOVIES” index:
algolia rules import MOVIES -F rules.ndjson
Import rules from the standard input to the “MOVIES” index:
cat rules.ndjson | algolia rules import MOVIES -F -
Browse the rules in the “SERIES” index and import them to the “MOVIES” index:
algolia rules browse SERIES | algolia rules import MOVIES -F -
Import rules from the “rules.ndjson” file to the “MOVIES” index and don’t forward them to the index replicas:
algolia rules import MOVIES -F rules.ndjson -f=false

Flags

-c, --clear-existing-rules
Delete existing rules before importing new ones
-y, --confirm
Skip the confirmation prompt.
--dry-run
Validate and preview the import request without sending it
-F, --file
Import rules from a file (use ”-” to read from standard input)
-f, --forward-to-replicas
Whether to add the rules to replica indices
-w, --wait
wait for the operation to complete

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