DOCSEARCHbyAlgolia
Submit Docs

AGENTS.md

repository·main·Indexed 12 days ago

https://github.com/agentsmd/agents.md

An open format for providing context and instructions to AI coding agents. It serves as a specialized README to help agents navigate project structures, execute development workflows, and run tests.

Tokens
426
Snippets
2
Records
3
Agent score
48%

What's inside AGENTS.md

  1. What is AGENTS.md

    main
    AGENTS.md is a simple, open format designed to serve as a 'README for agents'. It provides a dedicated, predictable location within a repository to supply context and specific instructions to AI coding agents, helping them understand the project structure, development workflows, and testing requirements.

  2. Structure of an AGENTS.md file

    main

    An AGENTS.md file should contain actionable guidance organized into logical sections. Common sections include:

    • Dev environment tips: Commands for navigating the workspace, installing dependencies in a monorepo, or scaffolding new packages.
    • Testing instructions: How to locate CI plans, run specific test suites (e.g., via turbo or vitest), and ensure linting/type checks pass.
    • PR instructions: Requirements for pull request titles, commit hygiene, and mandatory pre-commit checks.
    # Sample AGENTS.md file

## Dev environment tips
- Use `pnpm dlx turbo run where <project_name>` to jump to a package...

## Testing instructions
- Run `pnpm turbo run test --filter <project_name>` to run every check...

## PR instructions
- Title format: [<project_name>] <Title>

  3. Run the AGENTS.md website locally

    main

    The repository includes a Next.js website. To run it on your local machine, follow these steps:

    1. Install dependencies using pnpm.
    2. Start the development server.
    3. Access the site at http://localhost:3000.
    pnpm install
pnpm run dev