Skip to content

Project artifacts

HelmIt keeps project context in files so that decisions and proof do not depend on one conversation’s memory. Most live under .helmit/. You can inspect them, but let HelmIt skills update the workflow files. To resume, ask for /helmit:next; you do not have to read every file at the start of each session.

These files are versioned in Git. They let someone else continue with the same product definition, decisions, and delivery history.

File under .helmit/What it is for
SPEC.mdDefines the product as a whole: what to build and why. It is created during project preparation.
ROADMAP.mdLists delivery phases, their order and dependencies. It shows what has shipped.
REQUIREMENTS.mdRecords requirements with stable IDs such as REQ-021, and whether they still need work or have been proven.
STATE.mdKeeps a short position for resumption: current work, next step, blockers, and pending decisions. It does not duplicate plans or proof.
KEEL.mdHolds project rules, architecture decisions, and test, build, and lint commands. The agent reads it at session start.
config.jsonHolds languages and settings that HelmIt commands need to read.
INBOX.mdCaptures findings outside the current work and their triage destination. Resolved items move to versioned history in history/.
CHANGES.mdRecords localized changes with a CHG-NNN ID and their completion. A CHG need not become a phase.
spec-sources.jsonWhen a spec uses external documents as sources, records which ones and allows later changes to be detected.

INBOX.md holds the observation before deciding what to do; CHANGES.md holds the localized change once it has a route. Read Inbox and changes for the triage process.

Each delivery has its own directory at .helmit/phases/<id>/:

FileWhen it appears and what it records
SPEC.mdDefines that phase’s outcome and acceptance criteria. It is distinct from the product spec.
CHART.mdBreaks the delivery into tasks, links them to requirements, and states how to verify completion. implement can create or adapt this plan before building; chart lets you inspect it separately if you want.
VALIDATION.mdRecords final delivery proof and anything still awaiting human evaluation. ship uses it to close the phase.

A small, well-defined correction follows the CHG route outside phases. It does not acquire a phase SPEC.md, CHART.md, and VALIDATION.md just to fit the process. See the phase lifecycle for a full delivery.

These files stay outside Git. They help track sessions, execution, and costs, but they are not the contract shared with someone cloning the project. Setup configures .gitignore to keep them local.

File under .helmit/What it is for
lock.json and executor-lease.jsonCoordinate writes and signal recent activity from a task executor.
session-activity/Keeps short-lived, per-session host activity signals without claiming a task or phase.
run.jsonlRecords task, session, and gate events; helps recognize and reconcile an interruption.
metrics.jsonlStores available token-usage captures, including those used by the dashboard.
HANDOFF.mdLeaves narrative context for the next session; current facts are checked again on resumption.
dashboard.htmlShows a generated view of the artifacts and can be recreated.
quality-receipt.jsonKeeps local full-suite proof that can be reused if the verified code and commands are still the same.
yolo.jsonHolds a mandate for this machine when you have enabled one.
map/Holds the optional, rebuildable repository map.
proof-worktrees/Temporarily holds Git copies used to run proof against the exact version under evaluation.

For example, when you return to a project after a few days, /helmit:next uses the shared position and available local records to suggest the next step. If work was interrupted, it may ask for reconciliation before continuing. You do not need to reconstruct the flow one file at a time.

To interpret the generated figures, read Dashboard. For how proof is recorded, read Testing.