RUST + AXUM AGENTS.MD

A web service in Rust using Axum on the Tokio runtime. The rules focus on what agents do badly in Rust: unwrap everywhere, fighting the borrow checker with clones, and blocking the async runtime.

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

Project: axum-service. A Rust web service built on Axum and Tokio with PostgreSQL via sqlx.

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: Rust
- Framework: Axum
- Database: PostgreSQL
- Hosting: Fly.io
- Tests: cargo test
- Package manager: Cargo

## Commands

Run these from the repository root.

- Install dependencies: `cargo fetch`
- Run locally: `cargo run`
- Build: `cargo build --release`
- Run all tests: `cargo test`
- Run one test file: `cargo test orders::tests::create_order`
- Lint: `cargo clippy --all-targets -- -D warnings`
- Type-check: `cargo check`
- Format: `cargo fmt`

## Project layout

- `src/main.rs`: Startup: config, pool, router
- `src/routes/`: Axum handlers by resource
- `src/error.rs`: The application error type and its IntoResponse impl
- `src/db/`: sqlx queries
- `migrations/`: sqlx migrations

## Code style

- Indentation and line wrapping are whatever the formatter produces; do not hand-format against it.
- 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.
- Comments explain why the code is the way it is. Do not add comments that restate what the code does.
- 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

- Watch the performance budget: no new blocking requests on page load, and justify any bundle-size increase in the change description.

## Project-specific notes

- No `unwrap()` or `expect()` outside tests and startup code; return `Result` and use `?`.
- Library-style errors use `thiserror` enums; handlers return `Result<_, AppError>` where `AppError` implements `IntoResponse`.
- `cargo clippy --all-targets -- -D warnings` and `cargo fmt --check` must pass.
- Never block the async runtime: no `std::thread::sleep` or blocking I/O in async functions; use `tokio::task::spawn_blocking` for CPU-heavy work.
- Share state through `State<AppState>` with `Arc` inside; do not use global mutable statics.
- Use sqlx query macros (`query!`, `query_as!`) so SQL is checked at compile time; run `cargo sqlx prepare` after changing queries.
- Do not add `.clone()` just to satisfy the borrow checker without explaining why it is needed.

## 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: axum-service. A Rust web service built on Axum and Tokio with PostgreSQL via sqlx.

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: Rust
- Framework: Axum
- Database: PostgreSQL
- Hosting: Fly.io
- Tests: cargo test
- Package manager: Cargo

## Commands

- Install dependencies: `cargo fetch`
- Run locally: `cargo run`
- Build: `cargo build --release`
- Run all tests: `cargo test`
- Run one test file: `cargo test orders::tests::create_order`
- Lint: `cargo clippy --all-targets -- -D warnings`
- Type-check: `cargo check`
- Format: `cargo fmt`

## 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 Rust + Axum preset

What Is in the Rust + Axum AGENTS.md?

The preset describes a a Rust web service built on Axum and Tokio with PostgreSQL via sqlx. Its AGENTS.md is 52 non-empty lines with 8 exact commands, 5 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: cargo fetch, cargo run, cargo build --release, cargo test, cargo test orders::tests::create_order, cargo clippy --all-targets -- -D warnings, cargo check, cargo fmt.
  • Layout: src/main.rs, src/routes/, src/error.rs, src/db/, migrations/.
  • 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 Rust + Axum?

unwrap is a crash waiting to happen

Agents use unwrap to get code compiling quickly. In a server, every unwrap on external input is a potential panic that takes down a worker. The ? operator keeps errors flowing to one place that turns them into responses.

Clones hide design problems

Cloning to silence the borrow checker compiles, but can copy large data on every request. Asking for a reason surfaces cases where a reference or an Arc is the right fix.

Blocking inside async

A blocking call stalls a Tokio worker thread and every task scheduled on it. It looks fine in tests and degrades under load.

Compile-time SQL checks need preparation

sqlx macros verify queries against the schema, and offline builds need the prepared query data kept up to date.

Which Stack Rules Does the File Add?

  • No unwrap() or expect() outside tests and startup code; return Result and use ?.
  • Library-style errors use thiserror enums; handlers return Result<_, AppError> where AppError implements IntoResponse.
  • cargo clippy --all-targets -- -D warnings and cargo fmt --check must pass.
  • Never block the async runtime: no std::thread::sleep or blocking I/O in async functions; use tokio::task::spawn_blocking for CPU-heavy work.
  • Share state through State<AppState> with Arc inside; do not use global mutable statics.
  • Use sqlx query macros (query!, query_as!) so SQL is checked at compile time; run cargo sqlx prepare after changing queries.
  • Do not add .clone() just to satisfy the borrow checker without explaining why it is needed.

How Do You Add These Files to a Rust + Axum 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

Why set indentation to the formatter?

rustfmt decides formatting for Rust projects. The rule tells the agent to run cargo fmt rather than hand-format.

Does this work with Actix Web?

The error, async and clippy rules do. Replace the Axum-specific rules about State and IntoResponse with Actix equivalents in the notes.

Why clippy with -D warnings?

It turns lints into errors so the agent cannot leave warnings behind. Relax it in the generator if your codebase has existing warnings to burn down first.

Are these Rust + Axum 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?