`homeboy report` command reference

Generated from the clap command tree. This page is the complete synopsis, argument, flag, and subcommand surface for this command family.

Concepts, recipes, and contracts are hand-written in docs/commands/report.md.

Global flags apply to every command and are documented once in the root command reference.

homeboy report

sh
homeboy report <COMMAND>

Render reports from Homeboy structured output artifacts

SubcommandSummary
homeboy report failure-digestRender a markdown failure digest from Homeboy command output JSON files
homeboy report performance-digestRender a generic performance digest from Homeboy run artifacts
homeboy report bench-coverageReport list-only benchmark coverage for hot command paths
homeboy report browser-evidence-compareCompare before/after browser evidence artifact sets
homeboy report matrix-artifactsSummarize matrix-style run artifacts and finding packets
homeboy report compareCompare structured matrix/report artifacts

homeboy report failure-digest

sh
homeboy report failure-digest [OPTIONS]

Render a markdown failure digest from Homeboy command output JSON files

OptionValueDescription
--output-dir<DIR>Directory containing audit.json, lint.json, test.json, etc
--results<JSON>Results JSON, e.g. ‘{"audit":"fail","lint":"pass"}’ (supports @file)
--run-url<URL>Workflow run URL used as the fallback full-log link
--tooling-json<JSON_OR_FILE>Optional tooling metadata JSON file (supports @file)
--commands<CSV>Commands in this run, used to derive default autofix candidates
--autofix-commands<CSV>Commands with autofix support. Defaults to failed audit/lint/test commands
--autofix-enabledflagWhether automated fixes are enabled for this run
--autofix-attemptedflagWhether automated fixes were already attempted in this run
--format<FORMAT>Output format. Markdown is the only supported report format for now Values: markdown.

homeboy report performance-digest

sh
homeboy report performance-digest [OPTIONS]

Render a generic performance digest from Homeboy run artifacts

OptionValueDescription
--output-dir<DIR>Directory containing Homeboy run artifacts such as resource-summary.json and bench.json
--metadata-json<JSON_OR_FILE>Optional run metadata JSON, e.g. observation metadata or a status file (supports @file)
--run-url<URL>Workflow run URL used as the fallback full-log link
--min-samples<MIN_SAMPLES>Minimum run count for baseline health checks
--max-cv-pct<MAX_CV_PCT>Maximum coefficient of variation percentage before a baseline is considered noisy
--format<FORMAT>Output format. Markdown is the only direct-render report format for now Values: markdown.

homeboy report bench-coverage

sh
homeboy report bench-coverage [OPTIONS] [COMPONENT]

Report list-only benchmark coverage for hot command paths

ArgumentRequiredDescription
[COMPONENT]noComponent ID (optional — auto-detected from CWD if omitted)
OptionValueDescription
--path<PATH>Override the component checkout path for this invocation
--extension<ID>One-shot extension override for the current invocation
--settings-json-file<FILE>Load typed setting overrides from a JSON object file. Repeatable
--setting<KEY=VALUE>String setting override. Repeatable
--setting-json<SETTING_JSON>Typed-JSON setting override. Repeatable
--allflagInspect every registered component instead of the selected component
--format<FORMAT>Output format Values: markdown, json.

homeboy report browser-evidence-compare

sh
homeboy report browser-evidence-compare [OPTIONS]

Compare before/after browser evidence artifact sets

OptionValueDescription
--baseline-dir<DIR>Directory containing baseline browser evidence JSON artifacts
--candidate-dir<DIR>Directory containing candidate browser evidence JSON artifacts
--baseline-label<BASELINE_LABEL>Label for the baseline artifact set
--candidate-label<CANDIDATE_LABEL>Label for the candidate artifact set
--include-local-pathsflagInclude local filesystem paths in Markdown output. By default Markdown only uses relative artifact names and URLs
--format<FORMAT>Output format. Markdown is direct-rendered; JSON uses the normal command envelope Values: markdown, json.
--visual-compareflagRun visual screenshot comparisons through a declared visual compare provider
--visual-artifacts-dir<DIR>Directory where visual compare artifacts should be written
--visual-compare-provider<COMMAND>Executable implementing the generic Homeboy visual compare provider contract
--visual-provider-arg<ARG>Extra argument forwarded to the visual compare provider before the input JSON path
--visual-threshold<RATIO>Visual mismatch threshold forwarded to the visual compare provider

homeboy report matrix-artifacts

sh
homeboy report matrix-artifacts [OPTIONS] <RUN_ID>

Summarize matrix-style run artifacts and finding packets

ArgumentRequiredDescription
<RUN_ID>yesObservation run ID or the human --run-id launch label to summarize
OptionValueDescription
--format<FORMAT>Output format: json or markdown

homeboy report compare

sh
homeboy report compare [OPTIONS]

Compare structured matrix/report artifacts

OptionValueDescription
--old<RUN_OR_ARTIFACT>Baseline artifact input: local JSON path, run id, or run:artifact / run/artifact ref
--new<RUN_OR_ARTIFACT>Candidate artifact input: local JSON path, run id, or run:artifact / run/artifact ref
--format<FORMAT>Output format Values: markdown, json.