Cyclix documentation

For people who run Cyclix

• How Cyclix works: what Cyclix does, the stages an issue goes through, the work states, and where Cyclix keeps its data.
• Configuration: every key of the tenant config. examples/tenant.toml is the full example.
• Commands: each command and its flags, what it prints, its exit codes, every cyclix check line with its fix, and what cyclix install puts in the service.

For people who work on Cyclix’s code

• Architecture: the principles, which part owns which data, and how the engine is built.
• Engine: the package layout, the state core, the adapters, the state directory, run folders and worktrees, the event log schema, and the sweep.
• Testing: the fake GitHub, the fake agent, the shape check and the sandbox. tests/README.md covers the test layout.
• Isolation: what the agent and the gate can reach, what is built, and what is coming soon.
• The docs site: where the pages live in the repository, and how to preview the site.

The decisions

• Architecture decision records: one short file for each settled call, with the options that were weighed.