reference · oto ingest --help at v0.6.1

oto ingest

claim the inbox into a run and extract it into the corpus

oto ingest [-h] [--project PROJECT] [--inbox INBOX] [--run RUN] [--open] [--force]
                  [--no-assets] [--allow-personal-data] [--strict-privacy]
                  [{run,complete,runs}]

Verbs

run (default) claims and extracts
complete archives a run once the graph holds its facts
runs lists the manifests

Options

Option	What it does
`--project PROJECT`	project root (default: current directory)
`--inbox INBOX`	read this run from another directory; its files are copied, never moved
`--run RUN`	the run to complete (default: the latest open one)
`--open`	for runs: print only the ids of runs whose files still wait in processing/
`--force`	complete even with a candidate open or a stale build
`--no-assets`	skip writing page and slide images
`--allow-personal-data`	ingest even when the privacy scan finds blocking items
`--strict-privacy`	treat every privacy warning as blocking

Where to use it

Documents were dropped in inbox/.

oto ingest --project claims

claims them into a run, extracts each to build/documents/<slug>.md, blocks personal data, leaves them in processing/

The graph now holds the run's facts, after curate apply and build.

oto ingest complete --project claims

moves the files to archive/; refused while a candidate is open or the build is older than the documents

You want to know which runs still owe facts.

oto ingest runs --project claims --open

the ids of runs whose files still wait in processing/

The documents live elsewhere and must not be moved.

oto ingest --project claims --inbox ~/Downloads/handbook

copies them into the run; the originals stay where they are

As the terminal prints it

usage: oto ingest [-h] [--project PROJECT] [--inbox INBOX] [--run RUN] [--open] [--force]
                  [--no-assets] [--allow-personal-data] [--strict-privacy]
                  [{run,complete,runs}]

positional arguments:
  {run,complete,runs}   run (default) claims and extracts; complete archives a run once the graph
                        holds its facts; runs lists the manifests

options:
  -h, --help            show this help message and exit
  --project PROJECT     project root (default: current directory)
  --inbox INBOX         read this run from another directory; its files are copied, never moved
  --run RUN             the run to complete (default: the latest open one)
  --open                for runs: print only the ids of runs whose files still wait in processing/
  --force               complete even with a candidate open or a stale build
  --no-assets           skip writing page and slide images
  --allow-personal-data
                        ingest even when the privacy scan finds blocking items
  --strict-privacy      treat every privacy warning as blocking