# AGENTS.md

Open Source Continuous File Synchronization

## Setup

```
go mod download
```

## Commands

```
go test ./...   # run the test suite
```

## Layout

- `lib/`      378 source files
- `cmd/`      71 source files
- `internal/` 64 source files
- `gui/`      26 source files
- `test/`     19 source files
- `script/`   12 source files

## Conventions

- Tests live alongside the code they cover, following `cmd/infra/stcrashreceiver/sentry_test.go`.
- CI defines what passing means. See `.github/workflows/build-infra-dockers.yaml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `gui/default/syncthing/core/syncthingController.js` is 152KB. 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.