Windows diagnostic collection and analysis toolkit producing structured, machine-readable findings from system evidence.
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.
Go to file
Dandaedre f93c5d3083
Win Diagnostics CI Win Diagnostics failed CI.
Beffroi/win-diagnostics/pipeline/head There was a failure building this commit Details
docs: complete non-Python runtime migration
2026-09-16 00:29:32 +02:00
docs docs: complete non-Python runtime migration 2026-09-16 00:29:32 +02:00
examples feat: define diagnostic v1 contract and evidence validator 2026-09-15 16:32:36 +02:00
rules refactor: port diagnostic runtime to shell and jq 2026-09-16 00:27:49 +02:00
schemas feat: migrate first diagnostic event rule batch 2026-09-15 22:47:19 +02:00
tests refactor: port diagnostic runtime to shell and jq 2026-09-16 00:27:49 +02:00
tools refactor: port diagnostic runtime to shell and jq 2026-09-16 00:27:49 +02:00
.gitignore feat: define diagnostic v1 contract and evidence validator 2026-09-15 16:32:36 +02:00
AGENT.md refactor: port diagnostic runtime to shell and jq 2026-09-16 00:27:49 +02:00
AGENTS-TASKS.md docs: complete non-Python runtime migration 2026-09-16 00:29:32 +02:00
Jenkinsfile refactor: port diagnostic runtime to shell and jq 2026-09-16 00:27:49 +02:00
LICENSE Initial commit 2026-09-15 14:51:04 +02:00
Makefile refactor: port diagnostic runtime to shell and jq 2026-09-16 00:27:49 +02:00
README.md refactor: port diagnostic runtime to shell and jq 2026-09-16 00:27:49 +02:00
requirements.in feat: define diagnostic v1 contract and evidence validator 2026-09-15 16:32:36 +02:00
requirements.txt feat: define diagnostic v1 contract and evidence validator 2026-09-15 16:32:36 +02:00

README.md

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.

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 for repository ownership and development rules. 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 for setup and validation commands. The first offline analysis slice supports stored legacy capture schemas 1 and 2:

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. Native Windows collection and broader non-event evidence correlation are still migration work.

See standalone use 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.