Skip to content
Browse documentationTop-level commands
Markdown

CLI REFERENCE

Top-level commands commands

Signatures, flags and examples for commands you run directly.

On this page

Use these commands

Commands you run directly, with no subcommand.

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 calendar

What is scheduled to publish, by day, and what is ready to schedule.

read Acts on an organization
Signature
recala calendar [OPTIONS]

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).
--fromNoFirst day (default today).
--toNoLast day (default in 30 days; 93 at most).

Examples

See what is already scheduled before you plan the month.

Terminal
recala calendar

What is scheduled to publish, and when.

Terminal
recala calendar --from 2026-10-01 --to 2026-10-31

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 credits

Plan, articles left and when they reset, extras, caps; unlimited for an internal account.

read Acts on an organization
Signature
recala credits [OPTIONS]

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).
--spendNoAlso Recala's provider spend this month and today (owners).

Examples

See what the plan has left.

Terminal
recala credits

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 grant

Confirm every write for this sign-in at once (the [a]ll answer), so an agent can work without prompts.

needs a person
Signature
recala grant [OPTIONS]

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

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).
--statusNoShow whether writes are confirmed for this sign-in.
--revokeNoAsk before every write again.

Examples

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

Terminal
recala grant

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 login

Sign in: approve a one-time code in the browser (create an account at https://recala.co/register)

needs a person
Signature
recala login [OPTIONS]

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

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).
--with-tokenNoRead an API key or access token from standard input (for agents and CI).
--no-browserNoPrint the sign-in link without opening a browser.

Examples

Start a sign-in.

Terminal
recala login

Print the link without opening a browser, for a remote machine.

Terminal
recala login --no-browser

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 logout

End this machine's session on the server, then forget it here. An API key stays valid until revoked.

writes
Signature
recala logout [OPTIONS]

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

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).

Examples

End this machine's session and forget it here.

Terminal
recala logout

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 onboard

Create a company (es/en), read its site, add the signing author, connect its CMS, and scout topics.

needs a person Acts on an organization
Signature
recala onboard [OPTIONS]

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).
--applyNoApply the complete step, including in JSON mode.
--stepNoRun just this step (again).

Examples

Run in your terminal with the intended organization selected.

Terminal
recala onboard

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 plan

Preview each slot, topic and state; never generates, approves or publishes.

read Acts on an organization
Signature
recala plan [OPTIONS]

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).
--weeksNoNo description supplied by the CLI.

Examples

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

Terminal
recala plan

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 schema

Every command, its arguments and flags, and what each exit code means.

read
Signature
recala schema [OPTIONS]

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

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).

Examples

Read every command, argument, flag and exit code before acting.

Terminal
recala schema --json

Exit codes: 0 OK, 1 ERROR, 2 USAGE.

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

recala status

The active company at a glance: plan and caps, connections, questions, articles, calendar, onboarding.

read Acts on an organization
Signature
recala status [OPTIONS]

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.

Terminal
recala status

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 whoami

Who this credential is, which organizations it may act on, and the active one.

read Acts on an organization
Signature
recala whoami [OPTIONS]

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

Who you are signed in as, which organizations you may act on and which one is active.

Terminal
recala whoami

Who the agent acts as, and which organizations it may use.

Terminal
recala whoami --json

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