README

AGENTS.md

!AGENTS.md logo

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
   pnpm install
   
2. Start the development server:
   bash
   pnpm run dev
   
3. Open your browser and go to http://localhost:3000