Gyre/Reference
Reference
In one minuteLookup material generated from the code — case schema, command line, REST routes, agent tools — plus glossary, bibliography and the authoring guide for this site.
The tables on these pages are produced at build time from the code that is deployed, so they cannot drift.
- Case schemaL2Every field of the case specification with its type, default and, where the model carries one, a description — generated from the pydantic model that validates it. Fields whose description cell is empty are explained in the Cases guide.
- Command-line referenceL2Every `gyre` sub-command with its options, generated from the program itself.
- REST API referenceL2All endpoints of the service, generated from its OpenAPI description. The live, interactive version is served by every deployment at /api/docs.
- MCP tool referenceL2The tools, resources and prompts the agent interface exposes, generated from the server definition.
- GlossaryL1Short definitions of the terms used across this documentation, with pointers to where each is explained.
- BibliographyL2The literature Gyre's methods come from, grouped by topic.
- Authoring guideL2How to write pages for this site: front matter, the four depth levels, callouts, mathematics, code, tabs, charts, tables, status badges, the field viewer and diagrams. Every feature is shown live on this page.