Ruby on Rails · AGENTS.md

The Ruby on Rails AGENTS.md, done right.

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

 AGENTS.md
# your-rails-app

> Ruby on Rails project.

Instructions for AI coding agents working in this repository.

## Setup

- Install dependencies: `bundle install`
- Start dev server: `bin/dev`
- Run tests: `bin/rails test`

## Code style

- Follow Rails conventions over configuration.
- Skinny controllers; push logic into models or service objects.
- Run RuboCop before committing.

## Guardrails

Things agents get wrong here. Follow these strictly:

- Never edit `db/schema.rb` by hand.
- Avoid N+1 queries; use `includes` for associations.

Why Ruby on Rails projects need this

Dropped into a Ruby on Rails 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 Ruby on Rails: the real setup commands (bundle install, bin/dev, bin/rails 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 Ruby on Rails project?

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

At minimum: install/dev/test commands (bundle install, bin/dev, bin/rails test), your code-style conventions, and the guardrails agents get wrong — like Never edit db/schema.rb by hand.

Other stacks

Generate your Ruby on Rails AGENTS.md

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

Open the generator