File and record formats and rulesView source

This is a formats and rules document. You do not need it to hand work to your agent; read it when you build a tool that handles the records or need the exact behavior. New here? Start with Understanding Jaekit.

Public product contracts

한국어 · English

This is a translation of the Korean original. Where the two differ, the Korean original decides.

These contracts define the current document formats and status computation of Spec and Seal, and the configuration and review record formats of Spar. The user requests, times and record numbers in the examples are there to explain the formats; they are not evidence of real work.

  • Goal documents: the Markdown that Spec writes and Seal reads
  • Execution bundle: plan, progress and completion report
  • Run record: ha commands, run/v1, status/v1, rule versions
  • Decision history: optional ha history, decision-history/v1, event relations and current judgments
  • Shared regression links: the product paths of I1–I5, protected regressions and open gaps
  • Role of the Seal executor: permissions and completion rules
  • Spar input format: the format of every input field spar accepts, the results for input outside the format, and their consumers (G1–G33)
  • Spar configuration: location and format of spar.toml, reviewer presets, the scope of project configuration
  • Review round: review-round/v1, packets, reviewer states, finding classification and disposition, caps
  • Review gate: review-gate/v1, states and exit codes, line count of review fixes

Installation and actual use start from the usage guide.

contracts/README.en.mdBuilt from bcaddb7603e8