Skip to content

Add local .agents.md #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adiasg wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −2
Open

Add local .agents.md #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f72450c
Add local .agentsmd
adiasg Sep 29, 2025
190fc9a
Change to .agents.md
adiasg Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions components/FAQSection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ export default function FAQ() {
},
{
question: "What if instructions conflict?",
answer:
"The closest AGENTS.md to the edited file wins; explicit user chat prompts override everything.",
answer:
".agents.md beats conflicting guidance in AGENTS.md. The closest instruction file to the edited file wins; explicit user chat prompts override everything.",
},
{
question: "Will the agent run testing commands found in AGENTS.md automatically?",
Expand Down
4 changes: 4 additions & 0 deletions components/HowToUseSection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ export default function HowToUseSection() {
title: "Add extra instructions",
body: "Commit messages or pull request guidelines, security gotchas, large datasets, deployment steps: anything you’d tell a new teammate belongs here too.",
},
{
title: "Add local instructions with .agents.md",
body: "Keep personal rules in a sibling .agents.md file. Agents read both files, give priority to .agents.md, and apply the same \"closest file wins\" hierarchy.",
},
{
title: "Large monorepo? Use nested AGENTS.md files for subprojects",
body: (
Expand Down