https://github.com/openai/agents.md
AGENTS.md — a simple, open format for guiding coding agents
https://github.com/openai/agents.md
Last synced: 4 months ago
JSON representation
AGENTS.md — a simple, open format for guiding coding agents
- Host: GitHub
- URL: https://github.com/openai/agents.md
- Owner: openai
- License: mit
- Created: 2025-08-19T17:22:54.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-08-28T22:03:57.000Z (5 months ago)
- Last Synced: 2025-08-29T03:40:16.139Z (5 months ago)
- Language: TypeScript
- Homepage: https://agents.md
- Size: 1.63 MB
- Stars: 4,133
- Watchers: 34
- Forks: 292
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- StarryDivineSky - openai/agents.md
- awesome-data-analysis - Agents.md - Open source framework for building agentic AI systems. (🧠 AI Applications & Platforms / Tools)
- awesome-agents.md - OpenAI/agents.md - The official spec of the `AGENTS.md` format.  (Specification)
- awesome - openai/agents.md - AGENTS.md — a simple, open format for guiding coding agents (TypeScript)
- awesome-ccamel - openai/agents.md - AGENTS.md — a simple, open format for guiding coding agents (TypeScript)
- awesome - openai/agents.md - AGENTS.md — a simple, open format for guiding coding agents (TypeScript)
- my-awesome-starred - openai/agents.md - AGENTS.md — a simple, open format for guiding coding agents (TypeScript)
README
# AGENTS.md
[AGENTS.md](https://agents.md) is a simple, open format for guiding coding agents.
Think of AGENTS.md as a README for agents: a dedicated, predictable place
to provide context and instructions to help AI coding agents work on your project.
Below is a minimal example of an AGENTS.md file:
```markdown
# Sample AGENTS.md file
## Dev environment tips
- Use `pnpm dlx turbo run where ` to jump to a package instead of scanning with `ls`.
- Run `pnpm install --filter ` to add the package to your workspace so Vite, ESLint, and TypeScript can see it.
- Use `pnpm create vite@latest -- --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 ` 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 ""`.
- Fix any test or type errors until the whole suite is green.
- After moving files or changing imports, run `pnpm lint --filter ` 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: []
- Always run `pnpm lint` and `pnpm test` before committing.
```
## Website
This repository also includes a basic Next.js website hosted at https://agents.md/
that explains the project’s goals in a simple way, and featuring some examples.
### Running the app locally
1. Install dependencies:
```bash
npm install
```
2. Start the development server:
```bash
npm run dev
```
3. Open your browser and go to http://localhost:3000