Meta tags:
description=AGENTS.md is a simple, open format for guiding coding agents, used by over 60k open-source projects. Think of it as a README for agents.;

Headings (most frequently used words):

agents, md, how, do, to, use, add, what, instructions, configure, why, one, works, across, many, examples, about, faq, openai, codex, apache, airflow, temporalio, sdk, java, plutolang, pluto, cover, matters, extra, large, monorepo, nested, files, for, subprojects, are, there, required, fields, if, conflict, will, the, agent, run, testing, commands, found, in, automatically, can, update, it, later, migrate, existing, docs, aider, gemini, cli,

Text of the page (most frequently used words):
#agents (43), the (30), and (19), from (19), for (14), pnpm (12), agent (11), you (11), use (10), run (10), coding (10), code (10), instructions (8), package (8), test (7), that (6), add (6), project_name (6), project (5), gemini (5), cli (5), aider (5), files (5), can (5), file (5), google (5), openai (5), one (5), with (5), github (5), configure (4), how (4), format (4), codex (4), your (4), tests (4), typescript (4), name (4), cognition (4), readme (4), context (3), existing (3), create (3), before (3), testing (3), commands (3), provide (3), are (3), this (3), open (3), factory (3), cursor (3), jules (3), amp (3), place (3), guidelines (3), work (3), view (3), examples (3), java (3), filter (3), vite (3), install (3), dev (3), projects (2), see (2), json (2), read (2), docs (2), update (2), will (2), relevant (2), checks (2), fix (2), automatically (2), closest (2), what (2), just (2), any (2), foundation (2), across (2), ecosystem (2), another (2), inside (2), each (2), every (2), large (2), commit (2), security (2), steps (2), new (2), extra (2), style (2), build (2), help (2), root (2), even (2), 60k (2), focus (2), general (2), purpose (2), sdk (2), defined (2), workflows (2), lint (2), title (2), eslint (2), pass (2), vitest (2), all (2), check (2), turbo (2), find (2), react (2), where (2), augment (2), windsurf (2), ona (2), copilot (2), semgrep (2), phoenix (2), kilo (2), roocode (2), jetbrains (2), junie (2), uipath (2), autopilot (2), coded (2), devin (2), warp (2), zed (2), opencode (2), goose (2), focused (2), complements (2), human (2), contributors (2), predictable (2), copyright, series, llc, web, site, terms, trademark, policy, other, policies, please, https, lfprojects, org, filename, settings, conf, yml, rename, symbolic, links, backward, compatibility, migrate, absolutely, treat, living, documentation, later, yes, list, them, attempt, execute, programmatic, failures, finishing, task, found, edited, wins, explicit, user, chat, prompts, override, everything, conflict, standard, markdown, headings, like, simply, parses, text, there, required, fields, faq, now, stewarded, under, linux, learn, more, agentic, committed, helping, maintain, evolve, benefits, entire, developer, community, regardless, which, emerged, collaborative, efforts, software, development, including, about, nearest, directory, tree, takes, precedence, subproject, ship, tailored, example, time, writing, main, repo, has, monorepo, nested, subprojects, messages, pull, request, gotchas, datasets, deployment, anything, tell, teammate, belongs, here, too, considerations, overview, sections, effectively, popular, choices, cover, matters, repository, most, scaffold, ask, nicely, superset, lua, programming, plutolang, pluto, 135, temporal, workflow, orchestration, temporalio, 4478, python, platform, programmatically, author, schedule, monitor, apache, airflow, 502, rust, tooling, always, committing, change, nobody, asked, after, moving, changing, imports, sure, rules, still, type, errors, until, whole, suite, green, step, pattern, call, should, merge, plan, folder, field, confirm, right, skip, top, level, spin, ready, latest, template, workspace, jump, instead, scanning, dlx, environment, tips, sample, supported, definitions, compatible, growing, tools, works, many, rather, than, introducing, proprietary, chose, could, anyone, building, using, helpful, feel, free, adopt, precise, guidance, keep, readmes, concise, give, clear, intentionally, kept, separate, containing, sometimes, detailed, need, conventions, might, clutter, aren, humans, quick, starts, descriptions, contribution, why, functional, patterns, possible, single, quotes, semicolons, strict, mode, start, server, deps, setup, explore, think, dedicated, simple, guiding, used, over, source,

Text of the page (random words):
agents md agents md a simple open format for guiding coding agents used by over 60k open source projects think of agents md as a readme for agents a dedicated predictable place to provide the context and instructions to help ai coding agents work on your project explore examples view on github agents md setup commands install deps pnpm install start dev server pnpm dev run tests pnpm test code style typescript strict mode single quotes no semicolons use functional patterns where possible why agents md readme md files are for humans quick starts project descriptions and contribution guidelines agents md complements this by containing the extra sometimes detailed context coding agents need build steps tests and conventions that might clutter a readme or aren t relevant to human contributors we intentionally kept it separate to give agents a clear predictable place for instructions keep readmes concise and focused on human contributors provide precise agent focused guidance that complements existing readme and docs rather than introducing another proprietary file we chose a name and format that could work for anyone if you re building or using coding agents and find this helpful feel free to adopt it one agents md works across many agents your agent definitions are compatible with a growing ecosystem of ai coding agents and tools codex from openai jules from google factory aider goose opencode zed warp vs code devin from cognition autopilot coded agents from uipath junie from jetbrains codex from openai jules from google factory aider goose opencode zed warp vs code devin from cognition autopilot coded agents from uipath junie from jetbrains amp cursor roocode gemini cli from google kilo code phoenix semgrep coding agent from github copilot ona windsurf from cognition augment code amp cursor roocode gemini cli from google kilo code phoenix semgrep coding agent from github copilot ona windsurf from cognition augment code view all supported agents examples sample agents md file dev environment tips use pnpm dlx turbo run where project_name to jump to a package instead of scanning with ls run pnpm install filter project_name to add the package to your workspace so vite eslint and typescript can see it use pnpm create vite latest project_name template react ts to spin up a new react vite package with typescript checks ready check the name field inside each package s package json to confirm the right name skip the top level one testing instructions find the ci plan in the github workflows folder run pnpm turbo run test filter project_name to run every check defined for that package from the package root you can just call pnpm test the commit should pass all tests before you merge to focus on one step add the vitest pattern pnpm vitest run t test name fix any test or type errors until the whole suite is green after moving files or changing imports run pnpm lint filter project_name to be sure eslint and typescript rules still pass add or update tests for the code you change even if nobody asked pr instructions title format project_name title always run pnpm lint and pnpm test before committing openai codex general purpose cli tooling for ai coding agents rust 502 apache airflow platform to programmatically author schedule and monitor workflows python 4478 temporalio sdk java java sdk for temporal workflow orchestration defined in code java 135 plutolang pluto a superset of lua 5 4 with a focus on general purpose programming c 8 view 60k examples on github how to use agents md 1 add agents md create an agents md file at the root of the repository most coding agents can even scaffold one for you if you ask nicely 2 cover what matters add sections that help an agent work effectively with your project popular choices project overview build and test commands code style guidelines testing instructions security considerations 3 add extra instructions commit messages or pull request guidelines security gotchas large datasets deployment steps anything you d tell a new teammate belongs here too 4 large monorepo use nested agents md files for subprojects place another agents md inside each package agents automatically read the nearest file in the directory tree so the closest one takes precedence and every subproject can ship tailored instructions for example at time of writing the main openai repo has 88 agents md files about agents md emerged from collaborative efforts across the ai software development ecosystem including openai codex amp jules from google cursor and factory we re committed to helping maintain and evolve this as an open format that benefits the entire developer community regardless of which coding agent you use agents md is now stewarded by the agentic ai foundation under the linux foundation learn more faq are there required fields no agents md is just standard markdown use any headings you like the agent simply parses the text you provide what if instructions conflict the closest agents md to the edited file wins explicit user chat prompts override everything will the agent run testing commands found in agents md automatically yes if you list them the agent will attempt to execute relevant programmatic checks and fix failures before finishing the task can i update it later absolutely treat agents md as living documentation how do i migrate existing docs to agents md rename existing files to agents md and create symbolic links for backward compatibility mv agent md agents md ln s agents md agent md how do i configure aider configure aider to use agents md in aider conf yml read agents md how do i configure gemini cli configure gemini cli to use agents md in gemini settings json context filename agents md copyright agents md a series of lf projects llc for web site terms of use trademark policy and other project policies please see https lfprojects org