Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
igris
command
Command igris runs a markdown task plan through Claude Code sessions.
|
Command igris runs a markdown task plan through Claude Code sessions. |
|
Package examples embeds the canonical example plan and the plan templates so `igris init --example` and `igris init --template` can write them; the files next to it stay readable on their own.
|
Package examples embeds the canonical example plan and the plan templates so `igris init --example` and `igris init --template` can write them; the files next to it stay readable on their own. |
|
internal
|
|
|
adapt
Package adapt implements `igris adapt` (SPEC §9): one Claude Code session converts a plan that fails `igris check` into a canonical proposal in .igris/adapt/, which igris validates for the owner's review.
|
Package adapt implements `igris adapt` (SPEC §9): one Claude Code session converts a plan that fails `igris check` into a canonical proposal in .igris/adapt/, which igris validates for the owner's review. |
|
backend
Package backend defines the seam between the igris engine and the terminal multiplexer that hosts Claude Code sessions (SPEC §11.1).
|
Package backend defines the seam between the igris engine and the terminal multiplexer that hosts Claude Code sessions (SPEC §11.1). |
|
backend/conformance
Package conformance is the behavioral test suite every backend must pass (SPEC §11.1): open, prompt, state, focus and close a session; a session that went away; attach after an igris restart; a multi-line prompt with control characters; a side session (SPEC §6.10) and how attaching keeps it and task sessions apart; and, for a backend.Tailer, the tail.
|
Package conformance is the behavioral test suite every backend must pass (SPEC §11.1): open, prompt, state, focus and close a session; a session that went away; attach after an igris restart; a multi-line prompt with control characters; a side session (SPEC §6.10) and how attaching keeps it and task sessions apart; and, for a backend.Tailer, the tail. |
|
backend/fake
Package fake is an in-process backend for tests and --dry-run (SPEC §11.1).
|
Package fake is an in-process backend for tests and --dry-run (SPEC §11.1). |
|
backend/herdr
Package herdr is the herdr backend (SPEC §11.2).
|
Package herdr is the herdr backend (SPEC §11.2). |
|
backend/tmux
Package tmux is the tmux backend (SPEC §11.5, V03-P2): one window per task in the tmux server igris runs in, driven through the tmux CLI.
|
Package tmux is the tmux backend (SPEC §11.5, V03-P2): one window per task in the tmux server igris runs in, driven through the tmux CLI. |
|
checks
Package checks is the one ordered list of checks shared by `igris check`, `igris arise` (and its dry run), `igris doctor` and the home screen: tool versions, environment, herdr, git, igris.toml and the plan's hints and drift.
|
Package checks is the one ordered list of checks shared by `igris check`, `igris arise` (and its dry run), `igris doctor` and the home screen: tool versions, environment, herdr, git, igris.toml and the plan's hints and drift. |
|
config
Package config loads and validates igris.toml (SPEC §12).
|
Package config loads and validates igris.toml (SPEC §12). |
|
draft
Package draft implements `igris draft` (SPEC §9.1): a Claude Code session writes a plan proposal under .igris/draft/, igris validates it with the normal parser for the owner's review (the adapt review, §9), and only the owner's Accept writes it.
|
Package draft implements `igris draft` (SPEC §9.1): a Claude Code session writes a plan proposal under .igris/draft/, igris validates it with the normal parser for the owner's review (the adapt review, §9), and only the owner's Accept writes it. |
|
engine
Package engine holds igris's run logic: mode resolution, the Claude Code command line and the run loop.
|
Package engine holds igris's run logic: mode resolution, the Claude Code command line and the run loop. |
|
fsafe
Package fsafe reads files that an untrusted party may have replaced: a Claude Code session can write the plan, igris.toml and everything under .igris/ (SPEC §16).
|
Package fsafe reads files that an untrusted party may have replaced: a Claude Code session can write the plan, igris.toml and everything under .igris/ (SPEC §16). |
|
hook
Package hook turns Claude Code hook events into agent state (SPEC §6.3, V03-P1).
|
Package hook turns Claude Code hook events into agent state (SPEC §6.3, V03-P1). |
|
look
Package look is the igris design language as data (SPEC §14, §15.4, docs/design.md): the glyphs, the status words, the severities and their colors, the rank colors, and how counts, durations, times and tokens are written.
|
Package look is the igris design language as data (SPEC §14, §15.4, docs/design.md): the glyphs, the status words, the severities and their colors, the rank colors, and how counts, durations, times and tokens are written. |
|
notify
Package notify delivers igris events to the owner's channels (SPEC §10): the backend toast, ntfy, Discord, a webhook, Slack and Gotify.
|
Package notify delivers igris events to the owner's channels (SPEC §10): the backend toast, ntfy, Discord, a webhook, Slack and Gotify. |
|
plan
Package plan parses, validates, schedules and surgically rewrites the markdown task plan (SPEC §3–§5).
|
Package plan parses, validates, schedules and surgically rewrites the markdown task plan (SPEC §3–§5). |
|
project
Package project opens an igris project and does what the CLI and the home screen both need on it: build a run's engine exactly as `igris arise` does, set the project up (`init`), test notifications, and read the state the home screen shows.
|
Package project opens an igris project and does what the CLI and the home screen both need on it: build a run's engine exactly as `igris arise` does, set the project up (`init`), test notifications, and read the state the home screen shows. |
|
prompt
Package prompt renders the two prompts igris gives a Claude Code session (SPEC §6.1): the fixed igris rules and the per-task first message.
|
Package prompt renders the two prompts igris gives a Claude Code session (SPEC §6.1): the fixed igris rules and the per-task first message. |
|
qr
Package qr encodes a QR code (ISO/IEC 18004) for `igris serve token`'s pairing URL (SPEC §14): byte mode, error correction level M, versions 1–10, drawn with half blocks.
|
Package qr encodes a QR code (ISO/IEC 18004) for `igris serve token`'s pairing URL (SPEC §14): byte mode, error correction level M, versions 1–10, drawn with half blocks. |
|
report
Package report is the data behind igris's read-only commands: what `check`, `phases`, `status` and `arise --dry-run` show.
|
Package report is the data behind igris's read-only commands: what `check`, `phases`, `status` and `arise --dry-run` show. |
|
runner
Package runner runs external processes for igris.
|
Package runner runs external processes for igris. |
|
serve
Package serve hosts a run on a unix socket (SPEC §13, decisions.md V14-P1): the socket and its path, protocol 1's framing and messages, the snapshot a client starts from, and the fan-out of the engine's events to every attached client.
|
Package serve hosts a run on a unix socket (SPEC §13, decisions.md V14-P1): the socket and its path, protocol 1's framing and messages, the snapshot a client starts from, and the fan-out of the engine's events to every attached client. |
|
side
Package side opens, lists, focuses and closes side sessions (SPEC §6.10, since 1.2): Claude Code sessions the owner opens from the TUI that are not tasks.
|
Package side opens, lists, focuses and closes side sessions (SPEC §6.10, since 1.2): Claude Code sessions the owner opens from the TUI that are not tasks. |
|
state
Package state manages igris's .igris/ directory in the project root (SPEC §13): the run lock, state.json, the runs.jsonl log and the signal and prompt directories.
|
Package state manages igris's .igris/ directory in the project root (SPEC §13): the run lock, state.json, the runs.jsonl log and the signal and prompt directories. |
|
textsafe
Package textsafe cleans text igris did not write (plan cells, done notes, command output) before it is drawn on the owner's terminal or typed into a session's pane, so it can't carry escape sequences (SPEC §16).
|
Package textsafe cleans text igris did not write (plan cells, done notes, command output) before it is drawn on the owner's terminal or typed into a session's pane, so it can't carry escape sequences (SPEC §16). |
|
tui
Package tui is igris's terminal UI (SPEC §15): a Bubble Tea program fed by the engine's events that sends the owner's actions back as engine commands.
|
Package tui is igris's terminal UI (SPEC §15): a Bubble Tea program fed by the engine's events that sends the owner's actions back as engine commands. |
|
update
Package update is `igris update` and home's Check for updates (SPEC §14, §15.6, decisions.md V12-P4): it asks GitHub's releases API for the latest release, compares it with the running igris, tells how this igris was installed and builds the package manager's command for it.
|
Package update is `igris update` and home's Check for updates (SPEC §14, §15.6, decisions.md V12-P4): it asks GitHub's releases API for the latest release, compares it with the running igris, tells how this igris was installed and builds the package manager's command for it. |
|
usage
Package usage counts the tokens a Claude Code session's transcript records for one attempt of a task (SPEC §6.9, V11-P2).
|
Package usage counts the tokens a Claude Code session's transcript records for one attempt of a task (SPEC §6.9, V11-P2). |
|
tools
|
|
|
contract
Package contract holds the test that keeps docs/compatibility.md's surface → test map true: every surface SPEC §19 freezes has a row, and every test a row names exists.
|
Package contract holds the test that keeps docs/compatibility.md's surface → test map true: every surface SPEC §19 freezes has a row, and every test a row names exists. |
|
genformula
command
Command genformula renders the Homebrew formula from the GoReleaser output in dist/ (SPEC §18).
|
Command genformula renders the Homebrew formula from the GoReleaser output in dist/ (SPEC §18). |
|
signers
Package signers holds the tests that keep allowed_signers, the release key's public half, and the copy printed in README.md in agreement (SPEC §18, decisions.md V06-P1).
|
Package signers holds the tests that keep allowed_signers, the release key's public half, and the copy printed in README.md in agreement (SPEC §18, decisions.md V06-P1). |
|
sitedocs
command
Command sitedocs builds the documentation pages of the project site (decisions.md P0-09) from markdown: the pages written for the site in site/docs/ and the reference pages that live in docs/ (the plan format, the generated config reference, the compatibility promise), so those are published from the one copy and cannot drift.
|
Command sitedocs builds the documentation pages of the project site (decisions.md P0-09) from markdown: the pages written for the site in site/docs/ and the reference pages that live in docs/ (the plan format, the generated config reference, the compatibility promise), so those are published from the one copy and cannot drift. |
|
testmap
Package testmap reads the "→ test" maps in igris's docs (the threat model's rule → test map, the compatibility promise's surface → test map) for the tests that keep them true: every row names tests that exist.
|
Package testmap reads the "→ test" maps in igris's docs (the threat model's rule → test map, the compatibility promise's surface → test map) for the tests that keep them true: every row names tests that exist. |
|
threatmodel
Package threatmodel holds the test that keeps docs/threat-model.md's rule → test map true: every test it names exists (SPEC §16).
|
Package threatmodel holds the test that keeps docs/threat-model.md's rule → test map true: every test it names exists (SPEC §16). |
Click to show internal directories.
Click to hide internal directories.



