agentleFS
Sign inStart free
svyatovsvyatov/handrail/CLAUDE.md

handrail

CLAUDE.md2 starsChanged 3 months agoMITView on GitHub

docs/spec.md is the behavioural source of truth, about 100 KB, one bullet per line and up to 4 KB each, so a 30-line range runs 15-40 KB. Each bullet or table row opens with its field or bold term: find it with grep -n '^[-|] [*]*<term>' docs/spec.md and read those lines alone. GLOSSARY.md` defines the vocabulary. CI calls these same tasks, so a local pass means what a green check means. - One third-party runtime dependency, mvdan.cc/sh/v3 (ADR 0011). depguard…

  • In this repository3 other files it gives its agents.

The file

Create a free account to mount
Files
CLAUDE.md

handrail

docs/spec.md is the behavioural source of truth, about 100 KB, one bullet per line and up to 4 KB each, so a 30-line range runs 15-40 KB. Each bullet or table row opens with its field or bold term: find it with grep -n '^[-|] [`*]*<term>' docs/spec.md and read those lines alone. GLOSSARY.md defines the vocabulary.

Commands

mise run test           # go test -race -shuffle=on ./...
mise run cover          # the same run with coverage, fails under 95%
mise run lint           # go mod tidy -diff and verify, go fix -diff, golangci-lint run and fmt --diff, then scripts/check-{doc-paths,flag-sources,dashes}.sh
mise run vuln           # govulncheck through go run, so it stays out of go.mod
mise run fuzz           # 30s (FUZZTIME) per parser fuzz target; a crash input lands in testdata/fuzz/, commit it
mise run build          # the release build
mise run release-check  # goreleaser check, the version pin, and the CHANGELOG section the release body is cut from

CI calls these same tasks, so a local pass means what a green check means.

Two constraints the build enforces

  • One third-party runtime dependency, mvdan.cc/sh/v3 (ADR 0011). depguard allows only the stdlib, this module and mvdan.cc/sh/v3/syntax outside _test.go, and denies os/exec; github.com/rogpeppe/go-internal is the sole test-only one.
  • os.Exit only in main.go, so run() returns an exit code and stays testable. forbidigo enforces it.

Tests

testscript over the compiled binary is the primary seam: a new case goes in testdata/script/*.txtar, not a new _test.go. Unit tests under internal/ are only for what a process boundary cannot produce. See docs/adr/0009-testing-strategy.md.

Agent skills

Issue tracker

Issues live as GitHub issues in svyatov/handrail, managed via the gh CLI. See docs/agents/issue-tracker.md.

Triage labels

The seven canonical roles (two category, five state), each label string equal to its name. See docs/agents/triage-labels.md.

Domain docs

Single-context: GLOSSARY.md + docs/adr/ at the repo root. See docs/agents/domain.md.

Semantic code navigation

Serena's LSP symbol tools, optional, needs gopls. See docs/agents/serena.md.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free