Reference5 min readgenerated from the code

Command line

lancescope is the same read and ingest surface the console uses, called in process. Two of these commands are meant for a script rather than a person: findings --fail-on is a build gate, and run-config writes an artifact to stdout with everything else on stderr.

Exit codes

code meaning
0 it worked, or nothing was asked of it
1 the gate fired — a finding at or above the requested severity
2 a usage error: no such table, no such column, nothing configured
3 a rule crashed, so the sweep was incomplete and proves nothing
130 interrupted

A missing table is 2 rather than 1 on purpose. A job whose table was renamed and a job whose table has a warning on it need different people to look at them.

lancescope scan

Survey a directory without reading a single file.

flag what it does
source directory to survey
--types comma-separated subset of image, video, audio, pdf
--max-files stop counting here and say the totals are floors
--follow-symlinks descend into symlinked directories (off by default: a photo library that links to its own parent is not rare)
--json the same answer as an object, for a script

lancescope ingest

Build a Lance table from a directory of media.

flag what it does
source directory to ingest
--name table name
--into parent directory for the table (default: the active connection, else ~/LanceScope)
--types comma-separated subset of audio, image, pdf, video (default: all of them)
--limit first N files only — try it cheaply
--hash record a sha256 of every file (reads every byte; off by default for that reason)
--copy store the originals in the table too, segmented into blob rows, so it plays without the source files (off by default: an index over files you still own is usually what you want)
--dry-run survey and validate; write nothing
--json the same answer as an object, for a script

lancescope findings

What the console has worked out about a table, and a way to fail a build over it.

flag what it does
table table name under the resolved root
--facet narrow to one reader's question, e.g. training
--fail-on exit non-zero when a finding at or above this severity is outstanding, and 3 when a rule crashed and the sweep could not be completed (default: report and exit 0)
--json the same answer as an object, for a script

lancescope run-config

What a training run must pin about a table, as a block to paste where the run lives.

flag what it does
table table name under the resolved root
--columns comma-separated columns the run reads (default: every ordinary one)
--json the same answer as an object, for a script

lancescope check

Checks that read the data — duplicates, missing content, class balance, split leakage, dead embeddings. Quoted before it reads anything.

flag what it does
table table name under the resolved root
checks which checks to run (default: all that can run here)
--columns comma-separated columns, when running one check that needs them named
--quote print what these checks would read and stop
--fail-on exit non-zero when something is found
--json the same answer as an object, for a script

lancescope bundle

One table's whole diagnosis as a document to hand to somebody who is not at this screen.

flag what it does
table table name under the resolved root
--columns comma-separated columns to weigh (default: every ordinary one)
--facet narrow the findings to one reader's question, e.g. training
--json the machine-readable document rather than the markdown
--paths keep the database root; by default it is redacted, because a local path carries a username and a bucket carries an employer

lancescope open

Open a table in the console, working out which directory is the database.

flag what it does
path a .lance table, or a directory holding them (default: wherever the console is already pointed)
--port serve here rather than on a port the kernel picks
--no-browser print the URL and open nothing

lancescope cost

What a table's columns weigh, without reading a row of them.

flag what it does
table table name under the resolved root
--columns comma-separated columns to weigh (default: every ordinary one)
--all list every column, including the ones too small to see
--json the same answer as an object, for a script

lancescope doctor

What this build can decode, and what it cannot.

flag what it does
--into check a specific destination as well
--json the same answer as an object, for a script