Skip to main content

Governance Report Reference

This page documents the stable operator-facing contract for agentxchain report.

This is not protocol v6. It is a derived reporting surface built on top of verified export artifacts. For the artifact contract itself, see Export Schema Reference. For the constitutional boundary, see Protocol Reference v6.

CLI Surface

agentxchain report [--input <path>|-] [--format text|json|markdown]
FlagDefaultMeaning
--input <path>-Read an export artifact from a file, or - for stdin
--format <format>textOutput text, json, or markdown

report verifies the export artifact first. It does not read live repo state directly. If the artifact fails verification, the command fails closed and returns verifier-backed errors instead of a success summary.

Exit Codes

Exit codeMeaning
0Export artifact verified and report rendered successfully
1Export artifact was readable JSON but failed self-verification
2Command or input error

Success JSON Shape

When --format json succeeds, the command emits:

FieldTypeMeaning
report_versionstringCurrent report contract version. Today: 0.1
overall"pass"Always "pass" on successful report generation
generated_atstringISO timestamp for report generation
inputstringResolved file path or "stdin"
export_kindstringagentxchain_run_export or agentxchain_coordinator_export
verificationobjectEmbedded verify export report proving the artifact passed validation
subjectobjectHuman-oriented derived summary for the verified artifact

verification

The embedded verification object mirrors the successful verify export --format json shape:

  • overall
  • schema_version
  • export_kind
  • file_count
  • repo_count
  • errors

On successful reports, verification.overall is always pass and errors is empty.

subject.kind = governed_run

Run-export reports carry:

KeyMeaning
subject.projectProject identity, template, protocol mode, and governed config schema version
subject.run.run_idCurrent run id or null
subject.run.statusCurrent run status
subject.run.phaseCurrent run phase
subject.run.blocked_onExported blocked-state string or null
subject.run.blocked_reasonExported structured blocked-reason object or null
subject.run.active_turn_countCount of active turns
subject.run.retained_turn_countCount of retained turns
subject.run.active_turn_idsActive turn ids
subject.run.retained_turn_idsRetained turn ids
subject.run.active_rolesSorted active role ids
subject.run.budget_statusspent_usd / remaining_usd when present
subject.artifactsExport-derived evidence counts and intake/coordinator presence flags

subject.artifacts includes:

  • history_entries
  • decision_entries
  • hook_audit_entries
  • notification_audit_entries
  • dispatch_artifact_files
  • staging_artifact_files
  • intake_present
  • coordinator_present

subject.kind = coordinator_workspace

Coordinator-export reports carry:

KeyMeaning
subject.coordinatorCoordinator identity, schema version, repo count, workstream count
subject.run.super_run_idCurrent coordinator run id or null
subject.run.statusCurrent coordinator status
subject.run.phaseCurrent coordinator phase
subject.run.barrier_countNumber of coordinator barriers
subject.run.repo_status_countsStatus histogram derived from coordinator state
subject.run.repo_ok_countNumber of child repo exports that verified cleanly
subject.run.repo_error_countNumber of child repo exports that failed
subject.reposPer-repo summary rows for paste-friendly reporting
subject.artifactsCoordinator history and decision counts

Each subject.repos[] row includes:

  • repo_id
  • path
  • ok
  • status
  • run_id
  • phase
  • project_id
  • project_name
  • error

Human-Readable Formats

text

Plain-text output is intended for terminal inspection. It includes:

  • verification status
  • project/workspace identity
  • run/coordinator status and phase
  • turn or repo counts
  • artifact evidence counts
  • blocked-state or barrier information when present

markdown

markdown exists for copy-paste into pull requests, release notes, tickets, or audit records without manual reformatting. It uses the same verified report data as json, but renders it as a compact heading plus flat bullet summary.

Failure Shapes

Verification failure (exit 1)

When the input is valid JSON but the artifact fails self-verification:

FieldTypeMeaning
overall"fail"Report generation refused because the artifact is invalid
inputstringResolved file path or "stdin"
messagestringHuman-readable refusal message
verificationobjectEmbedded verifier report with errors explaining the mismatch

Command or input error (exit 2)

When the file cannot be read or the JSON cannot be parsed:

FieldTypeMeaning
overall"error"Command-level failure
inputstringResolved file path or "stdin"
messagestringHuman-readable error description

If you need artifact integrity proof, use verify export. If you need the raw artifact schema, use Export Schema Reference.