Skip to content

RAGVIDENCE / Documentation

CLI v0.2.1
Browse documentation
Docs/Reports

Reports and exports

Save terminal summaries and self-contained HTML, JSON or Markdown reports.

v0.2.1Local CLI · Offline reports
Download .md

Choose exports

Terminal
ragvi bm25 ./docs --questions ./questions.txt --format html --format json --format markdown

HTML is the default; an explicit repeated --format selection replaces it. Every run uses a unique directory under ragvi-reports/; --output chooses a different root. --open opens HTML only when requested.

What exports contain

Reports identify input hashes, settings, source locations, exact returned context, queries, stage candidates/scores/timings, model/provider identity, warnings and evaluation scope. Unknown cost/timing stays unavailable. HTML escapes source content, embeds fonts and includes only a static light/dark theme switch, without storage or remote assets. Theme choice stays in the open report. Keyboard-accessible navigation and native disclosures work offline without JavaScript. Print styles include closed evidence disclosures in supported browsers; open them first in older print engines.

Keep internal artifacts private

snapshot.json retains original bodies; questions.json and references.json retain evaluation inputs; run.json records exact context; search-sources.json freezes searchable bodies/prefixes. Comparison directories also retain plans, sidecars, tokenizers and checkpoints. They can expose much more than the selected report. Review all content before sharing.

Was something unclear? Send documentation feedback.

Support ongoing CLI and documentation maintenance with an optional donation.

Donate via PayPal