AGENTS.md in 5 Minutes
Create an AGENTS.md file, validate it, and run your first execution.
1. Install & create AGENTS.md
From your repo root, install the CLI and create a sample file:
pnpm add -D @agentmd/cli
pnpm exec agentmd initOr use the AGENTS.md Generator to create a template for React, Next.js, Python, Rust, Go, or Java.
Or create AGENTS.md manually:
## Build
```bash
pnpm install
pnpm run build
```
## Test
`pnpm test`
## Lint
`pnpm run lint`2. Validate
Check your file and get a score:
agentmd validate
agentmd score3. Execute
Preview with dry-run, then run:
agentmd run . --dry-run # Preview
agentmd run . test # Run test commands4. Connect to Dashboard
Link your GitHub repo to run executions from the dashboard, view success rates, and get ROI metrics. Deploying? Use the GitHub App Setup Wizard to generate OAuth and GitHub App URLs and env vars.