Go · AGENTS.md

The Go AGENTS.md, done right.

Copy a production-ready example below, or generate one tuned to your exact Go setup in about thirty seconds — free, in your browser.

 AGENTS.md
# your-go-app

> Go project.

Instructions for AI coding agents working in this repository.

## Setup

- Install dependencies: `go mod download`
- Start dev server: `go run ./...`
- Run tests: `go test ./...`

## Code style

- Run `gofmt`; code must be formatted before commit.
- Handle every error explicitly — never discard one with `_`.
- Keep packages small and focused.

## Guardrails

Things agents get wrong here. Follow these strictly:

- Don’t ignore returned errors.
- Don’t add a dependency when the standard library already covers it.

Why Go projects need this

Dropped into a Go repo with no context, an AI agent guesses: it reaches for the wrong package manager, ignores your structure, and edits files it shouldn’t. AGENTS.md is the briefing it reads first — so the very next prompt behaves like a teammate who already knows your conventions.

What to put in it

The example above covers the three sections that matter most for Go: the real setup commands (go mod download, go run ./..., go test ./...), your code-style conventions, and the guardrails agents reliably get wrong. The generator fills these in from your actual manifest so the commands match your project, not a generic template.

Frequently asked

What is an AGENTS.md file in a Go project?

It is a markdown file at your repo root that tells AI coding agents how your Go project works — setup commands, code style and guardrails — so they follow your conventions instead of guessing.

Which tools read this file?

AGENTS.md is a shared convention read by Cursor, Claude Code, OpenAI Codex, GitHub Copilot, Gemini, Windsurf, Zed and others. For tools with their own filename you can export that format or symlink it to AGENTS.md.

What should a Go AGENTS.md include?

At minimum: install/dev/test commands (go mod download, go run ./..., go test ./...), your code-style conventions, and the guardrails agents get wrong — like Don’t ignore returned errors.

Other stacks

Generate your Go AGENTS.md

Detect your stack, tune the guardrails, export to every agent format. Free.

Open the generator