ForgeFlow / User guide

ForgeFlow / Reference

Local Data And Privacy

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.

Forgeflow stores its workflow artifacts locally. Agent prompts and selected project context are still processed by the Claude Code or Codex host and its configured model provider. Local storage does not mean offline model execution. Explicit update, GitHub shipping, and optional team-sync actions can use the network.

Local State

Workflow state is stored under:

.forgeflow/<project-name>/

This can include:

User operating preferences are stored under:

~/.claude/forgeflow/user-operating-profile.jsonl

Project experience preferences are stored under:

.forgeflow/<project-name>/project-experience-profile.jsonl

These profile records are local advisory guidance. Keep global user operating preferences free of project names, private URLs, source snippets, customer names, raw settings, and secrets. Project experience preferences should stay project-local and should not become global defaults unless the user explicitly records them as global operating preferences.

Telemetry

Forgeflow telemetry is JSONL and is intended for local use:

~/.claude/projects/<project>/memory/forgeflow-metrics.jsonl
~/.codex/projects/<project>/memory/forgeflow-metrics.jsonl

Telemetry helps summarize:

Project-local context trend history is stored at:

.forgeflow/context-advisor-history.jsonl

This file is compact local telemetry. It records token estimates, savings, budget status, violation counts, and recommendation actions from context advisor runs.

Project code-map trend history is stored at:

.forgeflow/<project-name>/context/code-map-history.jsonl

This file is compact local topology telemetry. It records summary counts, top hotspots, changed-section hints, provenance source, and previous-run comparison inputs. It does not store file contents. The code-map helper retains the latest 50 snapshots by default.

Sharing

Nothing in the local workflow requires hosted telemetry. If you enable team sync, review what state files are copied and use a private remote.

For evaluation output, share aggregate summaries by default:

scripts/forgeflow/render-evaluation-report.js --outcomes .forgeflow/<project>/review-outcomes.jsonl --context-root .forgeflow --public --out .forgeflow/<project>/evaluation-summary.md

Keep raw review-outcomes.jsonl, user/profile records, context packets, memory summaries, implementation notes, and telemetry rows local unless the receiving audience is allowed to see the underlying project context. For team trials, use Team Privacy Boundaries to choose between local-maintainer, private-team, and public sharing levels. See Evaluation Sharing and Public-Safe Examples.

Support bundles include a snippet-free redaction preview that reports sensitive categories and counts without showing the matched values. Use it as a starting point, not as proof that the bundle is public-safe.

Implementation notes live at .forgeflow/<project-name>/implementation-notes.md. They are local handoff context for decisions, spec gaps, tradeoffs, deviations, follow-ups, and validation notes discovered during /implement. Keep them out of commits and do not paste secrets, raw settings JSON, tokens, private URLs, customer names, or large source snippets into the file.

The local dashboard reads metrics from ~/.claude/projects/<project>/memory/forgeflow-metrics.jsonl and ~/.codex/projects/<project>/memory/forgeflow-metrics.jsonl, then reads project readiness from .forgeflow/<project-name>/context/ and .forgeflow/<project-name>/release-readiness/. The dashboard server is local-only, serves API responses with Cache-Control: no-store, and the Project Readiness panel copies suggested commands instead of executing them.

Live Workshop Data

The dashboard also displays reported activity and a read-only relay of agent messages. The activity service saves its chat log by default to the operating system temporary directory as agent-chat-log.md; this log can contain task and project details. Its session credential is stored in a separate restricted token file (AGENT_CHAT_TOKEN_FILE can override its location). Keep both out of commits and support uploads. Browser session credentials and same-origin checks protect the local relay; they do not make copied logs safe to publish.

Codex metrics discovery honors CODEX_HOME; the default paths above describe a standard installation. The dashboard is a local tool, not a hosted multi-user service.

Sensitive Files

Forgeflow commands are designed to avoid reading secrets such as .env, keys, certificates, and token-like filenames during review context loading.

Context helpers use deny rules for generated, dependency, and sensitive-looking paths when building scope and context artifacts. Review generated packets before sharing them outside your machine.