CLI REFERENCE

Cms commands

Signatures, flags and examples for recala cms.

Use these commands

Connect your content management system and check its status.

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 cms connect`

Connect Sanity or WordPress. Credentials come from env, --token-stdin or a hidden human prompt.

needs a person Acts on an organization

Signature

recala cms connect [OPTIONS]

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

Flag	Required	Description
`--json`	No	Print one JSON document (errors as JSON on stderr).
`--org`	No	Organization name, slug or id (else RECALA_ORG, else recala org use).
`--provider`	No	No description supplied by the CLI.
`--project`	No	No description supplied by the CLI.
`--dataset`	No	No description supplied by the CLI.
`--blog-url`	No	No description supplied by the CLI.
`--author`	No	PERSON_ID=SANITY_AUTHOR_ID.
`--site`	No	No description supplied by the CLI.
`--user`	No	No description supplied by the CLI.
`--wordpress-com`	No	No description supplied by the CLI.
`--wpcom-address`	No	No description supplied by the CLI.
`--token-stdin`	No	Read the CMS token/password from one stdin line; never echoes it.

Examples

Run in your terminal with the intended organization selected.

Terminal

recala cms connect

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 cms status`

The CMS (its endpoint and the public site), Search Console and the sitemap, with the next step for each.

read Acts on an organization

Signature

recala cms status [OPTIONS]

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

Flag	Required	Description
`--json`	No	Print one JSON document (errors as JSON on stderr).
`--org`	No	Organization 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 cms 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.