Skip to content
Browse documentationArticle

CLI REFERENCE

Article commands

Signatures, flags and examples for recala article.

On this page

Use these commands

Read, edit, review, approve, schedule and unpublish articles.

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 article approve

Approve the article: the named person signs it (a key needs publish; its owner is on record).

writes Acts on an organization Supports --yes
Signature
recala article approve ARTICLE_ID [OPTIONS]

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).
--yesNoOnly with an API key holding publish: approve, schedule or unpublish without a prompt.

Examples

Approve it in the named author's name; who ran the command is recorded. This is the signature, so confirm it in your terminal.

Terminal
recala article approve "$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 article comments

Comments left through the review link.

read Acts on an organization
Signature
recala article comments ARTICLE_ID [OPTIONS]

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.

Terminal
recala article comments "$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, 11 PAYMENT_REQUIRED.

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

recala article create

Write a new article from a topic. Uses one article of the plan; always previews the cost first.

writes Acts on an organization Supports --yes
Signature
recala article create [OPTIONS]

Replace [OPTIONS] with your flags. Include every flag marked Required in the table below.

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).
--orgNoOrganization name, slug or id (else RECALA_ORG, else recala org use).
--yesNoOnly with an API key holding publish: approve, schedule or unpublish without a prompt.
--topicYesThe topic id (recala topics list) to write.
--dry-runNoShow the cost preview and the balance; spend nothing.
--no-waitNoStart the run and return its id immediately.

Examples

Preview the cost and the balance. Nothing is spent.

Terminal
recala article create --topic "$TOPIC_ID" --dry-run

Write the article. It uses one article of the plan, so confirm it in your terminal.

Terminal
recala article create --topic "$TOPIC_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 article edit

Edit the text (--body-file), ask for an AI edit (--ai "notes"), or keep an AI draft (--apply).

writes Acts on an organization
Signature
recala article edit ARTICLE_ID [OPTIONS]

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).
--body-fileNoReplace the text with this Markdown file.
--aiNoAn AI edit: one note per --ai (a paid model call; 3 per article).
--waitNoWith --ai: wait until the AI draft is ready.
--timeoutNoNo description supplied by the CLI.
--applyNoKeep the finished AI draft's changes (all but --undo).
--undoNoWith --apply: comma-separated change numbers to undo, e.g. 2,5.

Examples

Run in your terminal with the intended organization selected.

Terminal
recala article edit "$ARTICLE_ID" --ai "Shorter introduction" --wait

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 article list

The company's articles, newest first.

read Acts on an organization
Signature
recala article list [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).
--limitNoNo description supplied by the CLI.
--offsetNoNo description supplied by the CLI.

Examples

Or name the organization for one command with --org.

Terminal
recala article list --org rebeam

Or set RECALA_ORG for a shell, a script or an agent.

Terminal
RECALA_ORG=rebeam recala article list

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 article person

Link the article to the named person who will sign it.

writes Acts on an organization
Signature
recala article person ARTICLE_ID [OPTIONS]

Replace uppercase arguments with your own values. Replace [OPTIONS] with your flags. Include every flag marked Required in the table below.

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).
--orgNoOrganization name, slug or id (else RECALA_ORG, else recala org use).
--personYesThe author (recala authors list) who signs this article.

Examples

Link the article to the real person who will sign it.

Terminal
recala article person "$ARTICLE_ID" --person "$AUTHOR_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 article recheck

Check an edited article again and show what still blocks approval.

writes Acts on an organization
Signature
recala article recheck ARTICLE_ID [OPTIONS]

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.

Terminal
recala article recheck "$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 article regenerate

Preview a held article's re-run cost, confirm, and wait for review or another hold.

writes Acts on an organization Supports --yes
Signature
recala article regenerate ARTICLE_ID [OPTIONS]

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).
--yesNoOnly with an API key holding publish: approve, schedule or unpublish without a prompt.

Examples

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

Terminal
recala article regenerate "$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 article request-changes

Send the article back with a change request.

writes Acts on an organization
Signature
recala article request-changes ARTICLE_ID [OPTIONS]

Replace uppercase arguments with your own values. Replace [OPTIONS] with your flags. Include every flag marked Required in the table below.

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

Examples

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

Terminal
recala article request-changes "$ARTICLE_ID" --note "$NOTE"

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 article run

Wait for an existing creation run; never starts or pays for another run.

read Acts on an organization
Signature
recala article run QUEUE_ID [OPTIONS]

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.

Terminal
recala article run "$QUEUE_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 article schedule

Schedule an approved article to publish at a time.

writes Acts on an organization Supports --yes
Signature
recala article schedule ARTICLE_ID [OPTIONS]

Replace uppercase arguments with your own values. Replace [OPTIONS] with your flags. Include every flag marked Required in the table below.

FlagRequiredDescription
--jsonNoPrint one JSON document (errors as JSON on stderr).
--orgNoOrganization name, slug or id (else RECALA_ORG, else recala org use).
--yesNoOnly with an API key holding publish: approve, schedule or unpublish without a prompt.
--atYesLocal time in the company's timezone, e.g. 2026-10-06T09:00.
--tzNoTimezone (default: the company's).
--dry-runNoShow whether it can be scheduled; change nothing.

Examples

Check that the article can be scheduled. Nothing changes.

Terminal
recala article schedule "$ARTICLE_ID" --at "$PUBLICATION_TIME" --dry-run

Schedule it in the company's timezone. It publishes at that time without asking again.

Terminal
recala article schedule "$ARTICLE_ID" --at "$PUBLICATION_TIME"

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 article share

Show the review link; --review-link makes one; --rotate / --revoke kill the old one (need --yes).

writes Acts on an organization Supports --yes
Signature
recala article share ARTICLE_ID [OPTIONS]

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).
--yesNoOnly with an API key holding publish: approve, schedule or unpublish without a prompt.
--review-linkNoTurn the review link on (or replace it).
--rotateNoReplace the article's share token; the old link stops working.
--revokeNoTurn the review link off.

Examples

Make a review link for the person.

Terminal
recala article share "$ARTICLE_ID" --review-link

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 article show

One article: status, author, hold, open questions (and the text with --markdown).

read Acts on an organization
Signature
recala article show ARTICLE_ID [OPTIONS]

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).
--markdownNoInclude the article's text.

Examples

Read the text, any hold and the open questions.

Terminal
recala article show "$ARTICLE_ID" --markdown

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 article status

Where the article stands: review, publishing, author, hold, versions, review link.

read Acts on an organization
Signature
recala article status ARTICLE_ID [OPTIONS]

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

Review, publishing, author, hold, versions and review link for one article.

Terminal
recala article status "$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, 11 PAYMENT_REQUIRED.

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

recala article submit

Hand the article over for the person's review.

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

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

Hand it over for that person's review.

Terminal
recala article 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.

recala article unpublish

Take a published article off the site (the CMS first).

writes Acts on an organization Supports --yes
Signature
recala article unpublish ARTICLE_ID [OPTIONS]

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).
--yesNoOnly with an API key holding publish: approve, schedule or unpublish without a prompt.

Examples

Take a published article off the site.

Terminal
recala article unpublish "$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 article unschedule

Cancel the article's scheduled publication.

writes Acts on an organization Supports --yes
Signature
recala article unschedule ARTICLE_ID [OPTIONS]

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).
--yesNoOnly with an API key holding publish: approve, schedule or unpublish without a prompt.

Examples

Cancel a scheduled publication.

Terminal
recala article unschedule "$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 article versions

Every saved version of the article, or one of them with --show N.

read Acts on an organization
Signature
recala article versions ARTICLE_ID [OPTIONS]

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).
--showNoOne version's text and changes.

Examples

Read what changed.

Terminal
recala article versions "$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, 11 PAYMENT_REQUIRED.

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

CLI reference
Search documentation