@ccdd/core
v4.3.0
Published
Artifact, Critic, relationship and tool definitions for CCDD
Readme
CCDD
Let verification define the project. Give each Artifact its own criteria and the tools a reviewer needs to inspect it. An Artifact can be code, tests, a specification, an image or any other folder of project material.
Put a ccdd.json in that folder. It owns the Artifact's name, view tools and Critics. CCDD finds those declarations, connects references and collects actual review evidence.
project/
why/ccdd.json
spec/ccdd.json
tests/ccdd.json
implementation/ccdd.jsonA Critic can ask an Agent to compare Spec with Why, ask a person to compare two images, or run tests against an implementation. It belongs to the Artifact it evaluates. References such as {spec} connect it to the other Artifacts it uses.
flowchart LR
subgraph Project[Your project]
Why[Why] -. instruction .-> Spec[Spec]
Spec -. instruction .-> Tests[Tests]
Tests -. mount / instruction .-> Implementation[Implementation]
end
Project -. folder declarations .-> CCDD
CCDD --> Agent[Agent review]
CCDD --> Human[Human review]
CCDD --> Runtime[Runtime tests]
Agent --> Evidence[Actual evidence]
Human --> Evidence
Runtime --> Evidence
Evidence --> CCDD
style Project fill:#eef6ff,stroke:#5c83aa
style CCDD fill:#eef9ef,stroke:#588060These relationships define required input and verification, not execution order. Mutual dependencies are allowed: both Critics may run together, and final validation requires both matching results. Child Artifact folders are automatic dependencies. Logical mounts connect other folders without copies or symlinks.
Start with a runtime check
Use Node.js 22 LTS, version 22.19.0 or later.
npm install --ignore-scripts @ccdd/core@^4 @ccdd/project@^4Inside an Artifact folder, create ccdd.json:
{
"name": "implementation",
"critics": [{
"id": "tests",
"title": "Pass the implementation tests",
"profile": { "kind": "runtime", "command": "node", "args": ["--test", "check.test.mjs"] },
"payload": { "instruction": "Run the tests for {implementation}." }
}]
}Add your actual check.test.mjs, then run from the workspace root:
npx ccdd-project config check
npx ccdd-project plan implementation --recursive
npx ccdd-project verify implementation --recursive --wait
npx ccdd-project status implementationThe getting-started guide includes a complete runnable example. Version 4 is a breaking change; existing projects should follow the migration guide.
Read the result
Every actual review returns a verdict, summary and concrete evidence. GREEN means its criteria were met; RED means they were not. Execution problems produce ERROR. Final validation needs matching PASS evidence for all required Critics and dependencies. A folder without Critics stays UNREVIEWED unless explicitly declared basis: true.
An individual check runs its selected Critics immediately. If other required evidence is missing, their results are saved and the request is INCOMPLETE. Add --recursive to include those other evaluations. CCDD reuses matching actual evidence and computes freshness when queried; it does not store stale flags.
Reviews run in the workspace you supply. Keep it unchanged until completion, including Human waiting. Records, caches and generated output live outside it. To keep editing elsewhere, create your own worktree and pass it with --repo.
Next steps
- Define a custom view script with JSON stdin/stdout, using any language.
- Register optional text, image and desktop tools.
- Compose folders and mounts, including coding-style and blind image comparison Critics.
- Compute views on demand from scenario material.
- Configure Agent and Human reviewers.
- Try Why → Spec → Tests → Implementation.
- Look up commands and evidence rules.
The optional local monitor shows folders, relationships, cycles, review progress and saved results. Start it with npx ccdd-project monitor.
| Package | Responsibility |
| --- | --- |
| @ccdd/core | Public definitions and logical path resolution. |
| @ccdd/project | Validation, CLI, Broker, Executors and monitor. |
| @ccdd/default-tools | Optional common view scripts; no automatic registration. |
See Contributing, the context map, detailed contracts and release instructions. Repository content and review prompts use English.
License
MIT.
