Skip to content

Commit af2be40

Browse files
authored
docs: compact CLAUDE.md commands section (#50)
1 parent 0949e88 commit af2be40

1 file changed

Lines changed: 6 additions & 12 deletions

File tree

CLAUDE.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,13 @@ Python 3.14 async REST API. FastAPI + SQLAlchemy 2 (async) + PostgreSQL + Alembi
88

99
## Common commands
1010

11-
The development workflow runs inside Docker via `just`. The `application` service mounts the repo and depends on a `db` Postgres service.
11+
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).
1212

13-
```bash
14-
just # default: install + lint + build + test
15-
just run # alembic upgrade head + start app on :8000
16-
just sh # shell inside the application container
17-
just test [args] # downgrade to base, upgrade, then pytest <args>; brings stack down after
18-
just migration -m "msg" # autogenerate alembic revision against current head
19-
just lint # eof-fixer + ruff format + ruff check --fix + ty check
20-
just build # docker compose build application
21-
just down # docker compose down --remove-orphans
22-
just install # uv lock --upgrade && uv sync --all-extras --all-groups --frozen
23-
```
13+
Things the recipe names don't make obvious:
14+
15+
- `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`.
16+
- `just run` applies migrations then starts the app on :8000.
17+
- `just lint` auto-fixes (eof-fixer + `ruff format` + `ruff check --fix` + `ty check`); CI (below) is the no-fix gate.
2418

2519
Running a single test (inside container or with DB available):
2620

0 commit comments

Comments
 (0)