This repository has been archived on 2026-09-16. You can view files and clone it, but cannot push or open issues or pull requests.
win-diagnostics-analysis/docs/standalone.md

47 lines
1.7 KiB
Markdown

# Standalone use
## Install and verify
Runtime analysis requires Bash, jq, and standard Unix utilities. Python and uv
are used only for tests. Reportist,
beffroi-reports, the integration workspace, and legacy sources are not runtime
dependencies.
```bash
make test
```
```bash
bash tools/analyse.sh capture.json \
--evidence-root . --output diagnostic.json \
--reference-time 2026-09-15T12:00:00Z \
--producer-version "$(git rev-parse HEAD)"
bash tools/validate.sh diagnostic.json --evidence-root .
```
Both commands return 0 on success, 1 for input/validation/I/O failures, and 2 for
invalid CLI usage. Existing analysis output requires `--force`.
## Collection status
Native collection has not yet been migrated into this standalone repository or
validated on a supported Windows worker. Offline analysis is supported and tested
on sanitized schema-1/2 captures. Missing, skipped, unavailable, or truncated
sections are limitations and never evidence of system health.
## Privacy and troubleshooting
Captures can contain host names, user paths, software inventory, device IDs,
events, and security configuration. Store real captures in the ignored
`collection/`, `captures/`, or `local-data/` directories and review every fixture
before committing it.
- “input must be inside evidence root”: choose the capture's containing directory.
- Unsupported schema: retain the source unchanged and use schema 1 or 2.
- Invalid timestamp: use timezone-qualified ISO 8601 times.
- Existing output: choose a new path or pass `--force` deliberately.
- Evidence mismatch: validate against the unchanged capture used for analysis.
The fixtures use synthetic values. The integration repository pins the verified
revision and owns cross-component orchestration.