AgentMD

Beginner Path

New to AgentMD? Follow these 3 steps to get your first useful result.

What AgentMD does (in plain English)

AgentMD reads your AGENTS.md file, checks it for safety, and runs the commands you listed (like build, test, and lint).

Step 1: Create AGENTS.md

From your project folder — no install required:

npx @agentmd/cli init

Or with pnpm: pnpm add -D @agentmd/cli && pnpm exec agentmd init

Step 2: Validate before running

Make sure your instructions are safe and structured:

npx @agentmd/cli validate
npx @agentmd/cli score

Step 3: Preview, then run

Dry-run first. Then run only test commands:

npx @agentmd/cli run . --dry-run
npx @agentmd/cli run . test

If a command is blocked

By default, AgentMD uses safe execution mode. If your command needs shell operators like pipes (|) or redirects, rerun with:

npx @agentmd/cli run . --use-shell

Minimal AGENTS.md example

## Build
`pnpm run build`

## Test
`pnpm test`

## Lint
`pnpm run lint`