Envidence
Documentation menu

Guide

Reports

A report turns a case or run into one HTML file with inline styles, scripts, and data. You can open it offline or attach it to an issue, depending on the redaction level you choose.

Create a report

shell
evd report --case CASE-... --out envidence-case.html

# Report the latest case if you omit --case.
evd report --out envidence-case.html

# Report a run instead of a case.
evd report --run RUN-... --out envidence-run.html

# Open the file when it is ready.
evd report --case CASE-... --open

The output path is resolved from the current directory. The report contains the command, exit code, findings, changes, evidence, and a remediation preview. It does not need a network connection to open.

Choose a redaction level

LevelUse it forWhat it removes
standardSharing with a teammate or a public issue after review.Home directory, project path prefixes, hostname, username, public-looking IPs, and recognized token shapes.
strictSharing outside your team or in a sensitive report.Everything standard removes, plus project identifiers, branch and commit details, service names, Windows and POSIX paths, and long commit hashes.
noneLocal review only.Secret-marked values and recognized token shapes only. Paths, hostnames, usernames, and ordinary values remain.
shell
evd report --case CASE-... --redact strict --out case-strict.html
evd report --case CASE-... --redact none --open

Redaction is best effort

Pattern matching cannot catch every secret, especially custom token formats or secrets in unusual command output. Review the HTML before sharing it. Even a strict report can contain unique machine details.

What is inside

  • The case title, status, command, and exit code.
  • The reference snapshot and the observed changes.
  • Ranked hypotheses with their scores and evidence.
  • Before and after values for relevant changes.
  • A remediation preview and manual steps.
  • A visible warning when the report is unredacted.

Reports are single files. There are no external scripts, styles, fonts, images, or tracking pixels. A report over 3 MiB produces a warning, but it is still written.

Share a case

A practical sharing flow:

  1. Open the case in the dashboard or run evd case show.
  2. Check the top findings and the raw changes.
  3. Create a strict report if the file leaves your machine.
  4. Open the HTML file and inspect the content that will be shared.
  5. Attach it to the issue with a short note about the reference state.

If a report contains a secret you missed, rotate the secret. Deleting the report is not enough once it has been shared.

Report from the dashboard

The case file in the local dashboard can export a report with standard or strict redaction. The output is the same self-contained format. See Dashboard.

For the data handling details, see Privacy and Security.