Skip to content
Browse documentationAuthors

CLI REFERENCE

Authors commands

Signatures, flags and examples for recala authors.

On this page

Use these commands

The real people who sign 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.

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

recala author add

Add a person who signs articles (owners).

needs a person Acts on an organization
Signature
recala author add [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).
--nameYesFull name as it appears on the byline.
--title, --roleNoJob title, e.g. "Founder".
--link, --bio-linkNoA public profile or bio link. Repeat for each.
--linkedinNoThe LinkedIn profile (else the first --link on linkedin.com).
--bioNoOne or two sentences.
--expertiseNoA topic this person knows. Repeat for each.

Examples

Run in your terminal with the intended organization selected.

Terminal
recala author add --name "$AUTHOR_NAME" --title "$AUTHOR_TITLE"

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

Every author of the company.

read Acts on an organization
Signature
recala author 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 author 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 authors add

Add a person who signs articles (owners).

needs a person Acts on an organization
Signature
recala authors add [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).
--nameYesFull name as it appears on the byline.
--title, --roleNoJob title, e.g. "Founder".
--link, --bio-linkNoA public profile or bio link. Repeat for each.
--linkedinNoThe LinkedIn profile (else the first --link on linkedin.com).
--bioNoOne or two sentences.
--expertiseNoA topic this person knows. Repeat for each.

Examples

Run in your terminal with the intended organization selected.

Terminal
recala authors add --name "$AUTHOR_NAME" --title "$AUTHOR_TITLE"

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

Every author of the company.

read Acts on an organization
Signature
recala authors 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

See the real people who can sign articles for this organization.

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

CLI reference
Search documentation