Skip to content

Inspect: explore, search, cite, ls, trace, status, todo

vouch explore

Browse recorded values in a local web page; copy the LaTeX that cites them.

$ vouch explore [--port N] [--open] [--html FILE] [--json] [--root DIR]
Flag Meaning
--port N port on 127.0.0.1 (default 8765)
--open open it in the browser
--html FILE write a self-contained snapshot instead of serving
--json print the data the page shows
$ vouch explore --open

vouch explore browsing recorded values by script and function Values grouped the way the code is: script → function → key, with a copy-citation button on every row.

vouch explore detail view for one function Clicking a row opens its provenance: description, call, per-seed results, and where it's cited.

The page serves at http://127.0.0.1:8765/ and:

  • Groups tracked values under their function, recorded values under the function the call is in (or "top level"), parameters in their own group, and derived values under their definition.
  • Copies citations: \vouch{key} for a value, \vouchclaim{key}{desc} for a claim, \vouchtable{key} for a table (plus a whole tabular around it), \includegraphics[...]{...} for a figure.
  • Searches keys, descriptions, function names, call arguments and values (press / to focus). Filters show all, cited, or not-cited keys.
  • Updates live: it checks every two seconds whether anything it shows has changed.
  • Stays local and read-only: binds to 127.0.0.1 only, rejects requests with the wrong Host, and never runs project code.
  • ?q=WORDS opens the page with a search; ?open=KEY opens it on one key, expanded.

Find keys by words: key segments, descriptions, run ids, units, and a tracked call's function and arguments.

$ vouch search "WORDS..." [--limit N] [--json] [--root DIR]
$ vouch search "vit accuracy cifar"
cifar.vit.acc            72.4 ± 1.1%   top-1 test accuracy, mean ± std over seeds   (cifar_vit, CHANGED)
cifar.vit.acc.std        1.1%          …std subfield
cifar.resnet_vs_vit.pts  20.8          ResNet minus ViT top-1, percentage points    (derived)

Ranking is BM25 over a document per key, stdlib-only, with a small built-in synonym list (acc/accuracy, lr/learning rate, std/deviation, n/seeds/samples, time/how long/took, …).

vouch cite

The exact LaTeX to cite a key, and what it renders as.

$ vouch cite KEY [--fmt F] [--json] [--root DIR]
$ vouch cite cifar.resnet.acc
\vouch{cifar.resnet.acc}          →  93.2 ± 0.4\%    (default fmt .1pct)
\vouch[.2pct]{cifar.resnet.acc}   →  93.21 ± 0.41\%
top-1 test accuracy on CIFAR-10, mean ± std over seeds · higher is better · fresh · run cifar_resnet
subfields: .mean 93.2\% · .std 0.4\% · .n 5 · .ci95 [92.7, 93.7]

vouch ls

List recorded keys, with rendered value, description, run, freshness and citation count.

$ vouch ls [PATTERN] [--cited] [--uncited] [--all] [--json] [--root DIR]
Flag Meaning
PATTERN substring or glob (e.g. 'cifar.*.acc')
--cited only keys the paper cites
--uncited only keys the paper doesn't cite
--all also list each mean ± std's subfields (.mean, .std, .n, …)
--json every key, subfields included

Numbers inside keys sort in numeric order.

vouch trace

The full provenance chain for a key, a figure, a script, or a file:line.

$ vouch trace TARGET [--code] [--json] [--root DIR]

TARGET is a key, a figure path, a script path, or file:line in a paper's .tex. --code lists every code unit the target depends on.

$ vouch trace paper/figures/learning_curve.pdf
paper/figures/learning_curve.pdf   figure
  saved     experiment.py:98   in run experiment (fresh)
  command   python experiment.py
  when      2026-09-19 13:05 UTC
  file      as the run saved it
  cited     paper/main.tex:47

vouch status

Freshness per run, git-status style, with the exact re-run command and the units that changed.

$ vouch status [--json] [--no-env] [--root DIR]

--no-env skips the package-version drift check.

vouch todo

Values the paper cites that no run has recorded yet (vouch.expect).

$ vouch todo [--json] [--root DIR]

Lists each pending key with its producer command, so an agent or author knows exactly what to run.