Lorca Documentation

Pages

1. OverviewWhat the project exposes, its primary entry points, runtime assumptions, and links to the highest-value pages.
2. InstallationPrerequisites, install command, first run, the expected success signal, and one recovery note.
3. QuickstartThe shortest source-backed path from install to a first successful invocation, with the expected output.
4. ArchitectureThe system's main components, boundaries, and data flow as the repository itself documents them.
5. Configuration referenceConfig keys, environment variables, defaults, required values, and where each one is read.
6. CLI referenceCommands, flags, arguments, defaults, exit behavior, and examples for the command-line interface.
7. HTTP API referenceRoutes, methods, request and response shapes, authentication, and error responses.
8. crates/relay referenceReference for the code under `crates/relay`: what it exports, how it is invoked, its options and defaults, and its error cases.
9. crates/agent referenceReference for the code under `crates/agent`: what it exports, how it is invoked, its options and defaults, and its error cases.
10. crates/cli referenceReference for the code under `crates/cli`: what it exports, how it is invoked, its options and defaults, and its error cases.
11. mobile referenceReference for the code under `mobile`: what it exports, how it is invoked, its options and defaults, and its error cases.
12. Data model referenceSchemas, entities, fields, relationships, migrations, and validation rules.
13. macos referenceReference for the code under `macos`: what it exports, how it is invoked, its options and defaults, and its error cases.
14. web referenceReference for the code under `web`: what it exports, how it is invoked, its options and defaults, and its error cases.
15. crates/provider-auth referenceReference for the code under `crates/provider-auth`: what it exports, how it is invoked, its options and defaults, and its error cases.
16. Deployment and operationsBuild, containerize, deploy, configure runtime environments, and observe the running system.
17. TestingHow to run the test suites, what they cover, fixtures, and how continuous integration executes them.
18. Changelog and migrationVersion history, breaking changes, and upgrade steps between versions.