מחולל AGENTS.md

תארו את הפרויקט וקבלו AGENTS.md ש-Codex, ‏Cursor, ‏GitHub Copilot, ‏Claude Code וסוכני קוד אחרים קוראים, ואם תרצו גם CLAUDE.md שמייבא אותו. כל סעיף נבנה ממה שכתבתם, ושום דבר לא יוצא מהדפדפן.

התחילו מדוגמה
פרויקט
רק הכותרות והשורות הקבועות. הטקסט שלכם נכתב כפי שהקלדתם אותו.
סטאק
מופרדות בפסיקים, למשל TypeScript, Python 3.12.
מופרדים בפסיקים.
הקובץ יגיד להתקין תלויות רק איתו.
פקודותהשורה המדויקת שסוכן יכול להריץ משורש ה-repository. פקודות ריקות לא נכתבות.
מבנה וכללים
תיקייה אחת בכל שורה, בצורה path: מה יש בה.
כלל אחד בכל שורה. כתבו את מה שהסוכן לא יראה בקוד.
נתיב אחד בכל שורה, עם סיבה אופציונלית: path: למה.
Git וסודות
כלל אחד בכל שורה: branches, הודעות commit, בדיקות לפני Pull Request.
מופרדים בפסיקים או ברווחים, למשל ‎.env, ‏‎.env.local. לעולם לא התוכן שלהם.
כלל אחד בכל שורה, למשל לאן נכנס משתנה חדש.
‏Claude Code קורא AGENTS.md רק כשאין CLAUDE.md. עם הקובץ הזה, שורה אחת (‎@AGENTS.md) טוענת אותו, ואתם שומרים קובץ אחד לכל הסוכנים.

אין עדיין מה לכתוב. כל סעיף נבנה רק ממה שמילאתם, ולכן טופס ריק לא מייצר קובץ. מלאו שדה או התחילו מדוגמה.

מה הכלי עושה

הכלי כותב את קובץ ההנחיות שסוכן קוד קורא לפני שהוא עובד ב-repository שלכם: ‏AGENTS.md, הפורמט הפתוח שרוב הסוכנים קוראים, ואם תרצו גם CLAUDE.md שטוען אותו עבור Claude Code. אתם נותנים את העובדות שהסוכן לא יכול לנחש מהקוד: אילו פקודות להריץ, התיקיות, הכללים, מה אסור לו לגעת בו ואיך שומרים סודות.

איך זה עובד

  1. מלאו רק את מה שנכון לפרויקט שלכם, או התחילו מאחת הדוגמאות ושנו אותה.
  2. המנוע @anaroq/agents כותב את הקובץ בדפדפן תוך כדי הקלדה. שדה שנשאר ריק לא כותב סעיף: אין כותרות בלי תוכן ואין עצות כלליות.
  3. ערכים שנראים כמו סודות (מפתחות, tokens, סיסמאות בתוך URL) ממוסכים לפני שהם נכתבים.
  4. העתיקו או הורידו את AGENTS.md (ואת CLAUDE.md) לשורש ה-repository ועשו לו commit.

איזה סוכן קורא איזה קובץ

כפי שהתיעוד של כל כלי מציין, נכון לבדיקה ב-. הכלים משנים את הכללים האלה, אז בדקו את המקור לפני שאתם מסתמכים עליהם.

איזה סוכן קורא איזה קובץ
כליקבציםאיך הוא קורא אותםמקור
AGENTS.mdAGENTS.mdפורמט פתוח: קובץ Markdown רגיל בשורש ה-repository, ועוד קבצים בתיקיות המשנה של monorepo. הקובץ הקרוב ביותר לקובץ שנערך גובר, והבקשה שלכם בצ'אט גוברת עליו.תיעוד
OpenAI CodexAGENTS.md, AGENTS.override.mdקורא AGENTS.override.md או AGENTS.md בתיקייה ‎~/.codex, ואז קובץ אחד לכל תיקייה משורש הפרויקט ועד תיקיית העבודה, כשהקרוב ביותר אחרון. עוצר ב-32 KiB בסך הכול כברירת מחדל (project_doc_max_bytes).תיעוד
Claude CodeCLAUDE.md, AGENTS.mdקורא CLAUDE.md. קורא AGENTS.md במקומו כשאין בפרויקט CLAUDE.md (מגרסה v2.1.277 של Claude Code). כששניהם קיימים, CLAUDE.md עם השורה ‎@AGENTS.md מייבא אותו.תיעוד
GitHub Copilot.github/copilot-instructions.md, AGENTS.md, CLAUDE.md, GEMINI.mdקורא את ‎.github/copilot-instructions.md וקובצי AGENTS.md בכל מקום ב-repository, כשהקרוב ביותר קודם; קובץ CLAUDE.md או GEMINI.md יחיד בשורש עובד במקום AGENTS.md.תיעוד
CursorAGENTS.md, .cursor/rules/*.mdcקורא AGENTS.md בשורש ובתיקיות משנה, יחד עם תיקיות האב, כחלופה פשוטה ל-‎.cursor/rules (קובצי ‎.mdc עם metadata).תיעוד
Gemini CLIGEMINI.mdקורא GEMINI.md כברירת מחדל. כדי שיקרא AGENTS.md, הוסיפו אותו ל-context.fileName בקובץ settings.json.תיעוד

מה גורם לקובץ לעבוד

  • פקודות שסוכן יכול להריץ כמו שהן: שורות ה-install, ה-build, הבדיקות וה-lint המדויקות, כדי שיוכל לבדוק את העבודה של עצמו.
  • מה שהוא לא רואה בקוד: הנתיבים שאסור לגעת בהם ולמה, כללי ה-branch וה-commit, איפה נמצאים הסודות.
  • כללים קצרים וקונקרטיים: "הריצו pnpm test לפני commit", לא "בדקו את השינויים".
  • לשמור אותו עדכני: פקודה ישנה שולחת את הסוכן לכיוון הלא נכון, אז שנו את הקובץ יחד עם הפקודה.

מה מזיק: עומס הקשר

  • אורך. הקובץ נקרא בכל session ותופס מקום שהיה הולך לקוד שלכם: ‏Claude Code מבקש פחות מ-200 שורות, ‏Codex חותך ב-32 KiB כברירת מחדל.
  • עצות כלליות שהסוכן ממילא עושה ("כתבו קוד נקי"), README שהועתק פנימה, או שורה לכל תיקייה.
  • כללים שסותרים זה את זה, או CLAUDE.md ו-AGENTS.md שמתרחקים זה מזה: הסוכן עלול לפעול לפי כל אחד מהם.
  • סודות, tokens או כתובות פנימיות: הקובץ נכנס ל-commit ונקרא על ידי כל כלי שתחברו.

דוגמה

דוגמת ה-monorepo של Node.js, כפי שהמנוע כתב אותה כשהעמוד נבנה. היא מבקשת גם CLAUDE.md, שהשורה היחידה בו היא ‎@AGENTS.md.

AGENTS.md
# acme-web

A pnpm monorepo: the Next.js site in apps/web and shared TypeScript packages.

## Stack

- Languages: TypeScript
- Frameworks: Next.js, React, Vitest, Playwright
- Package manager: `pnpm`. Install and add dependencies with it only.

## Commands

- Install dependencies: `pnpm install --frozen-lockfile`
- Run locally: `pnpm --filter web dev`
- Build: `pnpm build`
- Test: `pnpm test`
- Lint: `pnpm lint`
- Type-check: `pnpm typecheck`

## Project structure

- `apps/web`: The Next.js site (App Router).
- `packages/ui`: Shared React components.
- `packages/config`: Shared ESLint and TypeScript settings.

## Code rules

- TypeScript strict mode; no `any` without a comment that says why.
- A package never imports from apps/.
- Add or update a test for every change in behavior.

## Do not change

Do not edit these paths unless the task explicitly asks you to:

- `pnpm-lock.yaml`: change it only through pnpm install.
- `packages/ui/src/tokens.css`: the approved design tokens.

## Git and pull requests

- Branch from main; never push to main directly.
- Conventional Commits: feat(web): …, fix(ui): ….
- Run pnpm lint, pnpm typecheck and pnpm test before you open a pull request.

## Secrets

- Never read, print or commit these files: `.env`, `.env.local`.
- New variables go into .env.example with an empty value.
CLAUDE.md
@AGENTS.md

מגבלות

  • הכלי לא קורא את ה-repository שלכם: כל ערך הוא מה שכתבתם. הריצו את הפקודות בטרמינל לפני שאתם עושים commit לקובץ.
  • קובץ הנחיות הוא הקשר, לא מערכת הרשאות: סוכן עדיין יכול להריץ כל פקודה שההגדרות שלו מאפשרות. הגבילו מה מותר לו להריץ בהגדרות ההרשאות של הסוכן.
  • הכלי כותב AGENTS.md אחד לשורש ה-repository. קבצים מקוננים לתיקיות משנה, ‏‎.cursor/rules ו-‎.github/copilot-instructions.md לא נכתבים.
  • מיסוך הסודות מזהה רק פורמטים נפוצים. קראו את הקובץ לפני שאתם עושים לו commit.
  • טבלת הפורמטים נכונה לתאריך שלמעלה; הכלים משנים את הכללים שלהם.

מתודולוגיה: איך מחושבים המספרים

מקורות

  1. AGENTS.md: a simple, open format for guiding coding agents
  2. OpenAI Codex: Custom instructions with AGENTS.md
  3. Claude Code Docs: How Claude remembers your project
  4. GitHub Docs: Adding repository custom instructions for GitHub Copilot
  5. Cursor Docs: Rules
  6. Gemini CLI: Provide context with GEMINI.md files

עודכן

הצעד הבא

חבילת העברה לסוכן

כלי ציבורי חינמי של אנרוק, חברה שבונה תשתיות מחשוב. מה אנרוק בונה