Skip to content
Browse documentationKeys
Markdown

CLI REFERENCE

Keys commands

Signatures, flags and examples for recala keys.

On this page

Use these commands

Organization API keys, where key access is enabled. A person’s session manages keys.

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 keys create

Create a key. It is printed once; Recala keeps only its hash.

needs a person Acts on an organization Supports --yes
Signature
recala keys 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.
--nameYesWhat the key is for, e.g. "Claude agent".
--scopeYesRepeat for each scope.
--expires-daysNoNo description supplied by the CLI.
--rateNoRequests per minute.
--credit-capNoArticles per month.
--publish-capNoArticles approved or published per day.
--sign-asNoYour own email: needed for a key that can approve and publish.
--personNoWith publish: a person (id from recala authors) whose articles this key may approve and publish. Repeat for each.

Examples

Run in your terminal with the intended organization selected.

Terminal
recala keys create --name "CI reports" --scope read --credit-cap 0 --publish-cap 0

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 keys events

The key's audit trail, newest first.

needs a person Acts on an organization
Signature
recala keys events KEY_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).
--limitNoNo description supplied by the CLI.

Examples

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

Terminal
recala keys events "$KEY_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 keys list

Owners see every key of the company; others see their own.

needs a person Acts on an organization
Signature
recala keys 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 keys 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 keys revoke

Revoke a key: its next request is refused.

needs a person Acts on an organization Supports --yes
Signature
recala keys revoke KEY_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 keys revoke "$KEY_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.

CLI reference
Search documentation