Skip to content
Browse documentationCLI

RECALA CLI

CLI reference

Install, sign in and find the command you need. Every command and flag comes from the CLI’s own schema.

On this page

CLI 0.5.1 · 81 commands · Generated from the CLI schema

Each command is marked read, writes or needs a person. Conditional commands use the strongest effect they can have. Guarded writes can require confirmation even without --yes. Read the write confirmation rules.

Install the CLI

Terminal
curl -fsSL https://recala.co/install.sh | sh
uv
uv tool install https://recala.co/releases/cli/recala_cli-0.5.1-py3-none-any.whl
pipx
pipx install https://recala.co/releases/cli/recala_cli-0.5.1-py3-none-any.whl

The script needs uv or pipx. Install uv first if neither is available. With pipx, use Python 3.11 or newer. Install uv. Recala is in beta. Join the beta.

Authentication: keys, scopes and caps →

Sign in with a one-time code

The terminal opens recala.co/cli and prints a code. Sign in to Recala, type that code and approve the request. Return to your terminal to continue.

Terminal
recala login

Credentials are resolved in this order. There is no command-line token flag; keep credentials out of your shell history.

PrioritySourceWhen used
1RECALA_API_KEYEnvironment credential, where organization-key access is enabled.
2RECALA_TOKENEnvironment access token, if no API key is set.
3Saved loginThe session from your one-time sign-in.
Sign in on a remote machine
Terminal
recala login --no-browser

Open the printed link on your own device and type the code there.

Choose your organization

Use the organization’s name, slug or id. Save your choice once, or override it for a single command.

Terminal
recala org use <name>
PrioritySourceScope
1--orgThis command; for example --org rebeam.
2RECALA_ORGYour shell, script or agent.
3recala org useThe choice saved on this machine.
Terminal
recala article list --org rebeam
List organizations or set a shell default
Terminal
recala org list
Terminal
RECALA_ORG=rebeam recala article list

Find a command group

Read the exit code

Scripts can branch on these stable codes. Read the JSON output contract for error details.

Recala CLI exit codes: the code, its name, what it means and what to do
Code Name Meaning What to do
0 OK Done. Continue.
1 ERROR Unexpected error, or an answer the CLI could not read. Stop and report error.message to the person. Do not retry a write.
2 USAGE Bad flags or arguments. Fix the command. recala schema --json lists every flag.
3 NOT_AUTHENTICATED Not signed in, or the credential was refused. Stop and ask the person to run recala login.
4 FORBIDDEN Your role does not allow it. Stop and name what is missing. Never look for another way around it.
5 NOT_FOUND Not found. Check the id with a list command.
6 CONFLICT Not allowed yet: no organization selected, not ready to schedule, or no person linked. Fix the precondition the message names, or ask the person.
7 INVALID The input was refused. Read error.message and fix the input.
8 RATE_LIMITED Rate limited. Wait, then retry once.
9 UNAVAILABLE Server or network trouble. Retry a read once. After outcome_unknown, never retry: check the state first.
10 CONFIRMATION_REQUIRED Confirmation is missing or was declined. Nothing was sent. Ask the person to confirm in a terminal or grant this sign-in access.
11 PAYMENT_REQUIRED Not allowed to spend: no credits, a cap reached or a blocked topic. Stop and tell the person. An agent never buys.
CLI reference
Search documentation