agentleFS
Sign inSign up

AGENTS.md examples from real projects

How real projects brief Codex, Cursor and every other agent that reads AGENTS.md.

Most stars first · from page 6Worked for most · soon
MicrosoftAGENTS.md

generative-ai-for-beginners / zh-TW

microsoft/generative-ai-for-beginners/translations/zh-TW/AGENTS.md

本儲存庫包含一個完整的21課程綱要,教導生成式 AI 的基礎和應用開發。此課程專為初學者設計,涵蓋從基礎概念到建立可投入生產的應用程式。 核心技術: - Python 3.9+,搭配以下套件:openai、python-dotenv、tiktoken、azure-ai-inference、pandas、numpy、matplotlib - TypeScript/JavaScript,搭配 Node.js 及套件:openai(Azure OpenAI 透過 v1 端點和 Responses API)、@azure-rest/ai-inference(Microsoft Foundry 模型) - Azure OpenAI 服務、OpenAI API 與 Microsoft Foundry 模型(GitHub Models 將於2026年7月底停用) - 使用 Jupyter 筆記本進行互動式學習 - 使用開發容器以保持一致的開發環境 儲存庫結構: - 21 個按序號命名的課程目錄(00-21),包含 README、程式碼範例和作業 - 多種實作版本:Python、TypeScript,有時也有 .NET 範例 - translations 目錄中有 40 多種語言版本 - 統一使用 .env 檔案做設定管理(可使用 .env.copy 作為範本) 本儲存庫提供 .devcontainer 設定,適用於 GitHub Codespaces 或 VS Code 的開發容器: 所有需要 API 訪問的課程均使用 .env 檔案定義的環境變數:

121k3mo agoReads credentialsDiscuss
SupabaseAGENTS.md

supabase

supabase/supabase/AGENTS.md

pnpm 11 + Turborepo monorepo. Requires Node >= 22.13. Every PR must pass typecheck + lint (one workflow), Prettier, and a typos check. Other checks are path-filtered: Studio unit tests/build and the lint ratchet (ESLint warning count must not increase) run on apps/studio/** changes; app-specific test suites run on their own paths. Never hand-edit generated files: packages/api-types/types/*, */routeTree.gen.ts, **/generated/, apps/docs/features/docs/generated/, apps/www/.generated/**, `supabase/functions/common/database-

111k8d agoDiscuss
SupabaseAGENTS.md

supabase / apps

supabase/supabase/apps/docs/AGENTS.md

Next.js app router + MDX. Dev server: pnpm dev:docs → http://localhost:3001/docs (the bare / 404s). style-guide/ holds the docs style guide as plain markdown. Load the file you need rather than the whole directory. No tool enforces the guide, so applying it is the author's job, or the skill's. Load these before working. pm-the-docs, write-the-docs, edit-the-docs, ask-the-docs, and review-the-docs back the docs authoring process. See CONTRIBUTING.md for which stage each covers. They apply the style guide above. For architecture questions…

111k8d agoDiscuss
SupabaseAGENTS.md

supabase / kb

supabase/supabase/apps/kb/AGENTS.md

When starting the dev server, run: Full documentation: https://docs.astro.build Consult these guides before working on related tasks: To run a full production build, run: Content lives under src/content/guides/*.{md,mdx}. Keep it plain GitHub-Flavored Markdown: - No custom/JSX components in guide bodies — content is also exported as plain .md (see below), and a component wouldn't survive that export. - For callouts, use GitHub's native alert syntax (> [!NOTE], > [!TIP], > [!IMPORTANT], > [!WARNING], > [!CAUTION]) — the build renders these…

111k8d agoDiscuss
SupabaseAGENTS.md

supabase / studio

supabase/supabase/apps/studio/AGENTS.md

Next.js pages router + TanStack Start (mid-migration, see below), React 19. Dev server: pnpm dev:studio → http://localhost:8082. Load the skills matching the task; stack them when a task spans areas: Studio is migrating from the Next.js pages router (pages/) to TanStack Start (routes/). Both runtimes ship side-by-side; the STUDIOFRAMEWORK env var selects which one pnpm dev/build runs (default: next, resolved in scripts/dispatch.js). Full route map and strategy: TANSTACKMIGRATION.md.

111k8d agoDiscuss
MicrosoftAGENTS.md

terminal

microsoft/terminal/AGENTS.md

These rules apply to all public contributions and interactions, no matter how they're done. The entity operating or authorizing the contributions and interactions is responsible for them. AI assistance does not relieve contributors of responsibility for their work. "The AI did it" is not an excuse. Violations may result in contributions being closed without further comment. Cases of deception, evasion, or repeat violations may result in account bans. Allowed: - All AI usage that remains non-public (e.g. questions, reviews, local…

105k20d agoDiscuss
CLAUDE.md vs AGENTS.md

About AGENTS.md

What is AGENTS.md?

An open format for instructions to coding agents, read by Codex, Cursor and others. Think of it as a README written for agents.

Where does it go?

At the repository root, with more specific files in subdirectories. Agents read the one closest to the file they're editing.

What should it contain?

Setup and test commands, code style, and the rules a new contributor would need to know.

Does Claude Code read it?

Claude Code reads CLAUDE.md. A one-line CLAUDE.md that points at AGENTS.md covers both.