# AGENTS.md

Open source, composable payments platform | PCI compliant | SaaS and Self-host options | Enables connectivity to multiple payment, payout, fraud, vault and tokenization providers | Uplifts authorization with intelligent routing and revenue recovery | Reduce payment processing costs with cost observability | Reduces payment ops with reconciliation

## Setup

```
npm ci
```

## Commands

```
make check         # lint and type check
make build         # produce a build
make doc
make fmt
make clippy
make euclid-wasm
```

## Layout

- `postman/`                  2427 source files
- `crates/`                   2116 source files
- `migrations/`               1038 source files
- `cypress-tests/`            273 source files
- `v2_compatible_migrations/` 48 source files
- `cypress-tests-v2/`         22 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/validate-openapi-spec.yml`.
- CI defines what passing means. See `.github/workflows/CI-pr.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `crates/router/src/core/payments.rs` is 629KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.