Skip to content
Browse documentationRefresh

Refresh commands

Signatures, flags and examples for recala refresh.

On this page

Use these commands

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 refresh pause

Pause auto-refresh for one article.

writes Acts on an organization
recala refresh pause 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).
--orgNoCompany name, slug or id (else RECALA_ORG, else recala company use).
--dry-runNoSay what would change without changing it.

Examples

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

recala refresh pause "$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.

recala refresh resume

Resume auto-refresh for one article.

writes Acts on an organization
recala refresh resume 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).
--orgNoCompany name, slug or id (else RECALA_ORG, else recala company use).
--dry-runNoSay what would change without changing it.

Examples

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

recala refresh resume "$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.

recala refresh runs

Status of one refresh run.

read Acts on an organization
recala refresh runs REFRESH_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).
--orgNoCompany name, slug or id (else RECALA_ORG, else recala company use).

Examples

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

recala refresh runs "$REFRESH_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 11 PAYMENT_REQUIRED

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

recala refresh show

Auto-refresh setting, what is due, spend.

read Acts on an organization
recala refresh show [OPTIONS]
Signature

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

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

Examples

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

recala refresh 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.

CLI reference
Search documentation