docs: document ~/.claude/CLAUDE.md compatibility behavior #8268
+26
−10
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
Contributor
|
The following comment was made by an LLM, it may be inaccurate: No duplicate PRs found |
|
|
||
| ### Claude Code Compatibility | ||
|
|
||
| For users migrating from or using both Claude Code and OpenCode, OpenCode also reads `~/.claude/CLAUDE.md`. This allows you to share instructions between both tools. |
Collaborator
There was a problem hiding this comment.
Only reads it if u don't have AGENTS.md (note)
Contributor
Author
There was a problem hiding this comment.
Thanks! Updated to clarify these are fallbacks: d68ed5c
- Add CLAUDE.md as alternative to AGENTS.md in intro and Project sections - Add Claude Code Compatibility section with project/global rules and skills - Document all three OPENCODE_DISABLE_CLAUDE_CODE* environment variables - Update Precedence section to list all local file types and clarify behavior - Add cross-reference to Agent Skills docs for ~/.claude/skills/
033e17f to
2d52fdd
Compare
AGENTS.md takes precedence over CLAUDE.md at both project and global levels.
| ### Project | ||
|
|
||
| The ones we have seen above, where the `AGENTS.md` is placed in the project root, are project-specific rules. These only apply when you are working in this directory or its sub-directories. | ||
| Place an `AGENTS.md` (or `CLAUDE.md`) in your project root for project-specific rules. These only apply when you are working in this directory or its sub-directories. |
Collaborator
There was a problem hiding this comment.
NIT: prefer not to say or CLAUDE.md everywhere, stick to AGENTS.md everywhere and then just document that CLAUDE.md is picked up as a fallback like u have
| --- | ||
|
|
||
| You can provide custom instructions to opencode by creating an `AGENTS.md` file. This is similar to `CLAUDE.md` or Cursor's rules. It contains instructions that will be included in the LLM's context to customize its behavior for your specific project. | ||
| You can provide custom instructions to opencode by creating an `AGENTS.md` file (or `CLAUDE.md` for Claude Code compatibility). This is similar to Cursor's rules. It contains instructions that will be included in the LLM's context to customize its behavior for your specific project. |
Collaborator
There was a problem hiding this comment.
NIT: prefer not to say or CLAUDE.md everywhere, stick to AGENTS.md everywhere and then just document that CLAUDE.md is picked up as a fallback like u have
Contributor
Author
There was a problem hiding this comment.
Good call. Reverted intro and project sections to just reference AGENTS.md: 37356cc
Keep CLAUDE.md documentation in the Claude Code Compatibility section only.
Collaborator
|
thx! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR documents Claude Code compatibility features in the Rules documentation.
Changes
CLAUDE.mdas alternative toAGENTS.mdCLAUDE.mdsupportCLAUDE.md~/.claude/CLAUDE.md~/.claude/skills/OPENCODE_DISABLE_CLAUDE_CODE*environment variablesAGENTS.md,CLAUDE.md,CONTEXT.md)Closes #8265
Testing locally