Guide
Configuration
Envidence stores its configuration next to the evidence. You can use the default data directory, keep everything inside a project, or pass a store path to each command.
Store location
The default store is:
- Windows:
%LOCALAPPDATA%\Envidence - macOS and Linux:
$XDG_DATA_HOME/envidenceor~/.local/share/envidence
The store choice follows this order:
--store <path>on the command.- The
ENVIDENCE_HOMEenvironment variable. - The default platform data directory.
Per project
# One command at a time.
evd init --store ./.envidence
evd watch --store ./.envidence -- npm test
# Or set a base for the shell session.
export ENVIDENCE_HOME=./.envidence
evd initOn PowerShell:
$env:ENVIDENCE_HOME = "./.envidence"
evd init
evd watch -- npm testKeep the store out of Git
.gitignore before you commit.Configuration file
Each store has a config.json. Use evd config path to print its location. The file is created by evd init or the first command that uses the store.
evd config path
evd config list
evd config get profile
evd config get collectors.tasks
evd config set profile fast
evd config set ui.port 4317Values are parsed as booleans, numbers, arrays, or JSON when possible. Changes apply to future commands. Existing snapshots are not rewritten.
Useful settings
| Key | Purpose |
|---|---|
profile | Default collector profile, fast or full. init uses full unless you pass --fast. |
redaction | Default report redaction level. |
retention.keep | Number of recent snapshots to keep during pruning. Default is 50. |
retention.olderThanDays | Only prune snapshots older than this many days. Default is 30. |
collectors.* | Turn individual collectors on or off, such as services, tasks, programs, wsl, or vscodeExtensions. |
project.maxFiles | Maximum project source files to inspect for metadata and environment references. Default is 200. |
project.maxBytes | Maximum bytes read per project file. Default is 524288. |
ui.port | Default dashboard port. The server falls back to a free port if it is taken. |
rollback.safetySnapshot | Take a pinned full snapshot before applying a rollback. Keep this on. |
Collector profiles
Fast skips slower collectors and is the default for evd watch. Full collects the broadest set and is the default for evd init. If a failure may involve services, tasks, programs, hotfixes, or WSL, use --full for the watched run.
evd snap --full
evd watch --full -- npm test
evd config set profile fullRetention and pruning
The default policy keeps the newest 50 snapshots and snapshots younger than 30 days. Pins, baselines, snapshots used by runs or cases, and safety snapshots are protected.
# Preview what would be removed.
evd prune
# Keep fewer or more snapshots.
evd prune --keep 30 --days 14
evd prune --keep 30 --days 14 --yesPinned snapshots can be created with evd snap --pin. Baselines are also protected by the store.
Delete the store
Deleting the store removes snapshots, cases, baselines, rollback records, and the evidence needed to review them. Generated report files are separate.
# Windows
Remove-Item -Recurse -Force ./.envidence
Remove-Item -Recurse -Force "$env:LOCALAPPDATA\Envidence"# macOS and Linux
rm -rf ./.envidence
rm -rf "${XDG_DATA_HOME:-$HOME/.local/share}/envidence"The store is sensitive
For collector details and secret handling, see Privacy. For server and rollback controls, see Security.