Skip to content
Browse documentationConnect

Connect commands

Signatures, flags and examples for recala connect.

On this page

Use these commands

Connections: the CMS, Search Console and Bing Webmaster Tools.

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 connect bing

Connect Bing Webmaster Tools.

needs a person Acts on an organization
recala connect bing [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).
--siteNoThe site to use, as listed by: recala bing sites.
--dry-runNoCheck everything and say what would change, without changing it.

Examples

Microsoft sign-in in the browser, then choose the site. The site that matches the company's website is chosen for you.

recala connect bing --org "$ORG"

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 connect gsc

Connect Google Search Console.

needs a person Acts on an organization
recala connect gsc [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).
--oauthNoSign in with Google in the browser (the default path).
--propertyNoThe property to use, e.g. sc-domain:example.com.
--service-accountNoInstead: the email to add as a Restricted user.
--checkNoWith the service account: connect this property once it was added.
--dry-runNoCheck everything and say what would change, without changing it.

Examples

Run in your terminal with the intended organization selected.

recala connect gsc --oauth

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 connect sanity

Publish to Sanity. The write token comes from RECALA_SANITY_TOKEN, --token-stdin or a hidden prompt.

needs a person Acts on an organization
recala connect sanity [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).
--projectNoSanity project ID.
--datasetNoDataset (default production).
--schema-profileNoSanity document schema (default post; prompts when interactive).
--blog-urlNoThe public HTTPS address where articles appear.
--authorNoPERSON_ID=SANITY_AUTHOR_ID. Repeat for each author.
--token-stdinNoRead the CMS secret from one stdin line; never echoes it.
--dry-runNoCheck everything and say what would change, without changing it.

Examples

Run in your terminal with the intended organization selected.

recala connect sanity

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 connect sitemap

The site's sitemaps in Search Console.

needs a person Acts on an organization
recala connect sitemap [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

Run in your terminal with the intended organization selected.

recala connect sitemap

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

CMS, Search Console and sitemap: next steps.

read Acts on an organization
recala connect status [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

See what is connected: the CMS, Search Console and Bing.

recala connect 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 connect wordpress

Publish to WordPress.

needs a person Acts on an organization
recala connect wordpress [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).
--siteNoThe WordPress site address.
--userNoSelf-hosted: the WordPress user that publishes.
--wordpress-comNoThe site is hosted on WordPress.com (also behind your own domain).
--wpcom-addressNoWith --wordpress-com and your own domain: the *.wordpress.com address.
--token-stdinNoRead the application password from one stdin line; never echoes it.
--dry-runNoCheck everything and say what would change, without changing it.

Examples

Run in your terminal with the intended organization selected.

recala connect wordpress

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