convez.ai
Agente
samuelnp

centinela

samuelnp/centinela

Ver no GitHub
BomPluginScore · de 0 a 100

Enforces plan → code → tests → validate → docs discipline for AI coding agents (Claude Code, OpenCode).

Instalação

$npx convez-ai samuelnp/centinela

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
1
Forks
0
Acompanhando
0
Saúde
100%
Último commit
há 1 mês
Versão
v0.57.4
Issues abertas
4
Contribuidores
3

README

A tradução para o português deste README ainda está na fila.

Centinela

Plan → code → tests → validate → docs — enforced.

A harness-governance layer for AI coding agents. Centinela sits on top of Claude Code and OpenCode and makes your team's engineering discipline — plan → code → tests → validate → docs — enforced rather than requested. Every feature passes through guardrails, mechanical verification, and injected context automatically, so an agent's output looks like it came from a disciplined human team.

30-second tour

go install github.com/samuelnp/centinela@latest

centinela init                    # wire Claude/OpenCode hooks + scaffold docs/
centinela start my-feature        # required before any file write — opens "plan" step
# write docs/plans/my-feature.md + specs/my-feature.feature, then:
centinela complete my-feature     # advances plan → code (blocked if artifacts missing)
# … implement … advance through tests → validate → docs
centinela validate                # runs G1 file-size, i18n, your test/lint commands

If an agent tries to write source code while the workflow is in the plan step, the prewrite hook blocks the write and tells the agent what's missing.

Contents


Demo

Recorded with vhs. To regenerate: vhs assets/demo.tape.


Why Centinela

AI coding agents are fast but undisciplined. Left to their own devices they skip planning, write tests as an afterthought, and ship without validation. Centinela fixes this by:

  • Blocking file writes in the wrong workflow step via agent integrations
  • Requiring artifacts before a step can advance — no plan file means no code, no tests means no validate
  • Running gate checks automatically at the validate step (file size limits, i18n completeness, your test suite)
  • Injecting context into every agent session so the model always knows which feature is active and which step it is on

The result: every feature ships with a written plan, a Gherkin spec, three test layers, and a passing gate suite — regardless of whether a human or an AI agent wrote it.


Centinela & Harness Engineering

"Harness engineering" is the discipline of building the infrastructure around an LLM that turns it into a reliable agent — the verification loops, guardrails, context management, and environment control. Its guiding principle:

Treat every agent failure as an engineering problem to fix permanently, not a prompt to retry. Make correctness enforced, not requested.

Centinela is not an agent harness — Claude Code and OpenCode are. Centinela is the governance layer that sits on top of them and enforces how the harness is used across a team. It owns the parts of harness engineering that decide whether shipped code is trustworthy, and stays out of the parts the host agent already does well:

Harness subsystemOwned by CentinelaHow
Verification & guardrails★★★PreToolUse blocks out-of-step writes; validate gates (file size, i18n, your test suite); gatekeeper + production-readiness subagents
Context engineering★★UserPromptSubmit injects the active feature, step, and required evidence; the plan advisor reads roadmap deps and prior edge-case lessons
Environment control★★centinela init wires hooks and scaffolds the rules; migrate updates them incrementally to prevent known failure modes
Tool integration layer—delegated to Claude Code / OpenCode
Memory & state management★.workflow/*.json tracks per-feature step state
The agent loop itself—delegated to the host harness

The three principles of harness engineering map directly onto what Centinela already does:

  • Environment control → CLAUDE.md hard-rules, scaffolded docs, and migrate let you encode rules that prevent known failure modes — and keep them current.
  • Mechanical verification → required artifacts and gates make correctness checkable: no plan file means no code, no tests means no validate.
  • Graceful recovery → the merge-steward, missing-artifact recovery, and the plan advisor are designed for non-deterministic agent behavior.

In short: bring your own harness; Centinela makes sure it's used with discipline.


When not to use Centinela

Centinela trades flexibility for discipline. Skip it if any of these apply:

  • Throwaway scripts / one-off experiments. The 5-step ceremony is overhead you'll regret.
  • Solo prototyping in the first 48 hours of an idea. Plans, specs, and gate suites are useful after you've validated the idea — not while you're still figuring out what to build.
  • You don't use an AI coding agent. Centinela's strongest leverage is forcing structure on agent-generated code; humans typing every keystroke already have plenty of friction.
  • Your team has a different workflow you actually follow. Centinela is opinionated. If your team already ships clean specs, tests, and docs without enforcement, the hooks will feel like a tax.

Centinela is for production code you intend to maintain, where an AI agent is doing meaningful work and you want the agent's output to look like it came from a disciplined human team.


How Centinela Works

Bootstrap once, then every feature runs through five enforced steps inside its own git worktree, driven by specialist subagents and guarded by agent hooks, ending in a validated merge back to main.

flowchart TB
    subgraph BOOT["🏗️ Bootstrap · once per project"]
        direction LR
        INIT["centinela init<br/>wires Claude + OpenCode hooks<br/>scaffolds docs/ + centinela.toml"]
        PROJ["PROJECT.md<br/>archetype + stack"]
        ROAD["ROADMAP.md + .workflow/roadmap.json<br/>phased feature plan"]
        INIT --> PROJ --> ROAD
    end

    ROAD --> START["centinela start &lt;feature&gt;<br/>required before any file write"]
    START --> WT["git worktree add<br/>.worktrees/&lt;feature&gt; · branch &lt;feature&gt;<br/>state: .workflow/&lt;feature&gt;.json"]
    WT --> PLAN

    subgraph FLOW["🔒 Five-step workflow · enforced order · runs inside the feature worktree"]
        direction TB

        subgraph PLAN["1 · plan"]
            direction LR
            BT["big-thinker<br/>reasoning · opus-4-7"] --> FS["feature-specialist<br/>balanced · sonnet-4-6"]
            FS --> PLANART["docs/features/&lt;f&gt;.md<br/>docs/plans/&lt;f&gt;.md<br/>specs/&lt;f&gt;.feature"]
        end

        subgraph CODE["2 · code"]
            direction LR
            SE["senior-engineer<br/>reasoning · opus-4-7"] -. user-facing only .-> UX["ux-ui-specialist<br/>balanced · sonnet-4-6<br/>mobileFirst"]
            SE --> CODEART["implementation files"]
        end

        subgraph TESTS["3 · tests"]
            direction LR
            QA["qa-senior<br/>balanced · sonnet-4-6"] --> ECT["edge-case-tester<br/>fast · haiku-4-5"]
            ECT --> TESTART["tests/unit · tests/integration<br/>tests/acceptance<br/>.workflow/&lt;f&gt;-edge-cases.md"]
        end

        subgraph VAL["4 · validate"]
            direction LR
            VS["validation-specialist<br/>fast · haiku-4-5"] --> GATES["Gates<br/>G1 file-size · G11 i18n<br/>G2/G3/G5/G6/G7/G8 review<br/>+ centinela.toml commands"]
            GATES --> GK["gatekeeper report<br/>.workflow/&lt;f&gt;-gatekeeper.md"]
            GK --> PRD["production-readiness<br/>when gate enabled"]
        end

        subgraph DOCSTEP["5 · docs"]
            direction LR
            DS["documentation-specialist<br/>fast · haiku-4-5"] --> DOCART["docs/project-docs/index.html<br/>+ specialist .md / .json evidence"]
        end

        PLAN -->|complete| CODE -->|complete| TESTS -->|complete| VAL -->|complete| DOCSTEP
    end

    DOCSTEP --> MERGE["centinela merge &lt;feature&gt;"]
    MERGE --> CONF{"spec conflicts?"}
    CONF -- yes --> BLOCK["blocked —<br/>resolve conflicting specs"]
    CONF -- no --> MV{"merge + validate clean?"}
    MV -- yes --> DONE["merge into main<br/>remove .worktrees/&lt;feature&gt;"]
    MV -- no --> STEWARD["merge-steward<br/>reasoning · opus-4-7<br/>writes evidence →<br/>centinela merge --continue"]
    STEWARD --> MV

    subgraph HOOKS["⚙️ Agent hooks · enforce all of the above automatically"]
        direction LR
        PRE["PreToolUse<br/>block writes that don't<br/>match the current step"]
        POST["PostToolUse<br/>append status tag<br/>↳ feature · step · X/5"]
        UPS["UserPromptSubmit<br/>inject workflow context,<br/>plan-advisor questions,<br/>required evidence"]
    end
    HOOKS -. guards .-> FLOW

    classDef agent fill:#1f6feb22,stroke:#1f6feb,color:#adbac7;
    classDef artifact fill:#23863622,stroke:#238636,color:#adbac7;
    classDef gate fill:#9e6a0322,stroke:#d29922,color:#adbac7;
    classDef cmd fill:#8957e522,stroke:#8957e5,color:#adbac7;
    class BT,FS,SE,UX,QA,ECT,VS,DS,STEWARD agent;
    class PLANART,CODEART,TESTART,DOCART,GK artifact;
    class GATES,PRD gate;
    class INIT,START,WT,MERGE,DONE cmd;

Legend — 🟦 subagents (tier · model) · 🟩 required artifacts · 🟨 quality gates · 🟪 centinela commands. Model tiers shown are the built-in defaults; override any role via [orchestration.models] in centinela.toml. Each step only advances when centinela complete finds its required artifacts, and the hooks block any file write that doesn't belong to the current step.


Latest Features

  • Claude + OpenCode parity with shared setup prompts, workflow context, prewrite enforcement, postwrite status updates, setup-priority handling, and migration guidance.
  • Roadmap-first bootstrap with automatic PROJECT.md setup, ROADMAP.md creation, .workflow/roadmap.json, roadmap analysis, roadmap quality artifacts, clear missing-artifact recovery, and centinela roadmap validate.
  • Strict five-step delivery with enforced plan -> code -> tests -> validate -> docs order, required step artifacts, explicit step confirmation modes, and no workflow bypass for normal features.
  • Plan advisor mode that reads current feature artifacts plus roadmap dependencies, same-phase siblings, quality notes, and prior edge-case lessons before asking a small set of high-value planning questions.
  • Actionable specialist orchestration where big-thinker, feature-specialist, senior-engineer, qa-senior, documentation-specialist, and user-facing ux-ui-specialist evidence must point to real project outputs.
  • Stronger quality gates including executable acceptance-test enforcement, validation-command coverage for acceptance tests, default 100-line source files, and audited G1 exceptions for rare 130-line cases.
  • Managed migrations and generated docs through centinela migrate, centinela migrate docs, centinela migrate setup --agent claude|opencode|both, centinela docs validate, and centinela docs generate.
  • Cleaner workflow feedback with compact 🛡️👁️ CLI output, status tags, and prompt-driven command mapping for roadmap, start, continue, validate, and docs flows.
  • Claim verification with centinela verify <feature> that independently re-derives ground truth for every evidence claim (tests pass, coverage, non-stub outputs, edge-case mapping) and hard-blocks centinela complete at the validate step when any hard claim fails.
  • Cross-platform build gate (G-Build: Cross-Compile) that cross-compiles every configured release target during centinela validate and fails naming the broken GOOS/GOARCH pair, so platform build errors are caught locally before the release pipeline. Configured via [gates.build] with enabled, command, and a targets list of {goos, goarch} pairs; default disabled. A parity test keeps the target list in sync with the release matrix in .github/workflows/release.yml.

Install

Prerequisites: Go 1.21+

go install github.com/samuelnp/centinela@latest

Or download a pre-built binary from Releases.

For macOS/Linux, you can install the latest release binary directly:

curl -fsSL https://raw.githubusercontent.com/samuelnp/centinela/main/scripts/install.sh | sh

Verify:

centinela --help

macOS/Linux: go install places the binary in ~/go/bin. Ensure that directory is on your PATH:

export PATH="$HOME/go/bin:$PATH"  # add to ~/.zshrc or ~/.bashrc

Getting Started

1. Initialize a project

Run once in your project root:

centinela init

This creates:

File / DirectoryPurpose
CLAUDE.mdFramework rules — used by Claude, and by OpenCode via compatibility mode
PROJECT.md.templateFill in and rename to PROJECT.md
centinela.tomlConfigure validate commands and gate checks
docs/architecture/architecture reference documents + edge-case tester prompt
docs/plans/ specs/ tests/Required empty directories
.claude/settings.jsonClaude hooks wired automatically
opencode.json + .opencode/plugins/centinela.jsOpenCode integration wiring

Safe to re-run — existing files are never overwritten.

init is the bootstrap command. For ongoing upgrades to managed docs and setup artifacts, use migrate (preview by default, apply only with --apply).

Use --local to write Claude hooks to .claude/settings.local.json (useful for personal overrides without committing to the repo):

centinela init --local

Choose integration target explicitly when needed:

centinela init --agent claude
centinela init --agent opencode
centinela init --agent both   # default

2. Fill in PROJECT.md

Open your coding agent in the project — if PROJECT.md is missing, Centinela will prompt Claude or OpenCode to interview you and write it. Alternatively, rename PROJECT.md.template to PROJECT.md and complete every section manually. This file tells both you and the agent what the project is, which architecture pattern it follows, and where everything lives.

3. Configure centinela.toml

Add your stack's lint and test commands:

[validate]
commands = [
  "./scripts/check-coverage.sh",
]

Default coverage threshold is 95.0%. Override temporarily with:

MIN_COVERAGE=96.5 ./scripts/check-coverage.sh

Commands run natively via the OS. No shell scripts, no bash dependency — works on Windows, macOS, and Linux.

Example: Bootstrap a new project

Use this flow when starting from scratch.

centinela init

Then open your coding agent in the repo and follow setup prompts.

Expected sequence:

  1. If PROJECT.md is missing, centinela asks the agent to interview you and write it.
  2. Once PROJECT.md exists, centinela asks the agent to define your roadmap.
  3. The agent produces: ROADMAP.md (human-readable phased plan), .workflow/roadmap.json (machine-readable roadmap), .workflow/roadmap-analysis.md, .workflow/roadmap-analysis.json, .workflow/roadmap-quality.md, .workflow/roadmap-quality.json, and docs/features/<feature-slug>.md for the initial feature set.

If the agent misses one of those files, use docs/architecture/artifact-templates.md for the exact setup and per-feature workflow artifact shapes.

Verify roadmap status:

centinela roadmap
centinela roadmap validate

Start implementation from the first roadmap feature:

centinela start <first-feature-slug>

You can also use natural language instead of typing commands directly. The agent maps your intent to centinela commands under the hood.

Roadmap and status intent examples:

  • Check roadmap
  • Show roadmap progress
  • What feature should we build next?
  • What step are we currently in?

Start feature intent examples:

  • Implement first feature
  • Start the next roadmap feature
  • Begin feature: user-auth
  • Kick off checkout-flow

Continue feature intent examples:

  • Continue current feature
  • Resume work on billing-retries
  • Complete this step
  • Move to the next step for onboarding-wizard

4. Start building

centinela start my-feature

For standard product features, follow the same path every time:

  1. Write the plan artifacts in docs/plans/ and specs/.
  2. Run centinela complete <feature> to advance to code.
  3. Implement the change, then advance to tests.
  4. Add unit, integration, acceptance, and edge-case coverage, then advance to validate.
  5. Run centinela validate, resolve any gate failures, then advance to docs.
  6. Run centinela docs validate and centinela docs generate to publish the project-facing HTML output.

For a complete agent-collaboration example, see HOWTO.md. It walks through using Centinela to generate a small landing page MVP without skipping the required workflow steps.

Proper use checklist:

  • Start or resume a named feature before editing files: centinela start <feature> or centinela status <feature>.
  • Keep all feature work inside the current step; if a write is blocked, create the missing artifact or advance the workflow instead of forcing the edit.
  • Treat complete prompts as review gates. Approve advancement only after the current step artifacts exist and match the plan.
  • Put acceptance tests in tests/acceptance/ and ensure [validate].commands runs them.
  • Finish with centinela validate, centinela docs validate, and centinela docs generate --out docs/project-docs/index.html.

5. Migrate managed assets

Preview all managed upgrades (docs + setup):

centinela migrate

Preview docs-only upgrades:

centinela migrate docs

Apply full sync:

centinela migrate --apply

Scope setup migration to one integration when needed:

centinela migrate setup --agent claude
centinela migrate setup --agent opencode
centinela migrate setup --agent both --apply

Regenerate the HTML presentation explicitly when needed:

centinela docs validate
centinela docs generate --out docs/project-docs/index.html --title "Centinela Project Documentation"

The Standard Five-Step Workflow

Most delivery features follow the same five steps in order. Phase 0 bootstrap work can use a shorter roadmap-defined step order, but Centinela still enforces that order and its required artifacts.

plan → code → tests → validate → docs
StepWhat you produceWhat centinela checks before advancing
planPlan doc in docs/plans/ + Gherkin spec in specs/Both files exist on disk
codeImplementationNothing — architecture rules govern this step
testsUnit, integration, acceptance + edge-case analysisTest files exist + .workflow/<feature>-edge-cases.md exists
validateGatekeeper conflict reportAll gate checks pass + all centinela.toml commands exit 0
docsHuman-facing project documentation.workflow/<feature>-documentation-specialist.md + .workflow/<feature>-documentation-specialist.json + docs/project-docs/index.html

In strict orchestration mode, specialist evidence must be actionable:

  • big-thinker and feature-specialist outputs must point to real docs/plans/... or specs/... artifacts.
  • senior-engineer outputs must include at least one real non-evidence implementation file.
  • ux-ui-specialist is required during code only for features whose brief declares surface: user-facing; its outputs must include at least one real UI file, mobileFirst: true, and the required UX review tags.
  • qa-senior outputs must include at least one real test file and .workflow/<feature>-edge-cases.md.

UI path enforcement is configurable:

[orchestration]
ui_paths = ["src/ui", "src/components", "app/views", "web", "styles"]

Step confirmation prompts are configurable in centinela.toml:

[workflow]
step_confirmation_mode = "every_step" # every_step | after_plan | auto
plan_advisor_mode = "missing_info"   # missing_info | always | off
plan_question_limit = 4               # capped at 4 questions per round

Workflow commands

centinela start <feature>       # Start a feature (required before any file writes)
centinela status <feature>      # Show current step and artifact status
centinela status-all            # Show all active features
centinela complete <feature>    # Mark step done and advance
centinela verify <feature>      # Independently re-derive ground truth for evidence claims
centinela roadmap               # Show roadmap phase and feature progress
centinela roadmap validate      # Validate roadmap analysis and quality artifacts
centinela validate              # Run gate checks manually
centinela migrate               # Preview full managed docs + setup migration
centinela migrate docs          # Preview managed docs migration only
centinela migrate setup         # Preview setup migration only
centinela docs validate         # Validate inputs for project documentation report
centinela docs generate         # Generate HTML docs with Mermaid diagrams

How the Hooks Work

centinela init wires Claude and OpenCode integrations. Under the hood those integrations call centinela hook ... commands to keep workflow enforcement, setup guidance, and session context in sync.

PreToolUse — Write / Edit

Before Claude writes or edits any file, centinela checks whether that file belongs to the current workflow step. If you are in the plan step and Claude tries to write a source file, the hook blocks it and explains why.

PostToolUse — Write / Edit

After every file write, centinela appends a compact status tag to the session:

Prompt Advisor — Plan Step

During the plan step, Centinela also injects a plan-advisor directive. By default it runs in missing_info mode, inspects docs/features/<feature>.md, docs/plans/<feature>.md, and specs/<feature>.feature, then enriches that with roadmap dependencies, same-phase sibling features, roadmap quality notes, and related edge-case lessons. It asks up to 4 missing high-value questions through big-thinker and feature-specialist lenses. Dependency context is preferred before sibling context, and user-facing features receive UX/mobile-first questions only when those topics are still missing.

↳ my-feature · code · 2/5

For Claude, Centinela can also render a compact status line so the current feature, step, and risk state stay visible outside the main response flow.

UserPromptSubmit

Multiple hooks run at the start of every message:

Project setup — if PROJECT.md is missing but PROJECT.md.template exists, centinela injects a prompt instructing the agent to interview the user and write PROJECT.md. Once PROJECT.md exists, Centinela can also require ROADMAP.md, roadmap analysis artifacts, roadmap quality artifacts, and production-readiness setup before feature work continues.

Managed migration — if managed docs or setup assets are outdated, centinela injects migration guidance and instructs the assistant to ask for approval before running apply commands.

Workflow context — injects a context block showing all active workflows and their current step, so Claude always has accurate state without reading any files.

Autostart + orchestration — when no workflow is active, Centinela can auto-start a feature from prompt intent. In strict orchestration mode it also tells the agent which specialist evidence files are required before centinela complete can advance the step.


Gate Checks

Gates are quality checks that must pass before a feature can ship. They run during centinela validate and automatically when completing the validate step.

Claim verification at the validate step

When centinela complete <feature> advances through the validate step it runs claim verification as a HARD block. Any failing claim — tests that do not actually pass, a coverage figure that exceeds the measured result beyond tolerance, or an output file that contains only an empty stub — stops completion and names the failing claim. Edge-case mapping failures emit a warning and surface in the output but do not hard-block on their own.

Run verification at any time with:

centinela verify <feature>

See the [verify] configuration block to adjust the timeout and coverage tolerance.

Built-in gates

GateRuleConfig
G1: File SizeDefault max 100 lines, with optional justified exceptions up to 130 lines[gates] file_size = true
G2: Layer BoundariesParses the Go import graph and fails on any import that violates your declared per-layer allow-matrix[gates.import_graph]
G11: i18nAll locale files have identical keys (no missing translations)[gates] i18n = true
G-Build: Cross-CompileCross-compiles every configured release target and fails naming the broken GOOS/GOARCH[gates] build = true

Cross-compile build gate

The G-Build: Cross-Compile gate runs each target in your [gates.build] targets list through the configured build command, sets GOOS, GOARCH, and CGO_ENABLED=0 automatically, and collects any failures. If any target fails, the gate reports Fail with a detail line per broken platform. Default is disabled.

[gates]
build = true

[gates.build]
command = "go build ./cmd/myapp"   # executed once per target; no shell expansion
targets = [
  { goos = "linux",   goarch = "amd64" },
  { goos = "linux",   goarch = "arm64" },
  { goos = "darwin",  goarch = "amd64" },
  { goos = "darwin",  goarch = "arm64" },
  { goos = "windows", goarch = "amd64" },
  { goos = "windows", goarch = "arm64" },
]

The command is argv-parsed (strings.Fields) and executed directly — never via a shell — so spaces in paths are safe and shell injection is not possible.

Layer-boundary (import-graph) gate

The G2: Layer Boundaries gate turns your architecture's layer rules into a mechanical check. It parses the Go import graph with go list -json (no extra dependency) and fails centinela validate when a package imports another package its layer is not allowed to import — for example a leaf config package reaching up into ui. You declare the matrix in centinela.toml: each layer has a name, path globs, and the list of layers it may import. Standard-library and third-party imports are ignored; a package that matches no configured layer produces a non-failing warning (so the matrix can be adopted incrementally) rather than passing silently. Default is disabled.

[gates.import_graph]
enabled = true
# module = "github.com/you/yourapp"   # optional; defaults to `go list -m`

[[gates.import_graph.layers]]
name  = "leaf"
paths = ["internal/config/**"]
allow = []                            # a leaf layer imports no other layer

[[gates.import_graph.layers]]
name  = "domain"
paths = ["internal/service/**"]
allow = ["leaf"]

[[gates.import_graph.layers]]
name  = "cmd"
paths = ["cmd/**"]
allow = ["domain", "leaf"]

A forbidden edge is reported as internal/config -> internal/ui (leaf may not import domain). Same-layer and self imports are always allowed.

A companion parity test (TestBuildMatrixParity) keeps [gates.build] targets in centinela.toml in sync with the release matrix in .github/workflows/release.yml. If either list drifts, go test ./... fails during centinela validate and names the missing targets.

G11 supports two formats natively:

# JSON locale files (next-intl, i18next, vue-i18n)
[i18n]
format  = "json"
dir     = "src/i18n/messages"
locales = ["en", "es", "fr"]

# GNU gettext .po files (Godot, Qt)
[i18n]
format  = "gettext"
dir     = "i18n"
locales = ["en", "es"]

For other formats (Unity CSV, Android XML, iOS .lproj), set format = "none" and add a custom command to [validate] commands.

Diff-aware mode

centinela validate can scope the file-walking gates (G1, G11) to files changed on the current branch, so the report flags only violations introduced by your work — not pre-existing ones in untouched files.

Default behavior (diff_mode = "auto"):

  • Locally (no CI env var): diff-aware. Header reads Built-in Gates (diff-aware: N files changed since main).
  • In CI (CI=true or CI=1): full scan. Header reads Built-in Gates (full scan). The ship gate stays strict.

Configure via centinela.toml:

[validate]
diff_mode = "auto"   # "auto" | "always" | "off"
diff_base = "main"   # any git ref (e.g. "master", "develop")

Override per invocation:

centinela validate --changed   # force diff-aware
centinela validate --full      # force full scan

Flags beat config, config beats CI detection. --changed and --full are mutually exclusive.

How the change set is built:

  • git diff --name-only --diff-filter=ACMR $(git merge-base HEAD <diff_base>) for tracked changes.
  • git ls-files --others --exclude-standard for untracked files (new code is gated before git add).
  • Renamed files appear via the new path. Deleted files are naturally skipped.

G1 walks only files in the change set. G11 runs the full key-completeness comparison when any locale file is in the change set, and short-circuits with a "no locale changes" Pass otherwise (partial-locale comparison is not meaningful).

User [validate] commands are not scoped by the diff — they always run in full.

Degrade paths: non-git directory, missing diff base, shallow clone, or any git failure prints a one-line notice: and falls back to full scan.

CI systems that don't set CI=true (uncommon — GitHub Actions, GitLab CI, CircleCI, Travis, Buildkite, and Drone all do) need either diff_mode = "off" or --full in the pipeline.

Manual gates (code review)

GateRule
G2: Layer DependenciesNo imports cross forbidden layer boundaries (archetype-specific)
G3: Type SafetyStrictest static analysis — no any, no untyped variables
G5: Spec FirstEvery feature has a .feature file before implementation starts
G6: Plan FirstEvery feature has a plan document before implementation starts
G7: No Business Logic in Outer LayerUI components and adapters contain no domain logic
G8: Single ResponsibilityEach file exports one thing and does one thing

Full gate documentation: docs/architecture/gatekeepers.md


Architecture Archetypes

Centinela supports five architecture patterns. You choose one when filling in PROJECT.md. The choice determines which layer rules, forbidden imports, and test expectations apply.

ArchetypeBest for
HexagonalMultiple external integrations (APIs, databases), domain logic that must be testable without infrastructure
Rails-nativeFramework-opinionated stacks (Rails, Django, Laravel) — follow the framework conventions
N-TierClassic layered apps: HTTP handlers → services → repositories
ECSGames — entities, components, and systems
ModularMonorepo-style projects with clear public API contracts between modules

Each archetype has its own layer dependency rules (G2), outer-layer definition (G7), and test coverage expectations (G4).

See docs/architecture/architecture-overview.md for the full comparison.


centinela.toml Reference

# Commands centinela runs during the validate step.
# Executed natively — no shell scripts required.
[validate]
commands = [
  # TypeScript:  "npx tsc --noEmit", "npx vitest run", "npx cucumber-js"
  # Python:      "mypy --strict src", "pytest", "behave"
  # Go:          "go vet ./...", "go test ./..."      # includes tests/acceptance
  # Ruby:        "bundle exec rubocop", "bundle exec rspec", "bundle exec cucumber"
  # Rust:        "cargo check", "cargo test"          # add acceptance runner if separate
]
diff_mode = "auto"   # "auto" (default) | "always" | "off" — see Diff-aware mode above
diff_base = "main"   # any git ref; merge-base with this branch defines the change set

# Built-in gate toggles
[gates]
file_size = true   # G1: fail if any source file exceeds 100 lines by default
i18n      = false  # G11: check translation key completeness
build     = false  # G-Build: cross-compile every release target (default off)

# Cross-compile build gate (required when gates.build = true)
[gates.build]
command = "go build ./cmd/myapp"   # build command; run once per target with GOOS/GOARCH/CGO_ENABLED=0 set
targets = [
  { goos = "linux",   goarch = "amd64" },
  { goos = "linux",   goarch = "arm64" },
  { goos = "darwin",  goarch = "amd64" },
  { goos = "darwin",  goarch = "arm64" },
  { goos = "windows", goarch = "amd64" },
  { goos = "windows", goarch = "arm64" },
]

# Optional: explicit justified G1 exceptions for rare cases
[[gates.file_size_exceptions]]
path = "internal/config/generated_map.go"
kind = "configuration"  # "configuration" or "domain_atomic"
reason = "Large static map is clearer as one unit"
max_lines = 130

# i18n config (required when gates.i18n = true)
[i18n]
format  = "json"              # "json" | "gettext" | "none"
dir     = "src/i18n/messages"
locales = ["en"]

# Claim verification — controls centinela verify and the complete-gate check
[verify]
verify_timeout     = 60    # seconds before a test command is killed during verification (default: 60)
coverage_tolerance = 0.001 # maximum allowed gap between a claimed and measured coverage figure (default: 0.001 = 0.1%)

Generated Project Structure

After centinela init and filling in PROJECT.md:

your-project/
  CLAUDE.md                      ← framework rules (auto-loaded by Claude)
  PROJECT.md                     ← project definition
  centinela.toml                 ← validate commands + gate config
  .claude/
    settings.json                ← centinela hooks
  .workflow/
    <feature>.json               ← workflow state per feature
    <feature>-gatekeeper.md      ← gatekeeper conflict report
  docs/
    architecture/                ← 16 reference documents
    plans/                       ← one plan doc per feature
  specs/
    <feature>.feature            ← Gherkin acceptance criteria
  tests/
    unit/
    integration/
    acceptance/
      <feature>.steps.*          ← executable Gherkin step definitions

Included Architecture Documentation

centinela init copies 16 reference documents into docs/architecture/:

DocumentContents
architecture-overview.mdAll five archetypes compared — when to use each
artifact-templates.mdExact setup and per-feature workflow artifact templates
hexagonal.mdPorts-and-adapters layers, dependency rules, forbidden imports
rails-native.mdMVC conventions, what belongs in models vs services vs views
n-tier.mdController → Service → Repository layer rules
ecs.mdEntity-Component-System patterns for games
modular.mdModule boundaries and public API contracts
dependency-injection.mdDI container patterns across archetypes
testing-strategy.mdUnit, integration, and acceptance test structure for all archetypes
gatekeepers.mdFull gate reference (G1–G11) with per-archetype rules
gatekeeper-prompt.mdPrompt for the Gatekeeper AI subagent conflict review
documentation-generator-prompt.mdLLM-first prompt template for polished docs generation with CLI fallback
workflow-enforcement.mdHow the three enforcement layers work
i18n-strategy.mdTranslation key conventions by format
example-feature-walkthrough.mdEnd-to-end example of the five-step workflow
new-project-guide.mdStep-by-step setup for new projects

Build from Source

git clone https://github.com/samuelnp/centinela
cd centinela
go build -o centinela ./cmd/centinela/

Cross-compile for other platforms:

GOOS=linux   GOARCH=amd64 go build -o centinela-linux-amd64  ./cmd/centinela/
GOOS=darwin  GOARCH=arm64 go build -o centinela-darwin-arm64 ./cmd/centinela/
GOOS=windows GOARCH=amd64 go build -o centinela-windows.exe  ./cmd/centinela/

Contributing

Centinela uses its own workflow to develop itself.

centinela start <feature-name>
# plan → code → tests → validate → docs
centinela complete <feature-name>

Conventional commits: feat:, fix:, refactor:, test:, docs:, chore:. One feature per branch. Never push failing tests.


License

MIT

Ver o original no GitHub

Bom para

Relacionados