AGENTS.md is a markdown file at the root of a repository that tells AI coding agents (Claude Code, Cursor, Windsurf, GitHub Copilot Workspaces, Aider) how to work with the codebase. Adopted by 60,000+ repos with Linux Foundation backing.

Is CLAUDE.md the same thing?

CLAUDE.md is the Claude-Code-specific variant. Claude Code reads AGENTS.md or CLAUDE.md at the start of every session. Toggle the target in this generator to flip between the two titles.

Which sections does it include?

Project overview, commands (install/dev/build/test/lint/format), code style, architecture, PR guidelines, security notes, do-not-touch, AI coding standards, and review checklist. Empty fields are skipped.

Can I edit the output?

Yes. The generated file is regular Markdown — copy, paste, and customize further in your editor.

مولد AGENTS.md

أنشئ ملف AGENTS.md متوافق مع المعايير لمستودعك. يقرأه Claude Code وCursor وAider وCopilot.

Target:

اسم المشروع نظرة عامة اللغات (مفصولة بفواصل) مدير الحزم

تثبيت تطوير بناء اختبار فحص الكود تنسيق

نمط الكود ملاحظات المعمارية إرشادات PR والالتزامات ملاحظات الأمان والأسرار قائمة المراجعة (واحدة لكل سطر) لا تعدّل (واحدة لكل سطر)

AGENTS.md 1807 حرف

# AGENTS.md

This file tells AI coding agents (Claude Code, Cursor, Copilot Workspaces, Aider, and similar) how to work with this repository. Read it before making any changes.

## Project: My Project

A TypeScript monorepo that ships a CLI and a web app. Managed with pnpm workspaces.

**Primary language(s):** TypeScript, JavaScript, Svelte

## Commands

This project uses **pnpm**.

- **Install:** `pnpm install`
- **Dev server:** `pnpm dev`
- **Build:** `pnpm build`
- **Test:** `pnpm test`
- **Lint:** `pnpm lint`
- **Format:** `pnpm format`

## Code Style

2-space indent. Double quotes for strings. No semicolons in Svelte files. Prefer `const` and arrow functions. Run the formatter before committing.

## Architecture

Monorepo layout:
- `apps/web` — SvelteKit app
- `apps/cli` — Node CLI
- `packages/core` — shared TypeScript logic (framework-free)
- `packages/ui` — shared UI components

## Pull Requests & Commits

Conventional commits (feat:, fix:, chore:). One logical change per PR. Title must start with the scope in brackets.

## Security & Secrets

Never commit `.env` files. All secrets live in the team vault. API keys rotate every 90 days.

## Do Not Touch

Agents must NEVER modify these files or folders:

- `pnpm-lock.yaml`
- `packages/core/src/generated/**`
- `.env*`
- `node_modules/**`

## AI Coding Standards

- Never add features, comments, or code the user did not ask for.
- Prefer editing existing files over creating new ones.
- Match the existing code style exactly.
- Run the test and lint commands above before declaring a task complete.
- If unsure about the approach, ask the user before writing code.

## Review Checklist

Before committing, verify:

- [ ] Tests pass
- [ ] Linter clean
- [ ] Type check passes
- [ ] No unused imports
- [ ] No console.log left behind

تضمين قسم معايير كتابة الكود بالذكاء الاصطناعي

ملخص — ماذا يفعل مولد AGENTS.md المجاني

ما هذه الأداة المجانية

مولّد AGENTS.md المجاني يبني ملف AGENTS.md (أو CLAUDE.md) متوافق مع المعايير لمستودعك — الملف الذي تقرأه وكلاء البرمجة بالذكاء الاصطناعي مثل Claude Code وCursor وWindsurf وGitHub Copilot Workspaces وAider في بداية كل جلسة. املأ اسم المشروع والنظرة العامة والأوامر ونمط الشيفرة وملاحظات البنية وإرشادات طلبات السحب وقواعد الأمان وقائمة عدم اللمس.

الخصوصية: هذه الأداة تعمل بالكامل في متصفحك. لا يتم رفع أو تسجيل أو تخزين نصك أبدًا. أغلق التبويب وسيختفي كل شيء. تحقق في DevTools → Network: لا يتم إرسال أي طلبات.

لماذا هي مجانية (وكيف نبقيها مجانية)

كل مستودع يحتاج ملف AGENTS.md الآن، وملف جيد هو الفرق بين وكيل يساعد ووكيل يكسر الأشياء.

جدول الاستخدام

مرجع سريع

إدخال	إخراج	الحجم النموذجي	السرعة	يتطلب تسجيل دخول
Form fields	AGENTS.md / CLAUDE.md	Any repo	Real-time	No

ميزات مولد AGENTS.md

إليك ما تفعله هذه الأداة المجانية بالتفصيل — كل ميزة مصممة لحل مشكلات حقيقية، تعمل بالكامل في متصفحك، ومجانية إلى الأبد.

مفتاح تبديل هدف AGENTS.md / CLAUDE.md

AGENTS.md هو اسم المواصفات المحايد (اعتمدته أكثر من 60,000 مستودع بدعم من Linux Foundation)؛ CLAUDE.md هو متغير Claude Code. كلا الملفين لهما شكل متطابق — فقط العنوان H1 واسم الملف يختلفان. اقلب مفتاح الهدف لتوليد أي منهما.

لفهرس على مستوى الموقع يواجه نماذج اللغة بدلاً من مستوى المستودع، استخدم مولّد llms.txt المجاني.

جميع الأقسام القياسية مُضمَّنة

يتضمن الإخراج كل قسم قياسي: نظرة عامة على المشروع، والأوامر (تثبيت/تطوير/بناء/اختبار/فحص/تنسيق)، ونمط الشيفرة، وملاحظات البنية، وإرشادات طلبات السحب والالتزامات، والأمان والأسرار، وقائمة عدم اللمس، وقائمة مراجعة المراجعة. الحقول الفارغة تُتخطى بصمت.

اقرنه بملف README جيد — مولّد README المجاني يبنيه في دقائق.

قائمة مراجعة المراجعة وقائمة عدم اللمس

قسمان من أكثر الأقسام قيمة للوكلاء الفعليين: قائمة مراجعة المراجعة (تُعرض كعناصر قائمة مهام GFM يمكن للوكيل تحديدها قبل الإعلان عن الانتهاء) وقائمة عدم اللمس (ملفات أو أنماط يجب ألا يعدّلها الوكيل أبداً، مثل pnpm-lock.yaml أو .env*).

نص معياري لمعايير برمجة الذكاء الاصطناعي

اختيارياً أضف قسم معايير برمجة الذكاء الاصطناعي قصير بخمس قواعد تنطبق على معظم المشاريع: لا تضف ميزات لم يطلبها المستخدم، وفضّل تعديل الملفات الموجودة، وطابق نمط الشيفرة الحالي، وشغّل الاختبارات قبل الإعلان عن الانتهاء، واسأل إذا لم تكن متأكداً.

لمعاينة كيف سيُعرض الملف النهائي، استخدم معاينة Markdown الحية المجانية بعد النسخ.

كيفية استخدام مولد AGENTS.md المجاني

الخطوة 1 — اختر هدفك

AGENTS.md (محايد) أو CLAUDE.md (خاص بـ Claude).

الخطوة 2 — املأ النموذج

اسم المشروع، النظرة العامة، اللغات، مدير الحزم، الأوامر، النمط، البنية، قواعد طلبات السحب، الأمان، قائمة المراجعة، عدم اللمس.

الخطوة 3 — انسخ والتزم

ضع الملف في جذر مستودعك. سيلتقطه الوكلاء تلقائياً.

من يمكنه استخدام هذه الأداة

Open source maintainers

Ship an AGENTS.md so contributors with AI tools don't introduce inconsistent code.

Engineering leads

Standardize how AI agents interact with the codebase across the team.

Solo indie devs

Set boundaries for your Claude Code or Cursor sessions so they match your style.

DevEx teams

Roll out AGENTS.md across every repo in the org with consistent standards.

Contractors

Quickly document conventions for a client project so the next agent session is productive.

الأسئلة الشائعة

هل مولّد AGENTS.md هذا مجاني؟

نعم. مجاني للأبد، بدون حساب مطلوب.

ما الفرق بين AGENTS.md وCLAUDE.md؟

AGENTS.md هو المواصفة المحايدة؛ CLAUDE.md هو متغير Claude Code. الشكل متطابق، فقط العنوان يختلف.

أي الوكلاء يقرأه؟

Claude Code وCursor وWindsurf وGitHub Copilot Workspaces وAider ومعظم أدوات البرمجة بالذكاء الاصطناعي اعتباراً من 2026.

هل يمكنني تخصيص الإخراج؟

نعم. الملف الناتج هو Markdown عادي — خصّصه في أي محرر بعد النسخ.

هل تُرفع معلومات مستودعي؟

لا. يعمل 100% في متصفحك.