docs: add CLAUDE.md agent guidelines for auth0-cli#1588
Open
sanchitmehtagit wants to merge 1 commit into
Open
Conversation
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
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.
Summary
Adds AI-agent guidelines for auth0-cli — a lean, guardrail-first
CLAUDE.mdplus a thinAGENTS.mdthat points to it, generated by thegenerating-claude-mdskill and validated against the repo.CLAUDE.md(128 lines) — persona, working principles, project overview/structure, three-tier Boundaries, Security, and one-line anchors intoreferences/.AGENTS.md— references@CLAUDE.mdso non-Claude tools (Codex CLI, Gemini CLI) share the same guidance.references/*.md— full detail offloaded on demand:commands,testing,code-style,git-workflow,pitfalls,docs-update.What detection surfaced (auth0-cli specific)
docs/— produced bygo run ./cmd/doc-gen, verified bymake check-docsin CI. Command/flag changes must be accompanied by amake docsregeneration (never hand-edited). Captured as an Always-Do boundary + the code-to-docs mapping.make test-integrationneeds realAUTH0_DOMAIN/CLIENT_ID/CLIENT_SECRET→ Ask First;make test-unitis the safe default.AUTH0_CLI_ANALYTICS=falseopt-out) + Sentry error reporting → documented in Security with the opt-out preserved.internal/keyring) → "never log tokens" boundary.godot(period-terminated comments) surfaced as the CI-enforced style guardrail.Validation
Filesystem validation pass: every cited path, every
maketarget, and everyreferences/*.mdpointer verified to exist in the repo — no invented tooling.Generated by the
generating-claude-mdskill.