Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Agent guide

Conventions for AI-assisted development in this repository. See [development.md](./development.md), [backend/README.md](./backend/README.md), and [frontend/README.md](./frontend/README.md) for full setup details.

## Non-interactive commands

Use these shell commands for CI-parity build and test (no prompts). Mirrors [.github/workflows/test-backend.yml](./.github/workflows/test-backend.yml) and lint hooks in [development.md](./development.md).

```bash
docker compose up -d db mailcatcher
cd backend && uv run bash scripts/prestart.sh && uv run bash scripts/tests-start.sh
uv run prek run --all-files
```

Run `uv run prek run --all-files` from the repository root. Run the `docker compose` and `backend` steps from the repository root as well.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,8 @@ Deployment docs: [deployment.md](./deployment.md).

General development docs: [development.md](./development.md).

Agent / CI-parity commands: [AGENTS.md](./AGENTS.md) (non-interactive build and test).

This includes using Docker Compose, custom local domains, `.env` configurations, etc.

## Release Notes
Expand Down