Why is this template set to maintenance phase?
Many Flask apps are mature codebases where small, low-risk changes matter most. Switch the phase in the generator if you are building something new.
A Flask web application organized around an application factory and blueprints. Flask gives you little structure for free, so these rules supply it: where code goes, how config loads, and how to keep forms safe.
# AGENTS.md
Project: flask-app. A Flask web application using the app factory pattern, blueprints and SQLAlchemy.
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: Python
- Framework: Flask
- Database: PostgreSQL
- Hosting: Heroku
- Tests: pytest
- Package manager: pip
## Commands
Run these from the repository root.
- Install dependencies: `pip install -r requirements.txt`
- Run locally: `flask --app app run --debug`
- Run all tests: `pytest`
- Run one test file: `pytest tests/test_auth.py -k test_login`
- Lint: `ruff check .`
- Type-check: `mypy app`
- Format: `ruff format .`
## Project layout
- `app/__init__.py`: create_app() application factory
- `app/<blueprint>/`: One blueprint per area: routes, forms, templates
- `app/models.py`: SQLAlchemy models
- `migrations/`: Flask-Migrate (Alembic) migrations
- `tests/`: pytest tests with an app fixture
## Code style
- Indent with 4 spaces. Never tabs.
- Every new or changed Python function has type hints for its parameters and return value.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- 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
- Create the app only through `create_app()`; never create a module-level `app = Flask(__name__)` elsewhere.
- New routes go in a blueprint registered in `create_app()`.
- Access the app inside requests with `current_app`; do not import the app object into modules.
- Configuration comes from environment variables loaded into config classes; `SECRET_KEY` is never hard-coded.
- Every state-changing form uses CSRF protection (Flask-WTF); do not disable it to make a test pass.
- Model changes ship with `flask db migrate -m "..."` output, reviewed and committed.
- Templates rely on Jinja autoescaping; never mark user input `|safe`.
## Project phase
This project is in maintenance. Make minimal, low-risk changes, preserve behavior and public APIs, and explain any change that could affect users.
# 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.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.
# Copilot instructions
Project: flask-app. A Flask web application using the app factory pattern, blueprints and SQLAlchemy.
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: Python
- Framework: Flask
- Database: PostgreSQL
- Hosting: Heroku
- Tests: pytest
- Package manager: pip
## Commands
- Install dependencies: `pip install -r requirements.txt`
- Run locally: `flask --app app run --debug`
- Run all tests: `pytest`
- Run one test file: `pytest tests/test_auth.py -k test_login`
- Lint: `ruff check .`
- Type-check: `mypy app`
- Format: `ruff format .`
## 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.
---
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.
The preset describes a a Flask web application using the app factory pattern, blueprints and SQLAlchemy. Its AGENTS.md is 50 non-empty lines with 7 exact commands, 5 key directories, and 7 stack-specific rules on top of the shared working rules.
pip install -r requirements.txt, flask --app app run --debug, pytest, pytest tests/test_auth.py -k test_login, ruff check ., mypy app, ruff format ..app/__init__.py, app/<blueprint>/, app/models.py, migrations/, tests/.Many Flask tutorials create app at module level. Mixed with an app factory, it produces circular imports and tests that share state. One creation path keeps things predictable.
Importing the app object ties modules to one configuration and breaks testing with different configs. current_app is the request-scoped handle.
When a form test fails because of a missing token, the quick fix is disabling CSRF. That ships a real vulnerability. The rule names this exact shortcut.
Jinja escapes by default; the safe filter turns it off and is the usual source of XSS in Flask apps.
create_app(); never create a module-level app = Flask(__name__) elsewhere.create_app().current_app; do not import the app object into modules.SECRET_KEY is never hard-coded.flask db migrate -m "..." output, reviewed and committed.|safe.Want different commands or rules? Load this preset into the generator, change anything, and download your own set.
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.
All presets are on the stacks page.
Many Flask apps are mature codebases where small, low-risk changes matter most. Switch the phase in the generator if you are building something new.
Flask suits server-rendered sites and simple APIs; FastAPI suits typed JSON APIs with async I/O. Both templates are in the library.
Yes. The factory, blueprint and current_app patterns are unchanged in current Flask releases.
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.
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.
F12, or Cmd+Option+I on a Mac, and select the Network tab.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.