ferryGL documentation
The README explains what ferryGL does and how it works. These pages cover the details.
| Page | Read it when you want to |
|---|---|
| Getting started | Install ferryGL, set up its credentials, and do a careful first run |
| Configuration | Look up a setting in ferrygl.toml, or have your editor check the file |
| Sync rules | Know which items are synced, how they map to Linear issues, and how statuses move |
| Commands | Read check and sync output, run on a schedule or from VS Code, or fix an error |
| Data and privacy | Check what ferryGL reads, writes to Linear, and keeps |
| Architecture | Understand how a run works inside, its request costs, retries and limits |
Contributors should also read AGENTS.md.