ValidationEngine 1.0.4
dotnet tool install --global ValidationEngine --version 1.0.4
dotnet new tool-manifest
dotnet tool install --local ValidationEngine --version 1.0.4
#tool dotnet:?package=ValidationEngine&version=1.0.4
nuke :add-package ValidationEngine --version 1.0.4
ValidationEngine
Core deterministic mechanical rule engine and orchestrator for the
ValidationEngine standards validation
suite, distributed as the validation-engine .NET global tool.
What It Is
The entry point and orchestrator for a validation run — a standalone .NET global tool that owns
the deterministic rule engine and coordinates the optional ValidationEngine.Agent and
ValidationEngine.Link add-on tools when they are installed.
What It Does
validation-engine validates a target repository against a standards corpus (see
Standards Source):
- Runs deterministic, mechanical rule checks against the repository.
- Orchestrates optional sibling tools —
validation-engine-agentfor AI-assisted manual-only rule evaluation andvalidation-engine-linkfor markdown link validation — when they are installed and applicable to the current run. - Renders results as Markdown and JSON via
ValidationEngine.Reporting, writes them toWorking/ValidationDiscrepancies.md/.json, and retains a pruned run history underWorking/ValidationHistory/. - Exits with a status code reflecting the outcome:
0clean,1violations or manual-review items present,2engine errors.
Its Modularity
ValidationEngine depends on ValidationEngine.Models (shared contracts) and
ValidationEngine.Reporting (default renderers, used only because this project's Program.cs is
a composition root — any other consumer is free to supply its own renderer implementations).
ValidationEngine.Agent and ValidationEngine.Link are launched as external sibling processes,
not compiled dependencies, so each can be installed, updated, or omitted independently without
requiring a new release of this package.
How It Works
- Resolves the repository root and the standards corpus location.
- Runs its deterministic mechanical rule set against the repository.
- Launches
validation-engine-agentand/orvalidation-engine-linkas sibling processes when they are installed and applicable rules require them. - Merges all findings into a single report, renders it, writes it to disk, and prunes history.
- Returns an exit code reflecting the outcome, suitable for CI/PR gating.
Design Notes
See KnowledgeBase.md for recorded design decisions and rationale, including why repository-local addenda suppress findings rather than removing rules from the run.
Installing
dotnet tool install --global ValidationEngine
Usage
Run from the root of the repository you want to validate:
validation-engine
| Argument | Description |
|---|---|
-RepositoryRoot <path> |
Repository to validate. Defaults to the current directory. |
-GlobalStandardsRoot <path> |
Standards corpus location override; falls back to GLOBALSTANDARDS_ROOT env var, then "standardsPath" in validationengine.config.json, then Docs/Standards under the repository root. |
-Mode <Manual\|Pr\|...> |
Run mode; controls which rule set(s) execute. Defaults to Manual. |
-TargetBranch <branch> |
Base branch for PR-mode diff scoping. |
License
MIT — see LICENSE.
License
MIT — see LICENSE.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
This package has no dependencies.