Skip to content
Browse documentationIndexing

Indexing commands

Signatures, flags and examples for recala index.

On this page

Use these commands

Check indexing status and submit content for indexing.

Examples assume you have signed in and selected the intended organization. Set shell variables such as ARTICLE_ID to ids from the corresponding list command. Set PUBLICATION_TIME to a future local time in YYYY-MM-DDTHH:MM format.

Badges describe the command’s strongest effect; a preview or read-only option may do less. Guarded writes can require confirmation even without --yes. “Needs a person” covers identity, consent and credentials.

recala index sitemaps show

The sitemaps Search Console holds for the site: health, errors, last read.

read Acts on an organization
recala index sitemaps show [OPTIONS]
Signature

Replace [OPTIONS] with the flags you need, or omit it.

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).
--orgNoOrganization name, slug or id (else RECALA_ORG, else recala org use).

Examples

Set the named shell variables to your own values before running.

recala index sitemaps show

Exit codes 0 OK 1 ERROR 2 USAGE 3 NOT_AUTHENTICATED 4 FORBIDDEN 5 NOT_FOUND 6 CONFLICT 7 INVALID 8 RATE_LIMITED 9 UNAVAILABLE 11 PAYMENT_REQUIRED

API commands share the CLI’s HTTP error mapping. Read human and JSON output rules.

recala index sitemaps submit

Resubmit the sitemap to Search Console (needs the connection's write scope; it offers the upgrade).

writes Acts on an organization
recala index sitemaps submit [OPTIONS]
Signature

Replace [OPTIONS] with the flags you need, or omit it.

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).
--orgNoOrganization name, slug or id (else RECALA_ORG, else recala org use).
--feedpathNoThe sitemap URL (default: the first one Search Console holds).

Examples

Run in your terminal with the intended organization selected.

recala index sitemaps submit --feedpath https://example.com/sitemap.xml

Exit codes 0 OK 1 ERROR 2 USAGE 3 NOT_AUTHENTICATED 4 FORBIDDEN 5 NOT_FOUND 6 CONFLICT 7 INVALID 8 RATE_LIMITED 9 UNAVAILABLE 10 CONFIRMATION_REQUIRED 11 PAYMENT_REQUIRED

API commands share the CLI’s HTTP error mapping. Read human and JSON output rules.

recala index status

Google's view of each article: indexed or not, coverage, last crawl, canonical, mobile (cached 24 h).

read Acts on an organization
recala index status ARTICLE_IDS [OPTIONS]
Signature

Replace uppercase arguments with your own values. Replace [OPTIONS] with the flags you need, or omit it.

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).
--orgNoOrganization name, slug or id (else RECALA_ORG, else recala org use).
--all-publishedNoEvery published article (at most 50).

Examples

Run in your terminal with the intended organization selected.

recala index status --all-published

Exit codes 0 OK 1 ERROR 2 USAGE 3 NOT_AUTHENTICATED 4 FORBIDDEN 5 NOT_FOUND 6 CONFLICT 7 INVALID 8 RATE_LIMITED 9 UNAVAILABLE 11 PAYMENT_REQUIRED

API commands share the CLI’s HTTP error mapping. Read human and JSON output rules.

recala index submit

Ping IndexNow (Bing, Yandex, ChatGPT search) for an article and re-check it; prints Google's Request-indexing link.

writes Acts on an organization
recala index submit ARTICLE_ID [OPTIONS]
Signature

Replace uppercase arguments with your own values. Replace [OPTIONS] with the flags you need, or omit it.

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).
--orgNoOrganization name, slug or id (else RECALA_ORG, else recala org use).

Examples

Set the named shell variables to your own values before running.

recala index submit "$ARTICLE_ID"

Exit codes 0 OK 1 ERROR 2 USAGE 3 NOT_AUTHENTICATED 4 FORBIDDEN 5 NOT_FOUND 6 CONFLICT 7 INVALID 8 RATE_LIMITED 9 UNAVAILABLE 10 CONFIRMATION_REQUIRED 11 PAYMENT_REQUIRED

API commands share the CLI’s HTTP error mapping. Read human and JSON output rules.

CLI reference
Search documentation