CLI REFERENCE
Knowledge commands Signatures, flags and examples for recala knowledge.
On this page Use these commands The sources Recala writes from.
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.
Upload a PDF, DOCX, Markdown, text or CSV file (10 MB at most) as the company's own material.
writes Acts on an organization
Signature Copy
recala knowledge add FILE [OPTIONS] Replace uppercase arguments with your own values. Replace [OPTIONS] with the flags you need, or omit it.
Scroll horizontally to see all columns →
Flag Required Description --jsonNo Print one JSON document (errors as JSON on stderr). --orgNo Organization name, slug or id (else RECALA_ORG, else recala org use).
Examples Add a document the client sent: PDF, DOCX, Markdown, text or CSV, 10 MB at most.
Terminal Copy
recala knowledge add ./product-sheet.pdf Exit codes: 0 OK1 ERROR2 USAGE3 NOT_AUTHENTICATED4 FORBIDDEN5 NOT_FOUND6 CONFLICT7 INVALID8 RATE_LIMITED9 UNAVAILABLE10 CONFIRMATION_REQUIRED11 PAYMENT_REQUIRED
API commands share the CLI’s HTTP error mapping. Read human and JSON output rules .
Add one or more pages as sources.
writes Acts on an organization
Signature Copy
recala knowledge add-url URLS [OPTIONS] Replace uppercase arguments with your own values. Replace [OPTIONS] with the flags you need, or omit it.
Scroll horizontally to see all columns →
Flag Required Description --jsonNo Print one JSON document (errors as JSON on stderr). --orgNo Organization name, slug or id (else RECALA_ORG, else recala org use).
Examples Add the company's own pages as sources.
Terminal Copy
recala knowledge add-url https://example.com/ https://example.com/about Exit codes: 0 OK1 ERROR2 USAGE3 NOT_AUTHENTICATED4 FORBIDDEN5 NOT_FOUND6 CONFLICT7 INVALID8 RATE_LIMITED9 UNAVAILABLE10 CONFIRMATION_REQUIRED11 PAYMENT_REQUIRED
API commands share the CLI’s HTTP error mapping. Read human and JSON output rules .
Every source document, its processing state and whether it is admitted.
read Acts on an organization
Signature Copy
recala knowledge list [OPTIONS] Replace [OPTIONS] with the flags you need, or omit it.
Scroll horizontally to see all columns →
Flag Required Description --jsonNo Print one JSON document (errors as JSON on stderr). --orgNo Organization name, slug or id (else RECALA_ORG, else recala org use).
Examples Wait until every source is processed.
Terminal Copy
recala knowledge list Exit codes: 0 OK1 ERROR2 USAGE3 NOT_AUTHENTICATED4 FORBIDDEN5 NOT_FOUND6 CONFLICT7 INVALID8 RATE_LIMITED9 UNAVAILABLE11 PAYMENT_REQUIRED
API commands share the CLI’s HTTP error mapping. Read human and JSON output rules .
Remove a source and everything derived from it.
Signature Copy
recala knowledge remove DOCUMENT_ID [OPTIONS] Replace uppercase arguments with your own values. Replace [OPTIONS] with the flags you need, or omit it.
Scroll horizontally to see all columns →
Flag Required Description --jsonNo Print one JSON document (errors as JSON on stderr). --orgNo Organization name, slug or id (else RECALA_ORG, else recala org use). --yesNo Only 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 Copy
recala knowledge remove "$DOCUMENT_ID" Exit codes: 0 OK1 ERROR2 USAGE3 NOT_AUTHENTICATED4 FORBIDDEN5 NOT_FOUND6 CONFLICT7 INVALID8 RATE_LIMITED9 UNAVAILABLE10 CONFIRMATION_REQUIRED11 PAYMENT_REQUIRED
API commands share the CLI’s HTTP error mapping. Read human and JSON output rules .