RUBY ON RAILS AGENTS.MD

A Ruby on Rails application following Rails conventions. The rules push an agent toward generators, conventional file locations and Rails security defaults instead of hand-rolled alternatives.

Zero retention: everything you type stays in this browser. Verify it yourself in DevTools.
The Ruby on Rails filesCustomize in the generator
AGENTS.mdFor Codex, Cursor, Copilot, Jules, Windsurf and more
# AGENTS.md

Project: rails-app. A Ruby on Rails application with Hotwire and PostgreSQL.

This file is the single source of truth for every coding agent working in this repository. The tool-specific files (CLAUDE.md, GEMINI.md, .github/copilot-instructions.md and .cursor/rules/project.mdc) point here. Edit this file, not those.

## Stack

- Language: Ruby
- Framework: Ruby on Rails
- Database: PostgreSQL
- Hosting: Docker on your own servers
- Tests: Minitest
- Package manager: Bundler

## Commands

Run these from the repository root.

- Install dependencies: `bundle install`
- Run locally: `bin/dev`
- Run all tests: `bin/rails test`
- Run one test file: `bin/rails test test/models/user_test.rb:12`
- Lint: `bin/rubocop`
- Format: `bin/rubocop -a`

## Project layout

- `app/models/`: Active Record models
- `app/controllers/`: Controllers
- `app/views/`: ERB templates and Turbo streams
- `app/javascript/controllers/`: Stimulus controllers
- `db/migrate/`: Migrations
- `db/schema.rb`: Generated schema (never edit by hand)
- `test/`: Minitest tests and fixtures

## Code style

- Indent with 2 spaces. Never tabs.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- Prefer small pure functions and immutable data; keep side effects at the edges (handlers, jobs, I/O modules).
- Never swallow an error. Handle it where you can act on it, or rethrow it with context about what failed.
- Commit messages follow Conventional Commits: `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`, with an imperative summary under 72 characters.

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.

## Product constraints

- Validate all input at the boundary, use parameterized queries only, and treat every external payload as untrusted.

## Project-specific notes

- Use Rails generators (`bin/rails generate model`, `migration`, `controller`) so files land in conventional places with matching tests.
- Every controller that writes data uses strong parameters (`params.expect` or `params.require(...).permit(...)`); never pass `params` straight to a model.
- Schema changes go in a new migration; run `bin/rails db:migrate` and commit the updated `db/schema.rb`. Never edit `schema.rb` by hand.
- Avoid N+1 queries with `includes` in list views.
- Prefer Hotwire (Turbo frames and streams, Stimulus) for interactivity before adding a JavaScript framework.
- Credentials live in `bin/rails credentials:edit` or environment variables, never in code or `config/*.yml` committed in plain text.
- Put business logic in models or plain Ruby objects under `app/models`, not in controllers or views.

## Project phase

This project is in active development. Follow the patterns that already exist; consistency beats novelty.
CLAUDE.mdFor Claude Code
# CLAUDE.md

@AGENTS.md

## Claude Code

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file, so every agent stays in sync.
- Put Claude-only preferences below this line. Personal, uncommitted notes belong in CLAUDE.local.md.
GEMINI.mdFor Gemini CLI
# GEMINI.md

@./AGENTS.md

## Gemini CLI

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file.
- Alternative: delete this file and set "context": { "fileName": ["AGENTS.md"] } in .gemini/settings.json so Gemini CLI reads AGENTS.md directly.
.github/copilot-instructions.mdFor GitHub Copilot
# Copilot instructions

Project: rails-app. A Ruby on Rails application with Hotwire and PostgreSQL.

The full instructions are in AGENTS.md at the repository root. Read it before you change code; if anything here disagrees with it, AGENTS.md wins. The essentials are repeated below for Copilot surfaces that only read this file.

## Stack

- Language: Ruby
- Framework: Ruby on Rails
- Database: PostgreSQL
- Hosting: Docker on your own servers
- Tests: Minitest
- Package manager: Bundler

## Commands

- Install dependencies: `bundle install`
- Run locally: `bin/dev`
- Run all tests: `bin/rails test`
- Run one test file: `bin/rails test test/models/user_test.rb:12`
- Lint: `bin/rubocop`
- Format: `bin/rubocop -a`

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
.cursor/rules/project.mdcFor Cursor
---
description: Project instructions for every task (mirrors AGENTS.md)
globs:
alwaysApply: true
---

# Project rules

The project instructions live in @AGENTS.md at the repository root, which Cursor loads automatically. They are not repeated here, so they cost context only once. Edit AGENTS.md, not this rule.

Before you change code, check the Commands and Working rules sections of AGENTS.md, and run its test and lint commands before you say a task is done.

Put Cursor-only rules below, or add scoped rules as more .mdc files with `globs` (for example `src/components/**/*.tsx`).

These are the exact files the generator writes for this preset. Change any command or rule in the generator and download your own set.

About the Ruby on Rails preset

What Is in the Ruby on Rails AGENTS.md?

The preset describes a a Ruby on Rails application with Hotwire and PostgreSQL. Its AGENTS.md is 51 non-empty lines with 6 exact commands, 7 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: bundle install, bin/dev, bin/rails test, bin/rails test test/models/user_test.rb:12, bin/rubocop, bin/rubocop -a.
  • Layout: app/models/, app/controllers/, app/views/, app/javascript/controllers/, db/migrate/, db/schema.rb, test/.
  • Wrappers: CLAUDE.md and GEMINI.md import AGENTS.md; the Copilot file repeats the essentials; the Cursor rule points to AGENTS.md.

Why These Rules for Ruby on Rails?

Strong params prevent mass assignment

Passing raw params to create lets a user set any column, including admin. Rails raises an error by default, and agents work around it with permit!. The rule makes the safe pattern the only acceptable one.

schema.rb is generated

It reflects the result of migrations. Editing it directly makes the next migration overwrite your change or leaves environments with different schemas.

Conventions are the documentation

Rails relies on naming and location. A model placed outside app/models or a misnamed test file is invisible to autoloading or the test runner, and agents happily invent their own structure.

Hotwire first

Rails ships a full interactivity stack. Agents trained on React often reach for a separate frontend, adding complexity the app does not need.

Which Stack Rules Does the File Add?

  • Use Rails generators (bin/rails generate model, migration, controller) so files land in conventional places with matching tests.
  • Every controller that writes data uses strong parameters (params.expect or params.require(...).permit(...)); never pass params straight to a model.
  • Schema changes go in a new migration; run bin/rails db:migrate and commit the updated db/schema.rb. Never edit schema.rb by hand.
  • Avoid N+1 queries with includes in list views.
  • Prefer Hotwire (Turbo frames and streams, Stimulus) for interactivity before adding a JavaScript framework.
  • Credentials live in bin/rails credentials:edit or environment variables, never in code or config/*.yml committed in plain text.
  • Put business logic in models or plain Ruby objects under app/models, not in controllers or views.

How Do You Add These Files to a Ruby on Rails Repository?

  1. Download the zip above. It is laid out exactly as the files go into the repository.
  2. Unzip it at the repository root. AGENTS.md, CLAUDE.md and GEMINI.md go next to your README; the Copilot file goes in .github/ and the Cursor rule in .cursor/rules/.
  3. Open AGENTS.md and check every command against your package scripts or Makefile.
  4. Delete wrappers for tools your team does not use, and any old .cursorrules or .windsurfrules file.
  5. Commit, then run the linter on AGENTS.md whenever you change it.

Want different commands or rules? Load this preset into the generator, change anything, and download your own set.

Which Agents Will Read These Files?

AGENTS.md is read directly by Codex, Cursor, Windsurf, Cline, Zed and Jules, and by GitHub Copilot's cloud agent, code review and CLI. Claude Code reads it through the generated CLAUDE.md, and Gemini CLI through GEMINI.md. See the compatibility table for details, last verified 2026-11-13.

Where Are the Other Stacks?

All presets are on the stacks page.

Frequently Asked Questions

Does this template use RSpec?

It uses Minitest, the Rails default. If your app uses RSpec, choose it in the generator and the test commands change to bundle exec rspec.

Why no type-check command?

Ruby projects usually do not run a type checker. If you use Sorbet or Steep, add its command in the generator.

Which Rails version is this for?

Recent Rails with Hotwire defaults. params.expect is newer; older apps use params.require with permit, which the rule also allows.

Are these Ruby on Rails files free to use?

Yes. Copy them into any project, commercial or not, without attribution. They are a starting point: adjust the commands and rules to match your repository.

How Can You Verify That Nothing Leaves This Browser?

You do not have to take our word for it. Developer tools show every request a page makes, so you can watch this page work and confirm that nothing you type is sent. The check takes under a minute.

  1. Open your browser developer tools with F12, or Cmd+Option+I on a Mac, and select the Network tab.
  2. Reload the page and let it finish. You will see the page's own files, its web fonts, and one anonymous page-view request. Nothing has been typed yet, so none of them can contain your input.
  3. Click the clear icon in the Network tab so that the log is empty.
  4. Switch between the file tabs, copy a file and download the zip.
  5. Look at the Network tab again. It is still empty. Downloads are built in the page as Blob URLs, so even the zip never touches a server. For extra proof, turn on offline mode after the page loads: everything keeps working.

Only the feedback form can add a line to that log, and it sends only the vote and comment you type into it. 2prompt has no server code at all: no API, no model and no database of your files. The production site also sends a Content-Security-Policy header that tells your browser to refuse connections to anywhere except this site, the fonts and the anonymous analytics endpoint.

Was this helpful?