PermitGraph Docs

Artifact Reference

Meaning of each major generated file in a PermitGraph run.

What this is

This reference explains the generated files in .agent-permit/runs/<run_id>/.

When to use it

Use it when building integrations, reviewing findings, or asking an AI agent to inspect a run.

Command or example

find .agent-permit/runs/<run_id> -maxdepth 1 -type f | sort

Output to expect

Core artifacts:

FilePurpose
summary.mdhuman-readable scan summary
risk-report.mdexpanded risk explanation
permit.yamldeterministic permit status
raw-findings.jsonnormalized finding records
graph-paths.jsonsource-to-sink access paths
controls.jsoncontrols checked before approval
run-metrics.jsontiming, counts, and usage metadata
agent-investigation.mdoptional Deep Agent report

How to interpret it

Use YAML and JSON for tools. Use Markdown for reviewer decisions. Treat Deep Agent files as explanation and citation output.

Common mistakes

  • Parsing Markdown when JSON exists.
  • Reading agent-investigation.md without checking raw-findings.json.
  • Assuming artifact schemas are safe to change without dashboard and CI impact.

On this page