# Lorca Documentation

> Lorca is a Grok bot alternative: a Rust CLI for macOS, Linux, and Windows, a native macOS AppKit client, and phone apps. The CLI is a localhost websocket service and the agent loop; the AppKit client is a UI for that...

This is a Grok-Wiki source-grounded repository documentation set. Use the complete Markdown link when an agent needs the full repo context.

## Context Links

- [Complete Markdown docs](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/llms-full.txt)
- [Complete Markdown alias](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6.md)
- [Human interactive docs](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6)
- [GitHub repository](https://github.com/egoist/lorca)

## Repository

- Repository: egoist/lorca

- Generated: 2026-09-26T20:21:57.938Z
- Updated: 2026-09-26T20:38:30.205Z
- Runtime: Grok CLI
- Format: Documentation
- Pages: 18

## Pages

- [Overview](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/01-overview.md): What the project exposes, its primary entry points, runtime assumptions, and links to the highest-value pages.
- [Installation](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/02-installation.md): Prerequisites, install command, first run, the expected success signal, and one recovery note.
- [Quickstart](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/03-quickstart.md): The shortest source-backed path from install to a first successful invocation, with the expected output.
- [Architecture](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/04-architecture.md): The system's main components, boundaries, and data flow as the repository itself documents them.
- [Configuration reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/05-configuration-reference.md): Config keys, environment variables, defaults, required values, and where each one is read.
- [CLI reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/06-cli-reference.md): Commands, flags, arguments, defaults, exit behavior, and examples for the command-line interface.
- [HTTP API reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/07-http-api-reference.md): Routes, methods, request and response shapes, authentication, and error responses.
- [crates/relay reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/08-crates-relay-reference.md): Reference for the code under `crates/relay`: what it exports, how it is invoked, its options and defaults, and its error cases.
- [crates/agent reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/09-crates-agent-reference.md): Reference for the code under `crates/agent`: what it exports, how it is invoked, its options and defaults, and its error cases.
- [crates/cli reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/10-crates-cli-reference.md): Reference for the code under `crates/cli`: what it exports, how it is invoked, its options and defaults, and its error cases.
- [mobile reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/11-mobile-reference.md): Reference for the code under `mobile`: what it exports, how it is invoked, its options and defaults, and its error cases.
- [Data model reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/12-data-model-reference.md): Schemas, entities, fields, relationships, migrations, and validation rules.
- [macos reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/13-macos-reference.md): Reference for the code under `macos`: what it exports, how it is invoked, its options and defaults, and its error cases.
- [web reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/14-web-reference.md): Reference for the code under `web`: what it exports, how it is invoked, its options and defaults, and its error cases.
- [crates/provider-auth reference](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/15-crates-provider-auth-reference.md): Reference for the code under `crates/provider-auth`: what it exports, how it is invoked, its options and defaults, and its error cases.
- [Deployment and operations](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/16-deployment-and-operations.md): Build, containerize, deploy, configure runtime environments, and observe the running system.
- [Testing](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/17-testing.md): How to run the test suites, what they cover, fixtures, and how continuous integration executes them.
- [Changelog and migration](https://grok-wiki.com/public/docs/egoist-lorca-2cf67495e5e6/pages/18-changelog-and-migration.md): Version history, breaking changes, and upgrade steps between versions.

## Source Files

- `.env.example`
- `.github/workflows/release-cli.yml`
- `ARCHITECTURE.md`
- `Cargo.toml`
- `CHANGELOG.md`
- `crates/agent/src/lib.rs`
- `crates/agent/src/types.rs`
- `crates/cli/src/api.rs`
- `crates/cli/src/config.rs`
- `crates/cli/src/lib.rs`
- `crates/cli/src/main.rs`
- `crates/cli/src/model.rs`
- `crates/cli/src/provider_auth.rs`
- `crates/cli/tests/provider_settings.rs`
- `crates/provider-auth/src/lib.rs`
- `crates/relay/Dockerfile`
- `crates/relay/src/db.rs`
- `crates/relay/src/main.rs`
- `crates/relay/src/routes.rs`
- `docs/agent/harness.md`
- `docs/agent/providers.md`
- `docs/releasing-cli.md`
- `docs/releasing-mac.md`
- `macos/Package.swift`
- `macos/Sources/Lorca/App/AppDelegate.swift`
- `macos/Sources/Lorca/App/CLILauncher.swift`
- `macos/Sources/Lorca/main.swift`
- `macos/Sources/Lorca/Model/Protocol.swift`
- `mobile/index.ts`
- `mobile/modules/lorca-core/index.ts`
- `package.json`
- `README.md`
- `web/content/docs/cli.mdx`
- `web/content/docs/get-started.mdx`
- `web/content/docs/index.mdx`
- `web/src/router.tsx`
- `web/src/routeTree.gen.ts`