Skip to content

Command line reference

Install the CLI with uv sync --all-packages and run uv run lorebase; the quickstart shows it at work, and lorebase COMMAND --help prints the text below for one command. The server it talks to is described in the REST API reference.

lorebase

Command line client of a Lorebase Keeper.

Point it at a server with LOREBASE_URL and LOREBASE_API_KEY (or LOREBASE_TOKEN), or a profile in ~/.config/lorebase/config.toml. Every command takes --json for machine output. Run lorebase --install-completion for shell completion.

Usage:

$ lorebase [OPTIONS] COMMAND [ARGS]...

Options:

  • --config <path>: Config file (default: ~/.config/lorebase/config.toml; LOREBASE_CONFIG).
  • --profile <str>: Profile of the config file (LOREBASE_PROFILE).
  • --url <str>: Server URL (LOREBASE_URL).
  • --json: Print JSON instead of tables, for every command.
  • -q, --quiet: Print no progress or notes.
  • --version: Show the version.
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Exit codes: 0 success, 1 usage or configuration error (also not found), 2 validation failure or conflict, 3 authentication or permission failure, 4 server error or server unreachable.

Commands:

  • whoami: Show who the credentials authenticate as.
  • query: Run a query of the JSON DSL (filters,...
  • search: Search Records by text, and by meaning...
  • resolve: Ground the words of a text in Kinds,...
  • log: Show the history of a branch, newest...
  • diff: Show what changed between two Revisions (a...
  • context: Build a context pack: seed Records, their...
  • explain: Explain a Record: where each value and...
  • health: Check the data: constraint violations,...
  • domain: Create, inspect and delete Domains.
  • branch: List, create, protect and delete branches.
  • tag: List and create tags (immutable names for...
  • schema: Read, check and change the schema of a...
  • import: Load Records and Links from CSV, JSON...
  • record: Read Records.
  • revision: Inspect Revisions.
  • apikey: Manage the API keys of a Domain.
  • admin: Administer the personal data of a Domain.
  • audit: Check the audit log of a Domain.
  • trace: Inspect what agents did in a session.
  • proposal: Propose, review and merge changes between...
  • reconcile: Review contradictions and duplicates...
  • sources: Synchronize the Sources of a Domain.
  • documents: Upload documents and follow their extraction.

lorebase whoami

Show who the credentials authenticate as.

Usage:

$ lorebase whoami [OPTIONS]

Options:

  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase query

Run a query of the JSON DSL (filters, Relations, includes, aggregates).

Example: lorebase query '{"kind": "Part", "where": {"attr": "category", "op": "eq", "value": "bearing"}}'

Usage:

$ lorebase query [OPTIONS] {QUERY}

Arguments:

  • QUERY: A query of the JSON DSL: inline JSON, a file path, or - for standard input. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

Search Records by text, and by meaning with a query vector computed on your side.

Usage:

$ lorebase search [OPTIONS] {TEXT}

Arguments:

  • TEXT: Words to look for. [required]

Options:

  • --kind <str>: Only this Kind. Repeatable.
  • --trait <str>: Only the Kinds that implement this Trait. Repeatable; adds to --kind.
  • --lens <str>: Search the Kinds and Traits of this lens unless --kind or --trait.
  • --mode <str>: lexical, semantic or hybrid (default: lexical, hybrid with --vector-file).
  • --vector-file <str>: Query vector of the Domain's embedding model: a JSON array, or the output of lorebase-inference embed; - reads standard input.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase resolve

Ground the words of a text in Kinds, Attributes and stored values (with where fragments in --json); it never runs a query.

Usage:

$ lorebase resolve [OPTIONS] {TEXT}

Arguments:

  • TEXT: Words to ground, e.g. a question. [required]

Options:

  • --kind <str>: Only look in this Kind. Repeatable.
  • --level <str>: exact, synonym, trigram or embedding (default: those the server enables). Repeatable.
  • --vector-file <str>: Embedding of TEXT, enabling the embedding level when nothing else matched: a JSON array, or the output of lorebase-inference embed; - reads standard input.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase log

Show the history of a branch, newest Revision first.

Usage:

$ lorebase log [OPTIONS] [BRANCH]

Arguments:

  • BRANCH: Branch, tag or Revision (default: the default branch).

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --author <str>: Only Revisions by this principal.
  • --origin <str>: Only Revisions of this origin (import, operation, merge, ...).
  • --all-parents: Follow every parent, not only the first.
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase diff

Show what changed between two Revisions (a branch stands for its head).

Usage:

$ lorebase diff [OPTIONS] {FROM} {TO}

Arguments:

  • FROM: Older side: Revision id, tag or branch. [required]
  • TO: Newer side: Revision id, tag or branch. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --kind <str>: Only this Kind. Repeatable.
  • --relation <str>: Only this Relation. Repeatable.
  • --no-schema: Leave out schema changes.
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase context

Build a context pack: seed Records, their neighbors, schema and recent changes.

Name the seeds with exactly one of --ref, --search or --query.

Usage:

$ lorebase context [OPTIONS]

Options:

  • --ref <str>: Seed Record as KIND/KEY. Repeatable.
  • --search <str>: Seed Records found by this text.
  • --query <str>: Seed Records of a DSL query: inline JSON, @file or -.
  • --budget <int range>: Token budget of the pack. [x>=1]
  • --depth <int range>: Hops to expand around the seeds. [x>=0]
  • --relation <str>: Follow only this Relation. Repeatable.
  • --trait <str>: Limit --search and --query seeds and neighbors to the Kinds implementing this Trait. Repeatable.
  • --lens <str>: Apply this lens: its Relations, depth, budget and Kinds are defaults.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • --markdown: Print the Markdown rendering instead of a summary.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase explain

Explain a Record: where each value and Link came from, and the Proposals behind it.

Usage:

$ lorebase explain [OPTIONS] {KIND} {KEY}

Arguments:

  • KIND: Kind api name. [required]
  • KEY: Record key. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • --markdown: Print the Markdown rendering instead of a summary.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase health

Check the data: constraint violations, orphan Links, required-Link gaps, duplicates.

Usage:

$ lorebase health [OPTIONS] [KIND]

Arguments:

  • [KIND]: Report on this Kind only.

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • --markdown: Print the Markdown rendering instead of a summary.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase domain

Create, inspect and delete Domains.

Usage:

$ lorebase domain [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create a Domain with an empty first...
  • list: List the Domains you can read.
  • get: Show a Domain and the head of its default...
  • delete: Delete a Domain with all its Revisions,...

lorebase domain create

Create a Domain with an empty first Revision and a protected default branch.

Usage:

$ lorebase domain create [OPTIONS] {DOMAIN}

Arguments:

  • DOMAIN: Domain id: lowercase slug, immutable. [required]

Options:

  • --name <str>: Display name.
  • --description <str>: Description.
  • --default-branch <str>: Name of the default branch (server default: main).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase domain list

List the Domains you can read.

Usage:

$ lorebase domain list [OPTIONS]

Options:

  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase domain get

Show a Domain and the head of its default branch.

Usage:

$ lorebase domain get [OPTIONS] {DOMAIN}

Arguments:

  • DOMAIN: Domain id. [required]

Options:

  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase domain delete

Delete a Domain with all its Revisions, branches and grants. This cannot be undone.

Usage:

$ lorebase domain delete [OPTIONS] {DOMAIN}

Arguments:

  • DOMAIN: Domain id. [required]

Options:

  • -y, --yes: Do not ask for confirmation.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase branch

List, create, protect and delete branches.

Usage:

$ lorebase branch [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List the branches of a Domain.
  • get: Show a branch and how far it is from the...
  • create: Create a branch from a branch, a tag or a...
  • delete: Delete a branch (its Revisions stay...
  • protect: Protect a branch: changes reach it through...
  • rebase-tags: Give a branch forked before the default...

lorebase branch list

List the branches of a Domain.

Usage:

$ lorebase branch list [OPTIONS]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase branch get

Show a branch and how far it is from the default branch.

Usage:

$ lorebase branch get [OPTIONS] {NAME}

Arguments:

  • NAME: Branch name. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase branch create

Create a branch from a branch, a tag or a Revision. A large copy starts as an overlay that a background job copies; --wait blocks until it is a full copy.

Usage:

$ lorebase branch create [OPTIONS] {NAME}

Arguments:

  • NAME: New branch name (may contain slashes). [required]

Options:

  • --source <str>: Branch or tag to start from (default branch).
  • --revision <str>: Revision id to start at.
  • --mode <str>: copy (own rows) or overlay (only its changes).
  • --wait: Wait until the background copy of the branch ends.
  • --wait-timeout <float range>: Seconds --wait gives up after. [default: 3600.0; x>=0]
  • --poll-interval <float range>: Seconds between --wait checks. [default: 2.0; x>=0]
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase branch delete

Delete a branch (its Revisions stay reachable by id and tag). The default and protected branches cannot be deleted.

Usage:

$ lorebase branch delete [OPTIONS] {NAME}

Arguments:

  • NAME: Branch name. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase branch protect

Protect a branch: changes reach it through Proposals only.

Usage:

$ lorebase branch protect [OPTIONS] {NAME}

Arguments:

  • NAME: Branch name. [required]

Options:

  • --off: Remove the protection instead.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase branch rebase-tags

Give a branch forked before the default branch tagged an Attribute the tags it lacks.

One schema change adds the default branch's sensitivity tags (never removes one) and recomputes the titles and search vectors the branch stored before them. Protected branches refuse it; --rows-only only queues the rewrite of those rows.

Usage:

$ lorebase branch rebase-tags [OPTIONS] {BRANCH}

Arguments:

  • BRANCH: Branch name. [required]

Options:

  • -m, --message <str>: Revision message.
  • --dry-run: Plan only; write nothing.
  • --rows-only: Leave the schema alone: queue the rewrite of the stale titles and search vectors only.
  • --expected-head <str>: Fail unless the branch is at this Revision.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase tag

List and create tags (immutable names for Revisions).

Usage:

$ lorebase tag [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List the tags of a Domain.
  • create: Tag a Revision (default: the head of the...

lorebase tag list

List the tags of a Domain.

Usage:

$ lorebase tag list [OPTIONS]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase tag create

Tag a Revision (default: the head of the default branch). Tags never move.

Usage:

$ lorebase tag create [OPTIONS] {NAME}

Arguments:

  • NAME: Tag name. [required]

Options:

  • --source <str>: Branch whose head to tag.
  • --revision <str>: Revision id to tag.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase schema

Read, check and change the schema of a Domain (YAML documents).

Usage:

$ lorebase schema [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • get: Print the schema as YAML (or as JSON with...
  • validate: Check a schema document against the schema...
  • diff: Show which elements applying a schema...
  • apply: Apply a schema document to a branch as one...
  • export: Translate a schema into LinkML YAML.
  • import: Translate a LinkML schema into a Lorebase...
  • suggestions: Review the Kinds, Attributes and Relations...

lorebase schema get

Print the schema as YAML (or as JSON with --json).

Usage:

$ lorebase schema get [OPTIONS]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • -o, --output <path>: Write the document to this file.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase schema validate

Check a schema document against the schema of a branch. Nothing is written.

Exits with 2 when the document is not valid.

Usage:

$ lorebase schema validate [OPTIONS] {FILE}

Arguments:

  • FILE: Schema YAML document; - reads standard input. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase schema diff

Show which elements applying a schema document would create, update or delete.

Usage:

$ lorebase schema diff [OPTIONS] {FILE}

Arguments:

  • FILE: Schema YAML document; - reads standard input. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase schema apply

Apply a schema document to a branch as one Revision (data migrations included).

Elements the document leaves out are removed. Protected branches (the default one) refuse direct changes: apply to another branch.

Usage:

$ lorebase schema apply [OPTIONS] {FILE}

Arguments:

  • FILE: Schema YAML document; - reads standard input. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • -m, --message <str>: Revision message.
  • --dry-run: Plan only; write nothing.
  • --cascade: Allow removing Kinds or Relations that hold data.
  • --expected-head <str>: Fail unless the branch is at this Revision.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase schema export

Translate a schema into LinkML YAML.

What LinkML cannot express (element ids, sensitivity, search settings, Operations, Derivations, Sources) travels as lorebase.* annotations.

Usage:

$ lorebase schema export [OPTIONS]

Options:

  • --format <linkml>: Schema language to write. [required]
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • --file <str>: Convert this Lorebase schema document (- reads standard input) instead of the schema of the Domain.
  • --uri <str>: Id of the LinkML schema; {domain} is the Domain id.
  • -o, --output <path>: Write the document to this file.
  • --help: Show this message and exit.

lorebase schema import

Translate a LinkML schema into a Lorebase schema document.

Prints the document (or writes it with --output); warnings about what it leaves out go to standard error. --apply sends it to a branch like schema apply, --dry-run plans that. The import is merged into the current schema of the Domain: the LinkML schema owns Kinds, Attributes, Relations, Traits, enums and path Derivations; Operations, other Derivations, Sources and the fields LinkML cannot carry (derivation, authority, ...) are kept. Elements the LinkML schema leaves out stay, with a warning, unless --prune removes them.

Usage:

$ lorebase schema import [OPTIONS] {FILE}

Arguments:

  • FILE: LinkML schema; - reads standard input. [required]

Options:

  • --from <linkml>: Schema language of FILE. [required]
  • -o, --output <path>: Write the document to this file.
  • --apply: Apply the result to a branch instead of printing it.
  • --dry-run: Plan applying the result; write nothing.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • -m, --message <str>: Revision message.
  • --cascade: Allow removing Kinds or Relations that hold data.
  • --expected-head <str>: Fail unless the branch is at this Revision.
  • --prune: With --apply or --dry-run: also remove the Kinds, Attributes, Relations and Traits of the Domain that the LinkML schema leaves out (otherwise kept, with a warning).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase schema suggestions

Review the Kinds, Attributes and Relations document extraction suggests.

Usage:

$ lorebase schema suggestions [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List schema suggestions from extraction,...
  • accept: Accept suggestions: together they become...
  • reject: Reject suggestions.
  • merge: Fold stored Attribute suggestions that are...
lorebase schema suggestions list

List schema suggestions from extraction, the most supported first.

Usage:

$ lorebase schema suggestions list [OPTIONS]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --status <pending|accepted|rejected>: Only this status. Repeatable.
  • --type <kind|attribute|relation>: Only this kind of suggestion. Repeatable.
  • --weak: Also pending ones below schema.suggestions.min_support.
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.
lorebase schema suggestions accept

Accept suggestions: together they become one schema change set on a new branch, proposed into the default branch (nothing changes there until the Proposal merges).

Usage:

$ lorebase schema suggestions accept [OPTIONS] {ID...}

Arguments:

  • ID...: Suggestion ids (ssg_...). [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --name <str>: Api name to use instead (one suggestion only).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.
lorebase schema suggestions reject

Reject suggestions.

Usage:

$ lorebase schema suggestions reject [OPTIONS] {ID...}

Arguments:

  • ID...: Suggestion ids (ssg_...). [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.
lorebase schema suggestions merge

Fold stored Attribute suggestions that are variants of one another (names sharing schema.suggestions.merge_similarity of their words, compatible samples) into the best supported one. Safe to repeat.

Usage:

$ lorebase schema suggestions merge [OPTIONS]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase import

Load Records and Links from CSV, JSON Lines or Parquet files.

Usage:

$ lorebase import [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • records: Upsert Records of a Kind from a file.
  • links: Upsert Links of a Relation from a file.
  • batch: Upsert Records of several Kinds together...

lorebase import records

Upsert Records of a Kind from a file.

Columns are Attribute api names; values are converted to each Attribute's type (true and false become booleans, numbers and decimals stay exact, empty cells leave an Attribute unset). Kinds without a natural key take a key column.

A Kind whose Records need a Link when they are created takes it from a column: --link with_supplier=supplier_code creates each Record together with its Link to the Record whose key is in that column (JSON Lines and Parquet cells may hold a list of keys).

Usage:

$ lorebase import records [OPTIONS] {KIND} {FILE}

Arguments:

  • KIND: Kind api name, for example Supplier. [required]
  • FILE: Input file; - reads standard input. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --format <str>: csv, tsv, jsonl, json or parquet (default: from the file suffix).
  • --delimiter <str>: CSV field separator (default ,).
  • --map <str>: Rename a file column to an Attribute: --map file_column=attribute. Repeatable.
  • --link <str>: Send a file column as Links of the row: --link relation=column, the cell holding the key at the other end. Repeatable.
  • --ignore-unknown: Skip columns that are not Attributes.
  • --batch-size <int range>: Rows per request (default: batch_size setting). [x>=1]
  • --dry-run: Validate and compute; write nothing.
  • -m, --message <str>: Revision message (default names the file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

Upsert Links of a Relation from a file.

Columns from and to (or from_key and to_key) hold the keys of the two ends; other columns are Link Attributes.

Usage:

$ lorebase import links [OPTIONS] {RELATION} {FILE}

Arguments:

  • RELATION: Forward Relation api name, e.g. supplied_by. [required]
  • FILE: Input file; - reads standard input. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --format <str>: csv, tsv, jsonl, json or parquet (default: from the file suffix).
  • --delimiter <str>: CSV field separator (default ,).
  • --map <str>: Rename a file column to an Attribute: --map file_column=attribute. Repeatable.
  • --ignore-unknown: Skip columns that are not Attributes.
  • --batch-size <int range>: Rows per request (default: batch_size setting). [x>=1]
  • --dry-run: Validate and compute; write nothing.
  • -m, --message <str>: Revision message (default names the file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase import batch

Upsert Records of several Kinds together with their Links.

Files are read as import records and import links read them (--map applies to every file). Each request carries Records with the Links at their ends, so Kinds that need a Link when they are created (a Relation marked required_from) load without a Link column. Links go with the Record at their from end, or at their to end when that one is not in the import. Records without Links go first, then Records with Links, then the other Links; --batch-size counts Records and Links together.

Example: lorebase import batch --records Supplier=supplier.csv --records Contract=contract.csv --links with_supplier=with_supplier.csv

Usage:

$ lorebase import batch [OPTIONS]

Options:

  • --records <str>: Records of a Kind from a file: --records Kind=file. Repeatable; list the Kinds others point to first.
  • --links <str>: Links of a Relation from a file: --links relation=file. Repeatable.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --format <str>: csv, tsv, jsonl, json or parquet (default: from the file suffix).
  • --delimiter <str>: CSV field separator (default ,).
  • --map <str>: Rename a file column to an Attribute: --map file_column=attribute. Repeatable.
  • --ignore-unknown: Skip columns that are not Attributes.
  • --batch-size <int range>: Rows per request (default: batch_size setting). [x>=1]
  • --dry-run: Validate and compute; write nothing.
  • -m, --message <str>: Revision message (default names the file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase record

Read Records.

Usage:

$ lorebase record [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • get: Show one Record with its values.
  • delete: Delete Records of a Kind by key in one...
  • history: Show the changes of one Record, newest...
  • lineage: Show where each value of one Record came...
  • list: List the Records of a Kind.

lorebase record get

Show one Record with its values.

Usage:

$ lorebase record get [OPTIONS] {KIND} {KEY}

Arguments:

  • KIND: Kind api name. [required]
  • KEY: Record key. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • --links: Add Link counts per Relation.
  • --lineage: Add where each value came from.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase record delete

Delete Records of a Kind by key in one Revision (the delete_records Operation).

Links of the deleted Records follow each Relation's on_delete policy, as for delete_{kind}. Unknown keys fail the call unless --skip-missing. At most keeper.operations.max_bulk_delete_keys keys per call.

Usage:

$ lorebase record delete [OPTIONS] {KIND} [KEY]...

Arguments:

  • KIND: Kind api name. [required]
  • [KEY]...: Record keys.

Options:

  • --keys-file <str>: File with one key per line; - reads standard input.
  • --skip-missing: Leave out keys that do not exist (warnings).
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --dry-run: Validate and compute; write nothing.
  • -m, --message <str>: Revision message.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase record history

Show the changes of one Record, newest first (one page).

Usage:

$ lorebase record history [OPTIONS] {KIND} {KEY}

Arguments:

  • KIND: Kind api name. [required]
  • KEY: Record key. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • --values: Add the value before and after each change.
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --cursor <str>: Continue after this page's next_cursor.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase record lineage

Show where each value of one Record came from (at the branch head, or at --at).

Usage:

$ lorebase record lineage [OPTIONS] {KIND} {KEY}

Arguments:

  • KIND: Kind api name. [required]
  • KEY: Record key. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase record list

List the Records of a Kind.

Usage:

$ lorebase record list [OPTIONS] {KIND}

Arguments:

  • KIND: Kind api name. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • --at <str>: Revision id or tag to read at (time travel).
  • --where <str>: Filter: a DSL predicate as JSON, or @file.json.
  • --order-by <str>: Attribute to sort by, name or name:desc. Repeatable.
  • --select <str>: Attribute to show. Repeatable.
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase revision

Inspect Revisions.

Usage:

$ lorebase revision [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • show: Show a Revision, and with --changes its...

lorebase revision show

Show a Revision, and with --changes its changes against the first parent.

Usage:

$ lorebase revision show [OPTIONS] {REVISION}

Arguments:

  • REVISION: Revision id, tag or branch. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --changes: List what the Revision changed.
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase apikey

Manage the API keys of a Domain.

Usage:

$ lorebase apikey [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Create an API key.
  • list: List the API keys of a Domain, including...
  • revoke: Revoke an API key; it stops working at once.

lorebase apikey create

Create an API key. The secret is shown once; store it right away.

Usage:

$ lorebase apikey create [OPTIONS] {NAME}

Arguments:

  • NAME: Name of the service principal the key belongs to. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --role <str>: Role the principal gets in the Domain (server default).
  • --ttl-days <int range>: Lifetime in days (server default). [x>=1]
  • --principal-id <str>: Add a key to an existing service principal.
  • --allow-network CIDR: Client network the key may be used from, e.g. 203.0.113.0/24; repeatable. Without it the key works from any address.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase apikey list

List the API keys of a Domain, including revoked and expired ones.

Usage:

$ lorebase apikey list [OPTIONS]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase apikey revoke

Revoke an API key; it stops working at once.

Usage:

$ lorebase apikey revoke [OPTIONS] {KEY_ID}

Arguments:

  • KEY_ID: Id of the key (see apikey list). [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase admin

Administer the personal data of a Domain.

Usage:

$ lorebase admin [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • erase: Erase personal data from the vault, on...
  • vault: Rotate the vault keys (installation...

lorebase admin erase

Erase personal data from the vault, on every branch and Revision. This cannot be undone.

--key K erases what the Record ever held in its vault Attributes; --attribute A --value V erases V of A in every Record of the Kind. History keeps its shape: reads show the values as erased.

Usage:

$ lorebase admin erase [OPTIONS] {KIND}

Arguments:

  • KIND: Kind api name. [required]

Options:

  • --key <str>: Erase the values of the Record with this key.
  • --attribute <str>: Vault Attribute (api name). With --key: limit to it (repeatable); with --value: the Attribute whose value is erased in every Record.
  • --value - | @FILE: Where the value to erase is read from (JSON, or plain text when it is not valid JSON): - for standard input (asked without echo on a terminal), @FILE for a file. A value given on the command line is refused: it would stay in the shell history and the process list.
  • --branch <str>: Branch whose schema names the Kind.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -y, --yes: Do not ask for confirmation.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase admin vault

Rotate the vault keys (installation administrators).

Usage:

$ lorebase admin vault [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • status: Show which keys the vault rows use and...
  • rotate: Queue the job that seals and fingerprints...
lorebase admin vault status

Show which keys the vault rows use and which earlier keys can be removed.

Usage:

$ lorebase admin vault status [OPTIONS]

Options:

  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.
lorebase admin vault rotate

Queue the job that seals and fingerprints the vault rows of every Domain again under the current keys, in batches. Follow it with admin vault status.

Usage:

$ lorebase admin vault rotate [OPTIONS]

Options:

  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase audit

Check the audit log of a Domain.

Usage:

$ lorebase audit [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • verify: Recompute the audit hash chain of a Domain...

lorebase audit verify

Recompute the audit hash chain of a Domain and report the first broken entry.

Needs the audit.read permission (the admin role). Exits with 2 when an entry does not verify.

Usage:

$ lorebase audit verify [OPTIONS]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --after-seq <int range>: Start after this entry, trusting it (the last seq of an earlier run). [x>=0]
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase trace

Inspect what agents did in a session.

Usage:

$ lorebase trace [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List the sessions you may see, most recent...
  • show: Print the timeline of a session: calls...
  • note: Attach a note to a session (written off...

lorebase trace list

List the sessions you may see, most recent activity first.

Usage:

$ lorebase trace list [OPTIONS]

Options:

  • --actor <str>: Only the calls of this principal.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase trace show

Print the timeline of a session: calls with their outcome, and notes.

Usage:

$ lorebase trace show [OPTIONS] {SESSION_ID}

Arguments:

  • SESSION_ID: Session id. [required]

Options:

  • --actor <str>: Only the calls of this principal.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase trace note

Attach a note to a session (written off the request path).

Usage:

$ lorebase trace note [OPTIONS] {SESSION_ID} {TEXT}

Arguments:

  • SESSION_ID: Session id. [required]
  • TEXT: Text of the note. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --step <int range>: Step counter of the agent. [x>=0]
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase proposal

Propose, review and merge changes between branches.

Usage:

$ lorebase proposal [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • create: Open a Proposal to merge SOURCE into TARGET.
  • list: List the Proposals of a Domain.
  • get: Show a Proposal with its checks, reviews...
  • merge: Merge a Proposal.
  • review: Review a Proposal; approvals count towards...
  • close: Close a Proposal without merging it.
  • conflicts: List the Conflicts of the latest merge...
  • resolve: Decide one Conflict (CONFLICT_ID and...
  • items: List the items an extraction Proposal...
  • decide: Accept or reject items, by id and or by...

lorebase proposal create

Open a Proposal to merge SOURCE into TARGET.

Usage:

$ lorebase proposal create [OPTIONS] {SOURCE} {TARGET}

Arguments:

  • SOURCE: Branch with the changes. [required]
  • TARGET: Branch to merge into. [required]

Options:

  • -t, --title <str>: Title of the Proposal. [required]
  • --description <str>: Longer description.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase proposal list

List the Proposals of a Domain.

Usage:

$ lorebase proposal list [OPTIONS]

Options:

  • --status <str>: open, merged or closed.
  • --source <str>: Only Proposals from this branch.
  • --target <str>: Only Proposals into this branch.
  • --author <str>: Only Proposals by this principal.
  • --mine: Only items assigned to you through a steward role.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase proposal get

Show a Proposal with its checks, reviews and approval state.

Usage:

$ lorebase proposal get [OPTIONS] {ID}

Arguments:

  • ID: Proposal id. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase proposal merge

Merge a Proposal. Open Conflicts or missing approvals refuse it with exit code 2.

Usage:

$ lorebase proposal merge [OPTIONS] {ID}

Arguments:

  • ID: Proposal id. [required]

Options:

  • -m, --message <str>: Message of the merge Revision.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase proposal review

Review a Proposal; approvals count towards merging into a protected branch.

Usage:

$ lorebase proposal review [OPTIONS] {ID} {VERDICT}

Arguments:

  • ID: Proposal id. [required]
  • VERDICT: approve, request_changes or comment. [required]

Options:

  • -c, --comment <str>: Review comment.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase proposal close

Close a Proposal without merging it.

Usage:

$ lorebase proposal close [OPTIONS] {ID}

Arguments:

  • ID: Proposal id. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase proposal conflicts

List the Conflicts of the latest merge attempt of a Proposal.

Usage:

$ lorebase proposal conflicts [OPTIONS] {ID}

Arguments:

  • ID: Proposal id. [required]

Options:

  • --status <str>: open or resolved (default: both).
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase proposal resolve

Decide one Conflict (CONFLICT_ID and --choice), or many with --file.

Deciding one only stores the decision; --file also re-runs the merge and prints the new attempt.

Usage:

$ lorebase proposal resolve [OPTIONS] {ID} [CONFLICT_ID]

Arguments:

  • ID: Proposal id. [required]
  • [CONFLICT_ID]: Conflict id (see proposal conflicts).

Options:

  • --choice <str>: ours, theirs, base, custom, drop, restore or relax.
  • --value <str>: Value of a custom choice: inline JSON, @file or -.
  • --file <str>: Resolve many Conflicts: a JSON array (or {"resolutions": [...]}) of objects with fingerprint, choice and optionally value or values.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase proposal items

List the items an extraction Proposal proposes, in Proposal order.

Usage:

$ lorebase proposal items [OPTIONS] {ID}

Arguments:

  • ID: Proposal id. [required]

Options:

  • --status <str>: pending, accepted or rejected (repeatable).
  • --kind <str>: Kind or Relation (repeatable).
  • --type <str>: record, value or link (repeatable).
  • --min-confidence <float range>: Lowest confidence. [0<=x<=1]
  • --max-confidence <float range>: Confidence below this. [0<=x<=1.01]
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase proposal decide

Accept or reject items, by id and or by filter; the extraction branch is rebuilt.

Usage:

$ lorebase proposal decide [OPTIONS] {ID}

Arguments:

  • ID: Proposal id. [required]

Options:

  • --accept <str>: Item id to accept (repeatable).
  • --reject <str>: Item id to reject (repeatable).
  • --where-status <str>: Decide every item in this status (repeatable).
  • --where-kind <str>: Decide every item of this Kind or Relation.
  • --where-type <str>: Decide every item of this type.
  • --where-min-confidence <float range>: Only items from this. [0<=x<=1]
  • --where-max-confidence <float range>: Only items below this. [0<=x<=1.01]
  • --decision <str>: pending, accepted or rejected, for the --where-* items.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase reconcile

Review contradictions and duplicates between Sources.

Usage:

$ lorebase reconcile [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • list: List the candidates of a branch, newest...
  • show: Show a candidate with its claims and last...
  • resolve: Decide a candidate; a write that needs...
  • dismiss: Dismiss a candidate: the difference is...
  • reopen: Reopen a dismissed candidate.

lorebase reconcile list

List the candidates of a branch, newest first.

Usage:

$ lorebase reconcile list [OPTIONS]

Options:

  • --type <str>: duplicate, contradiction, superseded or stale.
  • --status <str>: open, resolved, dismissed or obsolete (default: all).
  • --kind <str>: Only this Kind (api name).
  • --attribute <str>: Only this Attribute (api name; needs --kind).
  • --source <str>: Only candidates with a claim of this Source identity.
  • --mine: Only items assigned to you through a steward role.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -b, --branch <str>: Branch (default: LOREBASE_BRANCH, branch in the config file, else the Domain's default branch).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase reconcile show

Show a candidate with its claims and last decision.

Usage:

$ lorebase reconcile show [OPTIONS] {ID}

Arguments:

  • ID: Candidate id. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase reconcile resolve

Decide a candidate; a write that needs review opens a Proposal.

Usage:

$ lorebase reconcile resolve [OPTIONS] {ID}

Arguments:

  • ID: Candidate id. [required]

Options:

  • --choice <str>: claim, keep_current, custom, policy or merge. [required]
  • -r, --reason <str>: Why; kept in the audit log. [required]
  • --claim <str>: Claim id to take (choice claim).
  • --value <str>: Value of a custom choice: inline JSON, @file or -.
  • --policy <str>: authority, newest_wins, prefer_current or prefer_incoming (choice policy).
  • --survivor <str>: Key of the Record that stays (merge).
  • --values <str>: Values to set on the survivor, by Attribute api name (merge): a JSON object, inline, @file or -.
  • --dry-run: Report the outcome without writing.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase reconcile dismiss

Dismiss a candidate: the difference is accepted as it is.

Usage:

$ lorebase reconcile dismiss [OPTIONS] {ID}

Arguments:

  • ID: Candidate id. [required]

Options:

  • -r, --reason <str>: Why; kept in the audit log. [required]
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase reconcile reopen

Reopen a dismissed candidate.

Usage:

$ lorebase reconcile reopen [OPTIONS] {ID}

Arguments:

  • ID: Candidate id. [required]

Options:

  • -r, --reason <str>: Why; kept in the audit log. [required]
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase sources

Synchronize the Sources of a Domain.

Usage:

$ lorebase sources [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • sync: Queue a synchronization of a Source;...
  • runs: List the runs of a Source, newest first.

lorebase sources sync

Queue a synchronization of a Source; sources runs shows its outcome.

Usage:

$ lorebase sources sync [OPTIONS] {SOURCE}

Arguments:

  • SOURCE: Source id or api name. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --dry-run: Record the delta without writing to any branch.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase sources runs

List the runs of a Source, newest first.

Usage:

$ lorebase sources runs [OPTIONS] {SOURCE}

Arguments:

  • SOURCE: Source id or api name. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase documents

Upload documents and follow their extraction.

Usage:

$ lorebase documents [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • upload: Upload a document (PATH, or --url) and...
  • list: List the documents of a Domain, newest first.
  • versions: List the versions of a document's source...
  • get: Show a document with its extraction jobs.
  • text: Print the parsed text of a document (the...
  • retire: Retire a document: it is never extracted...
  • purge: Irreversibly erase a document's bytes,...

lorebase documents upload

Upload a document (PATH, or --url) and queue its extraction.

With --key, new bytes become a new version of the key's document.

Usage:

$ lorebase documents upload [OPTIONS] [PATH]

Arguments:

  • [PATH]: File to upload.

Options:

  • --url <str>: Have the server fetch the document from this URL instead.
  • --no-extract: Store the document without queueing extraction.
  • --tiers <str>: Extraction tiers, comma separated (e.g. 0,1).
  • --key <str>: Source key (path, URL or external id): the document's identity.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase documents list

List the documents of a Domain, newest first.

Usage:

$ lorebase documents list [OPTIONS]

Options:

  • --key <str>: Only the versions of this source key.
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase documents versions

List the versions of a document's source key, newest first.

Usage:

$ lorebase documents versions [OPTIONS] {ID}

Arguments:

  • ID: Document id. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • -n, --limit <int range>: Most items to print (default: list_limit setting). [x>=1]
  • --all: Print every item, however many.
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase documents get

Show a document with its extraction jobs.

Usage:

$ lorebase documents get [OPTIONS] {ID}

Arguments:

  • ID: Document id. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase documents text

Print the parsed text of a document (the text extraction evidence offsets index).

Usage:

$ lorebase documents text [OPTIONS] {ID}

Arguments:

  • ID: Document id. [required]

Options:

  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase documents retire

Retire a document: it is never extracted again and its evidence is re-checked.

Usage:

$ lorebase documents retire [OPTIONS] {ID}

Arguments:

  • ID: Document id. [required]

Options:

  • --reason <str>: Why, recorded in the audit. [required]
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.

lorebase documents purge

Irreversibly erase a document's bytes, text, chunks and evidence quotes.

Usage:

$ lorebase documents purge [OPTIONS] {ID}

Arguments:

  • ID: Document id. [required]

Options:

  • --reason <str>: Why, recorded in the audit. [required]
  • --confirm <str>: The document id again: the purge is irreversible. [required]
  • -d, --domain <str>: Domain id (default: LOREBASE_DOMAIN or domain in the config file).
  • --json: Print JSON instead of a table.
  • --help: Show this message and exit.