Skip to content
Browse documentationOrg

CLI REFERENCE

Org commands

Signatures, flags and examples for recala org.

On this page

Use these commands

Choose and show the organization you act on.

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.

The company alias is included below with its own command anchors.

recala company create

Create the company (or set up the empty one a new account starts with) and make it active.

needs a person Acts on an organization
Signature
recala company create [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).
--nameNoThe company's name, as readers know it.
--websiteNoIts website, e.g. https://cometa.cards
--languageNoThe language it publishes in (ISO code, e.g. es).
--marketNoThe country it sells in (ISO code, e.g. ES).

Examples

Run in your terminal with the intended organization selected.

Terminal
recala company create

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

Every company this credential may act on; * marks the active one.

read Acts on an organization
Signature
recala company 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).

Examples

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

Terminal
recala company 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 company scan

Read the company's website (brand, products, audiences, competitors) and save what you confirm.

needs a person Acts on an organization
Signature
recala company scan [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).
--websiteNoRead this address instead of the company's website.

Examples

Run in your terminal with the intended organization selected.

Terminal
recala company scan

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

Show the active company's identity.

read Acts on an organization
Signature
recala company show [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 company 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.

recala company use

Organization name, slug or id: choose the company later commands act on.

writes
Signature
recala company use ORG_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).

Examples

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

Terminal
recala company use "$ORG_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 org create

Create the company (or set up the empty one a new account starts with) and make it active.

needs a person Acts on an organization
Signature
recala org create [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).
--nameNoThe company's name, as readers know it.
--websiteNoIts website, e.g. https://cometa.cards
--languageNoThe language it publishes in (ISO code, e.g. es).
--marketNoThe country it sells in (ISO code, e.g. ES).

Examples

Run in your terminal with the intended organization selected.

Terminal
recala org create

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

Every company this credential may act on; * marks the active one.

read Acts on an organization
Signature
recala org 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).

Examples

Every organization you may act on. A star marks the active one.

Terminal
recala org 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 org scan

Read the company's website (brand, products, audiences, competitors) and save what you confirm.

needs a person Acts on an organization
Signature
recala org scan [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).
--websiteNoRead this address instead of the company's website.

Examples

Run in your terminal with the intended organization selected.

Terminal
recala org scan

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

Show the active company's identity.

read Acts on an organization
Signature
recala org show [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

The active organization's name, website and blog.

Terminal
recala org show

Check that the active organization is the one the person meant.

Terminal
recala org show --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.

recala org use

Organization name, slug or id: choose the company later commands act on.

writes
Signature
recala org use ORG_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).

Examples

Make it the organization later commands act on. Use its name, slug or id; the choice is saved on this machine.

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

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

CLI reference
Search documentation