README
¶
backstop
An AI agent discipline framework. Backstop gates the pipeline before code is written — enforcing standards, verifying claims, and tracing lineage from intent to implementation.
Backstop is not a code quality scanner. It is a framework that assumes AI agents will fabricate, skip steps, and ignore conventions unless mechanically constrained.
Status
🚧 Under active development. Not yet ready for public use.
Structure
cmd/backstop/ CLI entrypoint
internal/ Go packages (validation, schema loading, runtime integration)
artifacts/ Primitive schemas, templates, and docs (versioned)
standards/ Self-contained enforcement packs (rules, checkers, testdata)
recipes/ Implementation patterns organized by language
scripts/ Repo-level gate scripts
docs/ User documentation
License
MIT
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var BaseEnginesFS embed.FS
BaseEnginesFS embeds the backstop-owned BASE ENGINE pack source (packs/base-engines) into the binary (ISSUE-027). It is declared at the module root — exactly like SchemaFS — because //go:embed cannot reference a directory above its own package. pkg/baseengines reads the embedded pack.yml from this FS and loads it through the normal pack.ParseManifest path, so the binary holds the four generic engine bindings as embedded DATA, never as baked Go literals.
var SchemaFS embed.FS
SchemaFS embeds all artifact schemas from the artifacts/ directory. Each CLI binary version constitutes a schema cohort — a locked set of schemas that the binary validates against.
Functions ¶
func ListSchemas ¶
ListSchemas walks the embedded SchemaFS and returns sorted paths for all schema files matching artifacts/*/v*/schema.json and artifacts/base/schema.json.
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
backstop
command
|
|
|
pkg
|
|
|
baseengines
Package baseengines loads the backstop-owned BASE ENGINE pack (the four generic engines: semgrep, ast-grep, sandbox, config-file) from an embedded pack.yml and projects it into an engine.Registry (ISSUE-027).
|
Package baseengines loads the backstop-owned BASE ENGINE pack (the four generic engines: semgrep, ast-grep, sandbox, config-file) from an embedded pack.yml and projects it into an engine.Registry (ISSUE-027). |
|
check
Package check implements the backstop code check validation engine.
|
Package check implements the backstop code check validation engine. |
|
config
Package config provides backstop.yml discovery, loading, and validation.
|
Package config provides backstop.yml discovery, loading, and validation. |
|
gate
Package gate implements the backstop gate command — the full reconciliation kill chain (ADR-0010).
|
Package gate implements the backstop gate command — the full reconciliation kill chain (ADR-0010). |
|
pack
Package pack provides scaffolding logic for rule packs and code packs.
|
Package pack provides scaffolding logic for rule packs and code packs. |
|
pack/distribution
Package distribution implements the pack distribution lifecycle: six commands (pack add, pack remove, pack install, pack update, pack upgrade, pack list) plus the backstop.lock format, SHA-256 content hashing, gate-time lock verification, tool_config provenance tracking, and .backstop/packs/ lifecycle management.
|
Package distribution implements the pack distribution lifecycle: six commands (pack add, pack remove, pack install, pack update, pack upgrade, pack list) plus the backstop.lock format, SHA-256 content hashing, gate-time lock verification, tool_config provenance tracking, and .backstop/packs/ lifecycle management. |
|
pack/engine
Package engine holds the shared EngineBinding table that the gate uses to dispatch pack-rule enforcement onto a declared execution engine.
|
Package engine holds the shared EngineBinding table that the gate uses to dispatch pack-rule enforcement onto a declared execution engine. |
|
recipe
Package recipe implements the recipe manifest and the generic applier that materializes a pack-declared recipe into a consumer project (SPEC-054).
|
Package recipe implements the recipe manifest and the generic applier that materializes a pack-declared recipe into a consumer project (SPEC-054). |
|
waiver
Package waiver implements the backstop waiver subsystem (SPEC-049): a backstop-native, engine-neutral, accountable "chosen not to fix" valve.
|
Package waiver implements the backstop waiver subsystem (SPEC-049): a backstop-native, engine-neutral, accountable "chosen not to fix" valve. |