CLI Reference

The richview CLI generates, validates, lints, verifies, and publishes reports from the command line.

Global options

Flag	Description
`-o, --output <dir>`	Output directory
`-f, --format <format>`	Output format: `json` or `pretty` (default: `pretty`)
`--verbose`	Enable verbose output
`--no-color`	Disable colored output
`-v, --version`	Print version

Commands

`generate <schema>`

Generate an HTML report from a JSON or YAML schema file. Alias: render.

bash

richview generate report.yaml
richview generate report.json -o dist/

`validate <schema>`

Validate a schema file against the RichView report schema without rendering.

bash

richview validate report.yaml

`lint <schema>`

Check a report for quality issues across data quality, chart quality, accessibility, best practices, structure, and provenance.

bash

richview lint report.yaml
richview lint report.yaml --severity warning
richview lint report.yaml --category data-quality,chart-quality
richview lint report.yaml --disable missing-alt-text,missing-provenance

Flag	Description
`--severity <level>`	Minimum severity: `error`, `warning`, `info` (default: `info`)
`--category <cat>`	Filter by category (comma-separated)
`--disable <rules>`	Disable specific rules (comma-separated)

`verify [report]`

Run verification assertions on a report file.

bash

richview verify report.yaml
richview verify --list-types

`check <schema>`

Combined quality check: validates schema, lints, and verifies assertions in one pass.

bash

richview check report.yaml
richview check report.yaml --verify-only
richview check report.yaml --lint-only

`init [name]`

Scaffold a new report project with an example schema.

bash

richview init my-report
richview init dashboard --template dashboard
richview init report --json

Templates: starter, dashboard, analysis, charts, blank, postmortem, monthly-review, data-quality.

`serve <schema>`

Start a local dev server with live reload.

bash

richview serve report.yaml
richview serve report.yaml --port 8080 --open

`export <schema>`

Export a report to PDF.

bash

richview export report.yaml
richview export report.yaml --paper Letter --landscape

`publish <schema>`

Package a report as a deployable static site.

bash

richview publish report.yaml
richview publish report.yaml --slug my-report --no-badge

`watch <schema>`

Watch a schema file and rebuild on every change.

bash

richview watch report.yaml
richview watch report.yaml --include data.csv

`convert <schema>`

Convert a report between JSON and YAML formats.

bash

richview convert report.yaml --to json
richview convert report.json -o report.yaml

`diff <base> <head>`

Compare two report versions and show what changed.

bash

richview diff v1.yaml v2.yaml

`merge <files...>`

Merge multiple report files into a single report.

bash

richview merge part1.yaml part2.yaml
richview merge *.yaml --title "Combined Report" --duplicates rename

`stats <schema>`

Show comprehensive statistics about a report: section counts, word counts, data coverage.

bash

richview stats report.yaml

`describe <schema>`

Generate a text description of a report for agent self-verification.

bash

richview describe report.yaml
richview describe report.yaml --text-only
richview describe report.yaml --section revenue-chart

`summary <schema>`

Show a compact text summary for agent pipelines.

bash

richview summary report.yaml --plain

`inspect <schema>`

Deep introspection: data profiling, assertion coverage, column statistics.

bash

richview inspect report.yaml

`extract <schema>`

Extract structured data from report sections.

bash

richview extract report.yaml --type chart
richview extract report.yaml --section revenue-chart --what data

`transform <schema>`

Apply transformations to a report.

bash

richview transform report.yaml --keep-type chart,table
richview transform report.yaml --head 5
richview transform report.yaml --strip-assertions --anonymize

`import <file>`

Import CSV or JSON data as a report section.

bash

richview import data.csv
richview import data.json --type chart --chart-type line

`embed <schema>`

Generate embeddable HTML for a report or section.

bash

richview embed report.yaml
richview embed report.yaml --section revenue-chart --mode html

`template <subcommand>`

List, preview, or apply built-in report templates.

bash

richview template list
richview template show dashboard
richview template apply dashboard --title "Q4 Dashboard"

`theme <subcommand>`

Manage corporate branding.

bash

richview theme init
richview theme validate brand.yaml
richview theme preview brand.yaml

`schema`

Output the RichView report JSON Schema for IDE autocomplete.

bash

richview schema
richview schema --compact
richview schema --search chart
richview schema --section big-number

`screenshot <schema>`

Take a PNG screenshot of a rendered report for agent verification.

bash

richview screenshot report.yaml
richview screenshot report.yaml --width 1440 --full-page

`gallery <dir>`

Generate an index page listing all reports in a directory.

bash

richview gallery ./reports --recursive

`completions [shell]`

Generate shell completion scripts.

bash

richview completions bash >> ~/.bashrc
richview completions zsh >> ~/.zshrc
richview completions fish > ~/.config/fish/completions/richview.fish

CLI Reference ​

Global options ​

Commands ​

generate <schema> ​

validate <schema> ​

lint <schema> ​

verify [report] ​

check <schema> ​

init [name] ​

serve <schema> ​

export <schema> ​

publish <schema> ​

watch <schema> ​

convert <schema> ​

diff <base> <head> ​

merge <files...> ​

stats <schema> ​

describe <schema> ​

summary <schema> ​

inspect <schema> ​

extract <schema> ​

transform <schema> ​

import <file> ​

embed <schema> ​

template <subcommand> ​

theme <subcommand> ​

schema ​

screenshot <schema> ​

gallery <dir> ​

completions [shell] ​

CLI Reference

Global options

Commands

`generate <schema>`

`validate <schema>`

`lint <schema>`

`verify [report]`

`check <schema>`

`init [name]`

`serve <schema>`

`export <schema>`

`publish <schema>`

`watch <schema>`

`convert <schema>`

`diff <base> <head>`

`merge <files...>`

`stats <schema>`

`describe <schema>`

`summary <schema>`

`inspect <schema>`

`extract <schema>`

`transform <schema>`

`import <file>`

`embed <schema>`

`template <subcommand>`

`theme <subcommand>`

`schema`

`screenshot <schema>`

`gallery <dir>`

`completions [shell]`