What is fastapi-template AGENTS.md?

Project guidance for a FastAPI application built with Python, PostgreSQL, SQLAlchemy, database migrations, and a domain-based structure. FastAPI is a Python framework for building web APIs.

Use it when changing API features, domain areas, database models or migrations, dependency setup, formatting, linting, or automated tests.

It records the project's commands, architecture, and checks so changes fit the existing codebase and can be tested consistently.

How pol-lopez/fastapi-template configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to pol-lopez/fastapi-template. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/pol-lopez/fastapi-template/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/pol-lopez/fastapi-template

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/pol-lopez/fastapi-template/agents-md/github.svg)](https://agentmods.dev/instructions/pol-lopez/fastapi-template/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/pol-lopez/fastapi-template/agents-md"><img src="https://agentmods.dev/badge/instructions/pol-lopez/fastapi-template/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/pol-lopez/fastapi-template/agents-md"><img src="https://agentmods.dev/badge/instructions/pol-lopez/fastapi-template/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 921 This file is loaded in full into every session.

When invoked 921 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00921	$0.00921
Opus 5.5	$0.00368	$0.00368
Sonnet 5.5	$0.00184	$0.00184
Haiku 4.5	$0.00092	$0.00092

Measured 2mo ago against content hash 45107ed47f63, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

fastapi-template AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 79 lines

How it starts

The opening of the file, as written. The whole thing — 79 lines — stays where its author put it; the contents beside it link to each section on GitHub.

FastAPI Template - Project Guidelines

This file provides guidance to AI coding agents (Claude Code, Codex, Cursor, etc.) when working with code in this repository.

Overview

FastAPI + Python 3.14 + PostgreSQL + SQLAlchemy async + Alembic. Hexagonal DDD architecture with bounded contexts under src/contexts/. Dependency injection via dependency-injector. CLI via Typer.

Commands

make start               # Start services (docker compose up)
make stop                # Stop services
make build               # Build Docker images
make fmt                 # Format code with ruff
make lint                # Lint code with ruff --fix
make all                 # Install + format + lint
make test                # Run all tests (Docker)
make test-unit           # Run unit tests (Docker)
make test-unit-local     # Run unit tests locally (fast, no Docker)
make test-integration    # Run integration tests (Docker)
make test-e2e            # Run e2e tests (Docker)
make test-cov            # Run tests with coverage (Docker)
make migration-create    # Create autogenerated Alembic migration
make migration-upgrade   # Apply migrations (upgrade head)
make migration-downgrade # Revert last migration
make migration-history   # Show migration history
make cli args="..."      # Run CLI commands in container

Code Style

Language: All code, variable names, class names, function names, and comments in English. Commit messages and PR descriptions in English.
Comments: Never add comments unless explicitly requested or the code is genuinely non-obvious. Do not add explanatory comments when removing dead code — just remove it.
Imports: Absolute, starting with src/ (e.g., from src.contexts.auth.domain.aggregates import User)
Async: Always async/await for I/O operations. Use asyncpg driver.
Python: Strict typing. Use | union syntax, not Optional. Explicit return types on all functions. No Any.
Errors: Throw custom Domain Errors (src/contexts/*/domain/errors.py), never generic HTTPException in domain/application layers. The HTTP middleware translates domain errors to HTTP responses.
Formatting: Ruff enforces 88-char line length, double quotes, 4-space indent. Do NOT fight ruff — if it reformats something, that's the project standard.

Read the full file on GitHub · 79 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 79 lines · 921 tokens per session scan A 45107ed47f63

Subscribe to this mod's changes

fastapi-template AGENTS.md is an instructions file published in the GitHub repository pol-lopez/fastapi-template (22 stars, last pushed 4d ago), licensed MIT. It adds 921 tokens to every session, about $0.0037 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Backend and APIs

fastapi-template AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
fastapi-template AGENTS.mdpol-lopez/fastapi-template	Instructions file	22	4d ago	MIT	A	921	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

fastapi-template: Instructions file for Codex