-
Notifications
You must be signed in to change notification settings - Fork 1.7k
ENG-9447: add agents md instructions #6461
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.
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
Merged
adhami3310
merged 2 commits into
main
from
khaleel/eng-9447-add-agent-skills-and-agentmdclaudemd-installation
May 5, 2026
+91
−0
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| # AGENTS.md and CLAUDE.md | ||
|
|
||
| `AGENTS.md` and `CLAUDE.md` are project-level instruction files that AI coding assistants read when they enter your repository. They give the assistant durable, repository-specific context so it follows Reflex conventions instead of generic defaults. | ||
|
|
||
| - `AGENTS.md` is read by agents that follow the [AGENTS.md convention](https://agents.md), including Cursor, OpenCode, OpenAI Codex, and Pi. | ||
| - `CLAUDE.md` is read by [Claude Code](https://code.claude.com/docs/en/memory). Claude Code does not read `AGENTS.md` directly — see [Sharing With Claude Code](#sharing-with-claude-code) below. | ||
|
|
||
| A Reflex project should have at least one of these files at the project root, next to `rxconfig.py`. | ||
|
|
||
| ## Recommended Content | ||
|
|
||
| The [reflex-dev/agent-skills](https://github.com/reflex-dev/agent-skills) repository ships an `AGENTS.md` template that points assistants at the [Reflex Agent Skills](/docs/ai/integrations/skills/) for environment setup, documentation lookup, and process management. Use it as the starting point, then add anything specific to your codebase. | ||
|
|
||
| ```md alert info | ||
| # `AGENTS.md` references skills by name, so it works once the [Reflex Agent Skills](/docs/ai/integrations/skills/) are installed in the assistant. | ||
| ``` | ||
|
|
||
| ## Installation | ||
|
|
||
| Download the template into your project root, next to `rxconfig.py`: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/reflex-dev/agent-skills/main/AGENTS.md -o AGENTS.md | ||
| ``` | ||
|
|
||
| Or copy it manually from a local clone of the [reflex-dev/agent-skills](https://github.com/reflex-dev/agent-skills) repository. | ||
|
|
||
| ## Sharing With Claude Code | ||
|
|
||
| Claude Code reads `CLAUDE.md`, not `AGENTS.md`. To avoid duplicating content, create a `CLAUDE.md` that [imports](https://code.claude.com/docs/en/memory#import-additional-files) `AGENTS.md` using the `@` syntax: | ||
|
|
||
| ```md | ||
| @AGENTS.md | ||
|
|
||
| ## Claude Code | ||
|
|
||
| Add any Claude-specific instructions here. | ||
| ``` | ||
|
|
||
| Claude Code expands the `@AGENTS.md` import at session start, then appends anything you write below it. Both files stay in sync from a single source. | ||
|
|
||
| After installation, your project root looks like: | ||
|
|
||
| ```text | ||
| my_app/ | ||
| AGENTS.md | ||
| CLAUDE.md | ||
| rxconfig.py | ||
| my_app/ | ||
| my_app.py | ||
| ``` | ||
|
|
||
| ## Project-Specific Additions | ||
|
|
||
| The template covers Reflex-wide setup. Below it, add anything else the assistant should know about your project: | ||
|
|
||
| - Internal conventions and code style. | ||
| - Required lint, type-check, or test commands. | ||
| - Folder layout and where new code should go. | ||
| - Hosting or deployment notes. | ||
|
|
||
| Keep entries short and imperative — assistants follow concise, direct instructions more reliably than long paragraphs. | ||
|
|
||
| ## Keeping Files Updated | ||
|
|
||
| Reflex evolves quickly. If you used `curl` to download the template, re-run the same command to refresh it: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/reflex-dev/agent-skills/main/AGENTS.md -o AGENTS.md | ||
| ``` | ||
|
|
||
| If you cloned the [reflex-dev/agent-skills](https://github.com/reflex-dev/agent-skills) repository, pull the latest changes and copy the file back into your project: | ||
|
|
||
| ```bash | ||
| cd agent-skills | ||
| git pull | ||
| cp AGENTS.md /path/to/your/reflex-project/AGENTS.md | ||
| ``` | ||
|
|
||
| ## Combining With Skills and MCP | ||
|
|
||
| `AGENTS.md` and `CLAUDE.md` anchor the assistant in your project. Pair them with the other onboarding tools for deeper Reflex knowledge: | ||
|
|
||
| - [Reflex Agent Skills](/docs/ai/integrations/skills/) provide reusable workflows that the file references by name. | ||
| - [Reflex MCP](/docs/ai/integrations/mcp-overview/) provides structured documentation lookup at runtime. | ||
| - The [llms.txt index](/llms.txt) gives a broad map of the documentation in one file. | ||
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.