Skip to content

RAGVIDENCE / Documentation

CLI v0.2.1
Browse documentation
Docs/Reference

CLI reference

Discover installed commands and portable configuration before running an experiment.

v0.2.1Local CLI · Offline reports
Download .md

Use installed help

Terminal
ragvi --help
ragvi bm25 --help
ragvi compare-data --help
ragvi techniques --format json

Portable workflow

  • bm25, semantic, hybrid: base retrieval.
  • rerank, parent-child, heading-context, contextual, multi-query: candidate/representation experiments.
  • metadata-filter, mmr, rewrite, auto-multi-query, compress: explicit stages.
  • import-data: existing-system context; compare-data: frozen comparisons.

Optional reviewed workspace

tutorial, quickstart and init create recoverable reviewed workspaces. validate checks references; benchmark/experiment write runs; import-run normalizes existing results; evaluate scores reviewed labels; compare/diagnose/inspect investigate; report exports authoritative evaluations. generate optionally calls your answer provider for inspection, without correctness judging.

Portable configuration

config.toml
k = 3
formats = ["html", "json"]
chunk_size = 500
chunk_overlap = 50
output = "reports"

Select --config explicitly. Relative paths in config files resolve against that file; flag/environment paths resolve from the command directory. Unknown keys fail. See the CLI guide for user-config locations and environment equivalents.

Was something unclear? Send documentation feedback.