Rust · AGENTS.md

The Rust AGENTS.md, done right.

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

 AGENTS.md
# your-rust-app

> Rust project.

Instructions for AI coding agents working in this repository.

## Setup

- Install dependencies: `cargo build`
- Start dev server: `cargo run`
- Run tests: `cargo test`

## Code style

- Run `cargo fmt`; `cargo clippy` must pass with no warnings.
- Prefer `Result` over panics in library code.
- No `unwrap()` in non-test code without a justifying comment.

## Guardrails

Things agents get wrong here. Follow these strictly:

- Don’t edit `Cargo.lock` by hand.
- Don’t introduce `unsafe` without a comment proving its soundness.

Why Rust projects need this

Dropped into a Rust 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 Rust: the real setup commands (cargo build, cargo run, cargo 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 Rust project?

It is a markdown file at your repo root that tells AI coding agents how your Rust 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 Rust AGENTS.md include?

At minimum: install/dev/test commands (cargo build, cargo run, cargo test), your code-style conventions, and the guardrails agents get wrong — like Don’t edit Cargo.lock by hand.

Other stacks

Generate your Rust AGENTS.md

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

Open the generator