abcd

module
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 1, 2026 License: MIT

README

abcd logo

Agent-Based Configuration for Development

For people who know what they want to build and need help shipping it.

Release Last commit
Go 1.26 Built with Claude Code
macOS

What it is for

AI agents are very good at coding but not always at remembering human intentions for why the code was written. abcd is a host-agnostic configuration layer for intent-driven development, there to help you actually ship what you set out to build, including what was decided, what was rejected, and on what evidence.

In AI-assisted development, this (human) reasoning typically lives in transcripts that are hard to decipher after the fact. abcd keeps it as structured records agents and humans do read: The intent that says what shipping looks like, the decision that says what was chosen and what was refused, the specification that says how to build it, and the issue ledger that says what must be revisited. In abcd, these structured records are plain files that live inside the repository, and they are checked by gates, most of which refuse rather than warn, so a record that drifts from the repository is caught rather than noted. Whether what a record claims about the product holds is a second judgement: An audit reads a shipped intent's acceptance criteria against the code that shipped and states a verdict on each one. That verdict is recorded, not enforced.

Built in the open

abcd is an experiment. First, it is an experiment of building itself, which is why its documented development record is public and complete: Every decision, intent, specification, and issue, from the first commit onward, with the reasoning attached. That record is the demonstration. Not a claim that the approach works, but the trail of a real product being built this way, including the parts that were wrong: Reversed decisions, abandoned designs, and defects found by the gates and recorded before they were fixed.

abcd is also an experiment for the team building it. As self-declared enthusiastic dilettantes, we learn best by doing stuff, and abcd demonstrates not only what it does, but also how we're learning AI-assisted development while building it.

If you want to know more about abcd, you can interrogate its entire development record at abcdev.app/record/, alongside more details on who abcd is for, the different roles, artefacts, and process. If you want to get involved, watch the repository or open a discussion.

Key principles

abcd is founded on several principles, some of which guide its design while others guide how development artefacts are recorded.

Design principles

What abcd is (and, by extension, what it refuses to become):

  • abcd builds abcd: The framework develops under its own record and gates, so every convention it imposes is one the team lives with (for better or worse!).
  • Prefer the experiment to the inference: A claim that can be settled by running the system is settled by running it; reading the files yields a working assumption, never a finding.
  • Verifier selects, gates decide: A model's verdict ranks, flags, and proposes; admission to the record is decided by deterministic gates.
  • And: Less, but better (Dieter Rams): Reach for the subtraction first, which, in abcd translates into fewer verbs, records, and rules.

Record principles

How intents, decisions, specifications, and issues are made and kept true:

  • Work starts from an intent: A shipping change opens as a press release for the user it serves; the work exists to make that page true.
  • The record lands with the act: A record is written by the same commit that makes it true.
  • Enforcement claims are facts: A gate is described only where it demonstrably runs; a planned check is an intent.
  • And: The record is part of the product: Intents, decisions, specifications, and issues are plain files in the repository, versioned and reviewed like the code they explain.

Install

If you wish to experiment with abcd, we recommend installing it as a plugin (but do remember that it's experimental!).

Requirements

  • Git: Always. abcd shells out to the git binary and anchors every record it keeps to a repository.
  • A released platform: macOS or Linux, on amd64 or arm64. (Windows runs the Linux route inside WSL).
  • An agent harness: The plugin route and the verbs that hand their work to a model, and nothing else.

At this stage, abcd supports a single harness. The command-line app runs in any repository without one.

As a plugin

The easiest route to get started is to install abcd as a Claude Code plugin.

Run these two from a session within it. The first registers this repository as a plugin marketplace; the second installs abcd from it.

/plugin marketplace add intentdriven/abcd

Wait for the confirmation that the marketplace was added, then:

/plugin install abcd@abcd-marketplace

Restart the session afterwards so the hooks load, then check what you got:

/abcd:version

Later, /plugin update abcd pulls the marketplace's current state.

As a CLI

Outside a plugin session, abcd runs from a terminal in any repository, with no harness involved. A checksum-verified one-liner provisions it, no administrator rights required:

sh -c 'set -eu; unset HTTPS_PROXY https_proxy HTTP_PROXY http_proxy ALL_PROXY all_proxy CURL_HOME CURL_CA_BUNDLE SSL_CERT_FILE SSL_CERT_DIR; cd "$(mktemp -d)"; os=$(uname -s | tr "[:upper:]" "[:lower:]"); arch=$(uname -m); case "$arch" in x86_64) arch=amd64;; aarch64) arch=arm64;; esac; b="abcd-$os-$arch"; curl -q --proto =https --proto-redir =https -fsSLO "https://github.com/intentdriven/abcd/releases/latest/download/$b"; curl -q --proto =https --proto-redir =https -fsSLO "https://github.com/intentdriven/abcd/releases/latest/download/checksums.txt"; grep " $b$" checksums.txt | if command -v sha256sum >/dev/null; then sha256sum -c -; else shasum -a 256 -c -; fi; mkdir -p "$HOME/.local/bin"; install -m 0755 "$b" "$HOME/.local/bin/abcd"; "$HOME/.local/bin/abcd" version'

The install guide covers building from source and what to do when abcd isn't found afterwards.

First run

Setup

In a plugin session, inside a repository you own, /abcd:prepare-this-repo audits the tree and adopts the working conventions: The three-tier .abcd/ layout, an AGENTS.md router, and the commit gates. Bare /abcd (or abcd from a terminal) then shows where you are; the status board is read-only, so it is safe on any tree:

$ abcd
abcd — /path/to/your-repo
  git repo:   true
  record:     true
  work tiers: [development work work.local]

Recording your first issue

Issues are everything you wish to revisit: An idea, a user-facing intent, a bug, a thought. /abcd:capture "..." files a half-formed observation to the issue ledger so it survives the session. Revisit it with /abcd iss-N to report what that record is, where it lives, and its next move, such as graduating it into an intent, or close it with a note.

(The verb reference lists the rest.)

Citation

If you use abcd in your work, please cite it. The form below is rendered from CITATION.cff, which is the record GitHub's own Cite this repository button reads:

@software{reppel_abcd,
  author  = {Reppel, Alex},
  title   = {{abcd}: {Agent-Based} {Configuration} for {Development}},
  url     = {https://github.com/intentdriven/abcd},
  license = {MIT}
}

Resources

Directories

Path Synopsis
cmd
abcd command
Command abcd is the CLI front door to the abcd engine.
Command abcd is the CLI front door to the abcd engine.
abcd-gen-cli-ref command
Command abcd-gen-cli-ref writes the generated CLI reference page from the abcd command tree.
Command abcd-gen-cli-ref writes the generated CLI reference page from the abcd command tree.
abcd-gen-surface command
Command abcd-gen-surface writes the committed compatibility snapshot from the abcd command tree and the plugin manifests.
Command abcd-gen-surface writes the committed compatibility snapshot from the abcd command tree and the plugin manifests.
record-lint command
Command record-lint is the deterministic drift gate for the abcd design record.
Command record-lint is the deterministic drift gate for the abcd design record.
scaffold-sync command
Command scaffold-sync propagates the pinned action refs in the committed release workflows back into the scaffold templates they were rendered from, keeping TestSelfScaffoldParity satisfied after a dependency bump.
Command scaffold-sync propagates the pinned action refs in the committed release workflows back into the scaffold templates they were rendered from, keeping TestSelfScaffoldParity satisfied after a dependency bump.
internal
adapter/gitleaks
Package gitleaks is an OPT-IN external-scanner adapter for the transcript redaction path (iss-96).
Package gitleaks is an OPT-IN external-scanner adapter for the transcript redaction path (iss-96).
adapter/scanner
Package scanner is abcd's native secret + PII detector.
Package scanner is abcd's native secret + PII detector.
core
Package core is abcd's transport-agnostic engine.
Package core is abcd's transport-agnostic engine.
core/ahoy
Package ahoy is abcd's install/update engine for `abcd ahoy`.
Package ahoy is abcd's install/update engine for `abcd ahoy`.
core/banlist
Package banlist is abcd's two-layer banned-names store (itd-74, spc-20).
Package banlist is abcd's two-layer banned-names store (itd-74, spc-20).
core/capture
Package capture is abcd's transport-agnostic issue-ledger engine: the write side of a per-repo issue ledger that replaces the free-form .work/issues.md.
Package capture is abcd's transport-agnostic issue-ledger engine: the write side of a per-repo issue ledger that replaces the free-form .work/issues.md.
core/changelog
Package changelog is abcd's transport-agnostic release-derivation domain: the version and the changelog are facts derived from the records that shipped, not numbers and lines a human types (itd-73, spc-10).
Package changelog is abcd's transport-agnostic release-derivation domain: the version and the changelog are facts derived from the records that shipped, not numbers and lines a human types (itd-73, spc-10).
core/cite
Package cite is the live half of the citation gate: the on-demand refresh that fetches every cited URL and writes the committed baseline the zero-network docs lint then enforces offline.
Package cite is the live half of the citation gate: the on-demand refresh that fetches every cited URL and writes the committed baseline the zero-network docs lint then enforces offline.
core/frontmatter
Package frontmatter is abcd's shared markdown-frontmatter line scanner.
Package frontmatter is abcd's shared markdown-frontmatter line scanner.
core/glossary
Package glossary derives the brief glossary's own index from the term files.
Package glossary derives the brief glossary's own index from the term files.
core/grounds
Package grounds is the recorded-grounds vocabulary as DATA: the closed set of three values, the `<token>: <text>` grammar, the parser, the renderer, and the substance floor that refuses a degenerate text.
Package grounds is the recorded-grounds vocabulary as DATA: the closed set of three values, the `<token>: <text>` grammar, the parser, the renderer, and the substance floor that refuses a degenerate text.
core/guard
Package guard is abcd's transport-agnostic shell-hazard registry (itd-103, spc-16).
Package guard is abcd's transport-agnostic shell-hazard registry (itd-103, spc-16).
core/history
Package history is abcd's native session-transcript store: the write/read/ redact engine that populates ~/.abcd/history/<root-sha>/transcripts/ and retires the specstory shim (adr-29).
Package history is abcd's native session-transcript store: the write/read/ redact engine that populates ~/.abcd/history/<root-sha>/transcripts/ and retires the specstory shim (adr-29).
core/ideate
Package ideate is the deterministic frame around abcd's idea-admission protocol (itd-104, spc-18): the three-leg gauntlet an idea may be put through before it is allowed to become a record entry.
Package ideate is the deterministic frame around abcd's idea-admission protocol (itd-104, spc-18): the three-leg gauntlet an idea may be put through before it is allowed to become a record entry.
core/identity
Package identity checks that the git author identity a commit would use in a managed repo matches the identity pinned in .abcd/config/identity.json.
Package identity checks that the git author identity a commit would use in a managed repo matches the identity pinned in .abcd/config/identity.json.
core/intent
Package intent is abcd's transport-agnostic native intent store (intent lifecycle, itd-80).
Package intent is abcd's transport-agnostic native intent store (intent lifecycle, itd-80).
core/issueschema
Package issueschema is the issue record's frontmatter schema as DATA: the property allow-list, the required set, and the closed enum value sets that issue.schema.json declares, held where every gate that asks the question can read them.
Package issueschema is the issue record's frontmatter schema as DATA: the property allow-list, the required set, and the closed enum value sets that issue.schema.json declares, held where every gate that asks the question can read them.
core/launch
Package launch is abcd's transport-agnostic launch engine: it assembles the release bundle under a default-deny taxonomy, runs the native secret+PII scan, checks manifest lockstep, and previews newest-per-line retention — all as a dry-run that renders decisions without writing an artefact or touching the network.
Package launch is abcd's transport-agnostic launch engine: it assembles the release bundle under a default-deny taxonomy, runs the native secret+PII scan, checks manifest lockstep, and previews newest-per-line retention — all as a dry-run that renders decisions without writing an artefact or touching the network.
core/launch/scaffold
Package scaffold renders and writes the changelog-driven release machinery — release.yml, auto-release.yml, and the adr-37 runbook — into a managed repo that lacks it (itd-93, spc-14).
Package scaffold renders and writes the changelog-driven release machinery — release.yml, auto-release.yml, and the adr-37 runbook — into a managed repo that lacks it (itd-93, spc-14).
core/lifeboat
Package lifeboat holds the brief-to-lifeboat contract and, later, the source adapters that fill it.
Package lifeboat holds the brief-to-lifeboat contract and, later, the source adapters that fill it.
core/lint
Package lint is abcd's record-drift gate: it reads a JSON config and lints the markdown design record, returning findings.
Package lint is abcd's record-drift gate: it reads a JSON config and lints the markdown design record, returning findings.
core/mdrecord
Package mdrecord is the Markdown machinery a RECORD BODY is read and written through: which lines are live markdown and which are not, where a section starts and stops, what a top-level bullet is, and where a trailing run of link-reference definitions ends.
Package mdrecord is the Markdown machinery a RECORD BODY is read and written through: which lines are live markdown and which are not, where a section starts and stops, what a top-level bullet is, and where a trailing run of link-reference definitions ends.
core/memory
Package memory is abcd's transport-agnostic curated-knowledge substrate at .abcd/memory/ (itd-36 / adr-13).
Package memory is abcd's transport-agnostic curated-knowledge substrate at .abcd/memory/ (itd-36 / adr-13).
core/positioning
Package positioning holds a repository's canonical self-description — its title, tagline, and elevator pitch — and the deterministic check that every rendered surface still says it.
Package positioning holds a repository's canonical self-description — its title, tagline, and elevator pitch — and the deterministic check that every rendered surface still says it.
core/provenance
Package provenance is the record's disclosure vocabulary as DATA: where an item came from (`origin`) and how its text was produced (`production_mode`), plus the one parser that reads and renders them.
Package provenance is the record's disclosure vocabulary as DATA: where an item came from (`origin`) and how its text was produced (`production_mode`), plus the one parser that reads and renders them.
core/reading
Package reading assembles the input a cold reading is handed.
Package reading assembles the input a cold reading is handed.
core/record
Package record is the read side of `abcd <id>`: dispatch on a record id — iss-N, itd-N, spc-N, adr-N — and report what the record is, its links, and the concrete next move for its lifecycle state (spc-26).
Package record is the read side of `abcd <id>`: dispatch on a record id — iss-N, itd-N, spc-N, adr-N — and report what the record is, its links, and the concrete next move for its lifecycle state (spc-26).
core/recordid
Package recordid is abcd's canonical home for the record-id space: the native timestamp-numeric mint (mint.go), the read-side resolver (resolve.go), and the legacy max+1 allocator support this file keeps for the families that have not yet adopted the mint seam.
Package recordid is abcd's canonical home for the record-id space: the native timestamp-numeric mint (mint.go), the read-side resolver (resolve.go), and the legacy max+1 allocator support this file keeps for the families that have not yet adopted the mint seam.
core/release
Package release is the transport-agnostic composition of a release cut: the deterministic half of `abcd launch ship` and the whole of `abcd changelog`.
Package release is the transport-agnostic composition of a release cut: the deterministic half of `abcd launch ship` and the whole of `abcd changelog`.
core/repolint
Package audit is abcd's read-only repo-conformance engine: it evaluates a set of declarative rules against a repository and returns findings.
Package audit is abcd's read-only repo-conformance engine: it evaluates a set of declarative rules against a repository and returns findings.
core/rules
Package rules is abcd's transport-agnostic modular rules loader (itd-3).
Package rules is abcd's transport-agnostic modular rules loader (itd-3).
core/site
Package site is the home of the abcd site verb family (adr-47).
Package site is the home of the abcd site verb family (adr-47).
core/spec
Package spec is abcd's transport-agnostic native spec store (intent lifecycle, itd-64).
Package spec is abcd's transport-agnostic native spec store (intent lifecycle, itd-64).
core/surface
Package surface models abcd's public compatibility surface — the commands, flags, and manifest entries a consumer can bind to — as a transport-agnostic value that is snapshotted, committed, and diffed between releases (itd-73, spc-10).
Package surface models abcd's public compatibility surface — the commands, flags, and manifest entries a consumer can bind to — as a transport-agnostic value that is snapshotted, committed, and diffed between releases (itd-73, spc-10).
core/update
Package update implements the core of `abcd update` (itd-130 / spc-32): a user-invoked fetch/verify/swap for the PATH-installed binary.
Package update implements the core of `abcd update` (itd-130 / spc-32): a user-invoked fetch/verify/swap for the PATH-installed binary.
core/vintage
Package vintage is abcd's staleness comparator: it establishes whether the running binary is the one that should be running, by comparing the binary's own build vintage against a reference supplied by a provider.
Package vintage is abcd's staleness comparator: it establishes whether the running binary is the one that should be running, by comparing the binary's own build vintage against a reference supplied by a provider.
fsutil
Package fsutil holds the durable-write and path-safety primitives shared by the ~/.abcd and repo .abcd store writers.
Package fsutil holds the durable-write and path-safety primitives shared by the ~/.abcd and repo .abcd store writers.
gittest
Package gittest is the shared hermetic-git environment for tests that spawn git as a subprocess (iss-28).
Package gittest is the shared hermetic-git environment for tests that spawn git as a subprocess (iss-28).
gitutil
Package gitutil holds the shared, isolated git queries.
Package gitutil holds the shared, isolated git queries.
livery
Package livery holds the canonical pixel-grid definitions of abcd's visual identity — the duckling mascot, the signal-flag logo, and the lifeboat mark — and the palette they share (itd-133/spc-36).
Package livery holds the canonical pixel-grid definitions of abcd's visual identity — the duckling mascot, the signal-flag logo, and the lifeboat mark — and the palette they share (itd-133/spc-36).
livery/gen command
Command gen writes the committed SVG identity assets from the canonical livery grids.
Command gen writes the committed SVG identity assets from the canonical livery grids.
surface/cli
Package cli is abcd's default front door: a Cobra command tree that marshals internal/core results to the terminal (human text or, with --json, machine output).
Package cli is abcd's default front door: a Cobra command tree that marshals internal/core results to the terminal (human text or, with --json, machine output).
surface/cli/identitygen command
Command identitygen bakes the canonical identity block's title and tagline into a generated Go file (itd-112/spc-41).
Command identitygen bakes the canonical identity block's title and tagline into a generated Go file (itd-112/spc-41).
term
Package term holds the canonical terminal-capability primitives: the colour-mode ladder and the TTY check (adr-49, brief invariant 13).
Package term holds the canonical terminal-capability primitives: the colour-mode ladder and the TTY check (adr-49, brief invariant 13).
termsafe
Package termsafe holds the one canonical sanitiser for a string built from untrusted content (commit subjects, refs, file paths, repo prose, error text echoing a malformed file) before it is written to a terminal or a human report.
Package termsafe holds the one canonical sanitiser for a string built from untrusted content (commit subjects, refs, file paths, repo prose, error text echoing a malformed file) before it is written to a terminal or a human report.
testsecret
Package testsecret builds synthetic, secret-shaped strings at RUNTIME for tests that must exercise the secret scanner and its adapters.
Package testsecret builds synthetic, secret-shaped strings at RUNTIME for tests that must exercise the secret scanner and its adapters.
urlguard
Package urlguard is the canonical SSRF guard for every outbound fetch abcd makes.
Package urlguard is the canonical SSRF guard for every outbound fetch abcd makes.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL