Skip to content

Added recursive AGENTS.md loading from child dirs #952

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

Jump to bottom
Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Added recursive AGENTS.md loading from child dirs #952

wants to merge 1 commit into from
+28 −2

Conversation

opencode-agent[bot]
Copy link
Contributor

Summary

I've successfully implemented recursive loading of AGENTS.md files from child folders. Here's what I did:

Changes Made:

  1. Added findDown function in /home/runner/work/opencode/opencode/packages/opencode/src/util/filesystem.ts:69-84:

    • Searches for files recursively in child directories using Bun's glob functionality
    • Includes a configurable maxDepth parameter (default: 3) to prevent performance issues
    • Uses the pattern **/${target} to find files at any depth

  2. Updated custom() function in /home/runner/work/opencode/opencode/packages/opencode/src/session/system.ts:53-84:

    • Now searches both upward (existing functionality) and downward (new functionality) for AGENTS.md files
    • Maintains backward compatibility with existing behavior
    • Limits search depth to 3 levels to avoid performance issues in large codebases

Key Features:

  • Backward Compatible: Existing upward search functionality remains unchanged
  • Performance Optimized: Limited to 3 levels of depth by default to prevent scanning entire large codebases
  • Comprehensive Coverage: Now finds AGENTS.md files in:
    • Current directory and parent directories (existing)
    • Child directories up to 3 levels deep (new)
    • Global config directory (existing)
    • Home directory .claude folder (existing)

Testing:

The implementation was tested and verified to correctly find AGENTS.md files at different directory levels, respecting the depth limit parameter.

This should resolve the issue where AGENTS.md files in child folders were being ignored, allowing for more granular project-specific instructions at different directory levels.

Closes #847

view session | view log

@opencode-agent @thdxr
Added recursive AGENTS.md loading from child dirs
f261046 
Co-authored-by: thdxr <thdxr@users.noreply.github.com>
@opencode-agent opencode-agent bot mentioned this pull request Jul 13, 2025
Closed
@adamdotdevin adamdotdevin requested a review from thdxr July 14, 2025 12:06
teamgroove pushed a commit to teamgroove/opencode that referenced this pull request Aug 3, 2025
Merge PR sst#952: Added recursive AGENTS.md loading from child dirs
6da11a2 
Merged from: sst#952
Author: @opencode-agent[bot]
Auto-merged by opencode-fork integration system
@hd-o
Copy link

hd-o commented Aug 26, 2025 •
edited
Loading

@adamdotdevin @thdxr @opencode-agent Great work on implementing this! I'd like to propose an alternative strategy that might offer better performance and more intuitive behavior by integrating directly with the ReadTool.

What if the ReadTool was updated to discover AGENTS.md files based on the directory tree being read?

if read path = "src/app/api/login/route.ts"

then tree = [
  "src",
  "src/app",
  "src/app/api",
  "src/app/login",
]

and search = for (const file of CUSTOM_FILES) [
  "src/{file}",
  "src/app/{file}",
  "src/app/api/{file}",
  "src/app/login/{file}",
]

1. Context Relevance:

  • Reduces context bloat, only loads rules relevant files
  • Avoids loading rules from unrelated project areas

2. Performance:

  • Lazy loading based on actual file access patterns
  • Leverages existing ReadTool caching mechanisms

3. Predictable Behavior:

  • Mirrors established patterns from TypeScript (tsconfig.json resolution) and Node.js (module resolution)
  • Developers already understand this "walk up the tree" mental model

Implementation Considerations

  • Could reuse existing filesystem utilities and caching
  • Maintains backward compatibility with current AGENTS.md patterns
  • Integrates naturally with ReadTool's existing file access workflow

Comparison with Current PR

The recursive implementation scans child directories proactively, which is excellent for comprehensive discovery. The tree-walking approach would be more reactive, discovering context only when relevant files are accessed.

Both approaches have merit - curious what you think about the trade-offs between comprehensive upfront loading vs. on-demand contextual loading?

This suggestion is inspired by how Codex CLI / Gemini CLI / Claude Code handle dynamic (AGENTS|CLAUDE).md discovery, and how established tools like TypeScript handle configuration file resolution

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thdxr thdxr Awaiting requested review from thdxr

Assignees

@thdxr thdxr

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AGENTS.md is being ignored.
2 participants
@hd-o @thdxr