Add AGENTS.md agent guidance - #1130
Open
tashian wants to merge 3 commits into
Open
Conversation
Document the package map, KMS backend registry and build tags (cgo and platform requirements per backend), TPM simulator testing, generated files, test/lint commands, and error and testing conventions for agents working in this repository. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JuSZFSx1cTEnqY55oquacV
AGENTS.md is the vendor-neutral file read by other coding agents. Claude Code does not read it natively, so CLAUDE.md becomes a one-line @AGENTS.md import that loads the same content. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JuSZFSx1cTEnqY55oquacV
tashian
enabled auto-merge (squash)
September 10, 2026 16:21
Per review: keep the repo root to AGENTS.md and put the Claude Code import stub under .claude/, importing @../AGENTS.md. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JuSZFSx1cTEnqY55oquacV
maraino
requested changes
Sep 11, 2026
maraino
left a comment
maraino
left a comment
Contributor
There was a problem hiding this comment.
We will need some changes after the tools PR
| library only, no binaries: X.509 and SSH certificate templating, key generation and | ||
| PEM/JWK handling, a pluggable KMS abstraction (software, AWS, GCP, Azure, PKCS #11, | ||
| YubiKey, ssh-agent, TPM, macOS Keychain, Windows CAPI), and TPM 2.0 attestation. | ||
| [`step`](https://github.com/smallstep/cli) and [`step-ca`](https://github.com/smallstep/certificates) |
Comment on lines
+13
to
+14
| exported APIs backward compatible. `go.mod` requires Go 1.26; CI tests `stable` and | ||
| `oldstable`. |
Contributor
There was a problem hiding this comment.
I suppose Claude knows, but should we clarify what stable and oldstable means?
| ## Commands | ||
|
|
||
| ```bash | ||
| make bootstrap # install golangci-lint, govulncheck, gotestsum into $(go env GOPATH)/bin |
| CGO_ENABLED=1 go test -tags tpmsimulator -run TestTPM_CreateAK ./tpm/ | ||
| ``` | ||
|
|
||
| `make test` and `make race` need `gotestsum` on `PATH`; `make lint` needs network |
Contributor
There was a problem hiding this comment.
We don't need gotestsum with go tools, we will need network.
| `internal/templates` FuncMap (sprig plus `toTime`, `formatTime`, etc.); the `fail` | ||
| function surfaces user-visible template errors. The `Default*Template` constants are | ||
| consumed verbatim by `step-ca` provisioners, so changing them is a behavior change. | ||
| - **Imports**: `goimports -local go.step.sm/crypto`; lint rules come from the shared |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Name of feature:
Adds a
AGENTS.mdwith agent guidance for this repository. It covers the package map, thekmsbackend registry and per-backend cgo/platform build tags, TPM simulator testing, generated files, the Makefile test/lint targets, and the error-wrapping and testing conventions in use.Supporting links/other PRs/issues:
.claude/CLAUDE.mdis a one-line@../AGENTS.mdimport so Claude Code loads the same file.Tracks EFF-787.
🤖 Generated with Claude Code
https://claude.ai/code/session_01JuSZFSx1cTEnqY55oquacV