61 lines
2.3 KiB
Markdown
61 lines
2.3 KiB
Markdown
# Win Diagnostics
|
|
|
|
Win Diagnostics is a toolkit for **collecting and analysing diagnostic information from Windows systems**.
|
|
|
|
Its goal is to turn raw system evidence into structured, traceable diagnostic findings.
|
|
|
|
```text id="aj3p4b"
|
|
Windows
|
|
↓
|
|
collect
|
|
↓
|
|
analyse
|
|
↓
|
|
diagnostic.json
|
|
```
|
|
|
|
The structured diagnostic output can be inspected directly or consumed by other tools and reporting systems.
|
|
|
|
Win Diagnostics does not generate reports or PDFs; diagnostic collection and interpretation are intentionally kept independent from presentation.
|
|
|
|
## Status
|
|
|
|
🚧 **Early development / migration**
|
|
|
|
The project is being progressively rebuilt from the previous `WinDiagnostics` tooling with a cleaner separation between collection, analysis and reporting.
|
|
|
|
See [AGENT.md](AGENT.md) for repository ownership and development rules.
|
|
[AGENTS-TASKS.md](AGENTS-TASKS.md) tracks migration passes, completed work,
|
|
acceptance criteria, and the next-pass handoff.
|
|
|
|
## Contract validation
|
|
|
|
The version-1 schema, standalone validator, and synthetic examples are available.
|
|
See [contract documentation](docs/diagnostic-contract.md) for setup and validation commands.
|
|
The first offline analysis slice supports stored legacy capture schemas 1 and 2:
|
|
|
|
```bash
|
|
bash tools/analyse.sh /path/to/capture.json \
|
|
--evidence-root /path/to \
|
|
--output /path/to/diagnostic.json \
|
|
--reference-time 2026-09-15T12:00:00Z \
|
|
--producer-version "$(git rev-parse HEAD)"
|
|
```
|
|
|
|
It normalizes collection coverage, preserves event values and JSON Pointers,
|
|
and implements all 53 reviewed event rules plus seven candidate watchlist entries. Other events remain explicitly
|
|
`unanalysed`. Reference time and producer version are
|
|
required for reproducibility. Existing output requires `--force`. Exit codes are
|
|
0 for validated output, 1 for input, validation, or I/O failure, and 2 for invalid
|
|
CLI usage. See the [rule migration status](docs/rules.md). Native Windows
|
|
collection and broader non-event evidence correlation are still migration work.
|
|
|
|
See [standalone use](docs/standalone.md) for installation, exact commands,
|
|
privacy guidance, troubleshooting, and native-collection limitations.
|
|
|
|
## License
|
|
|
|
Software source code is licensed under the **MIT License**.
|
|
|
|
Diagnostic data produced by the tool is not automatically covered by the software license.
|