From 91a5cf364bb7b6b3d758105272825b71d2e43c13 Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Thu, 25 Jun 2026 19:57:14 +0300 Subject: [PATCH] docs: compact CLAUDE.md commands section --- CLAUDE.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 4225d1a..65f22d4 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -8,19 +8,13 @@ Python 3.14 async REST API. FastAPI + SQLAlchemy 2 (async) + PostgreSQL + Alembi ## Common commands -The development workflow runs inside Docker via `just`. The `application` service mounts the repo and depends on a `db` Postgres service. +The development workflow runs inside Docker via `just` (`just --list` / read the `Justfile` for the full recipe list). The `application` service mounts the repo and depends on a `db` Postgres service. Bare `just` runs the default pipeline (install + lint + build + test). -```bash -just # default: install + lint + build + test -just run # alembic upgrade head + start app on :8000 -just sh # shell inside the application container -just test [args] # downgrade to base, upgrade, then pytest ; brings stack down after -just migration -m "msg" # autogenerate alembic revision against current head -just lint # eof-fixer + ruff format + ruff check --fix + ty check -just build # docker compose build application -just down # docker compose down --remove-orphans -just install # uv lock --upgrade && uv sync --all-extras --all-groups --frozen -``` +Things the recipe names don't make obvious: + +- `just test [args]` recreates a clean DB first (`alembic downgrade base` → `upgrade head`) and tears the stack down afterward; `[args]` are passed through to `pytest`. +- `just run` applies migrations then starts the app on :8000. +- `just lint` auto-fixes (eof-fixer + `ruff format` + `ruff check --fix` + `ty check`); CI (below) is the no-fix gate. Running a single test (inside container or with DB available):