Documentation

New here? Read the documents under Get started in order. Already using Jaekit? Pick what you need under Use. File formats, exact rules and material for developing Jaekit come last. Every page is built as is from the repository's Markdown files.

Get started

Learn what problem Jaekit solves, install it, and hand over your first goal.

Understanding JaekitJaekit lets you check from records whether work you handed to Claude Code or Codex is really done. It is made of plugins for your agent, Spec, Seal and Spar, and two terminal pr…guides/OVERVIEW.en.mdInstall guideRead this to install Jaekit for the first time, update it to a new version, or remove it. Jaekit consists of two terminal programs, ha and spar, and three agent plugins, Spec, S…guides/INSTALL.en.mdWSL2 preparation guideRead this to use Jaekit on Windows. This route installs Jaekit inside Ubuntu 24.04 LTS amd64(x64) on WSL2. Installation, execution, and agent Skill use in actual WSL2 have not b…guides/WSL.en.md

Use

Look here to change or continue a goal, read a stopped task or a completion report, or set up independent review.

Usage guideLook here to change a goal, continue one after a conversation ends, answer what Seal asks, or read a completion report. New here? Read Understanding Jaekit and your first task i…guides/USAGE.en.mdReading work status and the completion reportRead this when you want to know why work stopped, or to check in detail what a completion report rests on. It covers pre-start checks, what a failure before the change means, th…guides/OPERATIONS.en.mdSpar independent review guideRead this before your first standard or strict goal, or when you change reviewers or read review records. Spar is the independent review tool that has reviewers outside the work…guides/SPAR.en.md

File and record formats and rules

These documents state exactly the formats of the goal documents, working files and check and review records Jaekit reads and writes, and the rules that compute status and completion from those records. You do not need them to hand work to your agent. Read them when you build a tool that reads the records or need the exact condition for a behavior. They live in the repository's contracts/ folder; "contract" in their titles means these formats and rules the programs and tools keep. Korean is the original and an English translation sits beside it; where the two differ, the original decides.

Show 13 documents

Formats and rules overviewThe documents in this group and what each covers.contracts/README.en.mdGoal document format (SPEC.md)The sections of SPEC.md and its completion conditions (AC-n), written by Spec and read by Seal.contracts/goal-docs.en.mdExecution bundle format (PLAN, REVIEW, PROGRESS)What PLAN.md, REVIEW.md and PROGRESS.md hold, and the completion report, written by Seal.contracts/bundle.en.mdRun record format and completion (runs.jsonl)The lines of runs.jsonl, the ha commands, and how status and completion are computed from the record.contracts/run-record.en.mdCheck declarations and resultsHow a check for a change condition declares what it checks and reports a violation or a pass.contracts/check-result.en.mdThe executor's authority and completion rulesWhat an agent following Seal may do, and when it may declare completion.contracts/role-card.en.mdReview round record formatThe round record spar run leaves, and how findings are classified and handled.contracts/review-round.en.mdReview gate formatThe gate file spar gate writes when it judges whether review is finished.contracts/review-gate.en.mdSpar configuration format (spar.toml)The spar.toml files that choose reviewers and review settings.contracts/spar-config.en.mdSpar input formatsThe inputs spar accepts, and what happens to input outside them.contracts/spar-input.en.mdha capabilities and compatibilityHow ha capabilities shows what the installed ha supports.contracts/core-capabilities.en.mdDecision history format (optional)The decision history recorded with ha history: observations, causes, decisions and more.contracts/decision-history.en.mdPost-completion findings formatHow a problem found after completion is recorded apart from that completion.contracts/findings.en.md

Developing Jaekit

Read these to build, change and verify Jaekit itself. You do not need them to use Jaekit.

Show 5 documents

Building from source and registering for developmentRead this when you change or try out Jaekit itself. You do not need it to use Jaekit; to use it, follow the install guide.guides/DEVELOPMENT.en.mdReading CI resultsRead this when you send a change to the Jaekit repository or interpret its CI results. You do not need it to use Jaekit. The CI workflow runs on pull requests and pushes to main…guides/CI.en.mdCommon invariants and regression checksJaekit's common invariants and the regression checks that guard them.contracts/regressions.mdWhat the repository's check tools observeWhat the check tools of the Jaekit repository observe.contracts/repository-producers.en.mdNative Windows candidate installationRead this when you help develop Jaekit and try the native Windows candidate. To use Jaekit on Windows, see the WSL2 preparation guide. This guide covers two paths targeting Wind…guides/WINDOWS.en.md