Repository navigation
feat(init): write a root AGENTS.md and CLAUDE.md - #264
Merged
Merged
Conversation
…roject The guide is built from the choices init made: each starter's directory and template (linking its own AGENTS.md, or its README on templates releases that ship none), how the auth server runs, the admin console, ports, how to start the stack, the first admin, and the rules for agents. CLAUDE.md is 'See @AGENTS.md' so Claude Code loads it. Written for local and managed scaffolds alike.
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.
Part of fells-code/seamless-auth-api#383
What
seamless initnow writes a rootAGENTS.mdand aCLAUDE.mdcontainingSee @AGENTS.md, next todocker-compose.ymlandseamless.config.json. Each starter directory already ships its own guide (fells-code/seamless-templates#115); the root one says how they fit together.The content comes from a pure function,
buildAgentsMdinsrc/generators/agents/agents.ts, built from the init choices:web/AGENTS.md,api/AGENTS.md,mobile/AGENTS.mdauth/source run by compose in local mode), or the managed instancedocker compose up, matching init's next steps; per-service commands for managed),seamless checkOWNER_EMAILlives for that auth modeBoth files are written unconditionally, like the compose file and
seamless.config.json, so--forceinto a non-empty directory replaces them the same way.Notes
AGENTS.mdyet. init checks for the file after copying and links the starter'sREADME.mdinstead, so the guide never links to nothing. Once templates are released andSEAMLESS_TEMPLATES_REFis bumped, the links switch toAGENTS.mdwith no further change.seamless adddoes not write project root files (its stack goes underseamless/), so it is unchanged.Testing
init my-app --local --yes --email=you@example.com </dev/null,--nextjs, and--mobile --auth=local(the latter two withSEAMLESS_TEMPLATES_REF=mainto see theAGENTS.mdlinks resolve).npm run build,npm test,npm run coverage,npm run check:types-current,npm run check:templates-pinall pass.