ForgeFlow / User guide

ForgeFlow / Reference

Pilot Public Summary

Shell examples run from the target project root. For scripts/forgeflow/ commands, use the helper path from your ForgeFlow checkout, or replace that prefix with "${CODEX_HOME:-$HOME/.codex}/forgeflow/scripts/forgeflow/" for Codex and "$HOME/.claude/forgeflow/scripts/forgeflow/" for Claude Code. Run JavaScript helpers with node and shell helpers with bash. Replace <project> with the actual project folder name before running a placeholder example.

Use this after a real maintainer pilot when the selected sharing level allows a public-safe summary. The summary should provide aggregate evidence without exposing raw review records, context packets, source snippets, or private project details.

Precheck

Before generating a summary, confirm:

If any of these are false, keep the evidence local and skip public summary generation.

Generate

Create a timestamped public summary:

PROJECT="$(basename "$PWD")"
STAMP="$(date +%Y%m%d-%H%M)"
OUT_DIR=".forgeflow/${PROJECT}/public-summaries"
mkdir -p "${OUT_DIR}"

scripts/forgeflow/render-evaluation-report.js \
  --outcomes ".forgeflow/${PROJECT}/review-outcomes.jsonl" \
  --context-root .forgeflow \
  --budget-config .forgeflow-budget.json \
  --public \
  --out "${OUT_DIR}/${STAMP}-evaluation-summary.md"

If the project does not have context telemetry or a budget config yet, omit --context-root or --budget-config rather than inventing values.

Inspect

Read the summary before sharing:

sed -n '1,220p' "${OUT_DIR}/${STAMP}-evaluation-summary.md"

Check for:

If any appear, redact or keep the summary private.

Record

Update the pilot evidence note:

public_summary_generated: yes
public_summary_path:
sharing_level:
redactions_made:
shared_with:

Share

Prefer one of these formats:

Do not share review-outcomes.jsonl, raw context packets, memory summaries, or telemetry rows unless the receiving audience is allowed to see the underlying project context.