Crux Documentation

Start here if you want to install, verify, operate, or integrate the free Crux daemon. Crux is local-first: the daemon, console, HTTP API, and MCP server run on your machine without a hosted account.

First Run

• Getting started - install, boot, connect an agent, store the first fact, and verify a receipt.
• Verify releases - check signatures, SBOMs, images, and SLSA provenance before installing.
• Troubleshooting - common startup, auth, WSL2, and port issues.

Operator Docs

• Operations guide - daemon operation, backups, upgrades, and production-minded checks.
• Incident communications - paid-tenant incident timeline and update templates.
• Release packaging - supported launch artifacts and installer posture.
• Update channel - explicit upgrade behavior and version notifications.
• Testing and coverage - how the release gates and coverage numbers are measured.

Developer and Agent Integration

• Developer portal - OpenAPI, RFC 7807 errors, receipt verification, SDKs, and contracts.
• API reference - HTTP, gRPC, and MCP surfaces.
• BYOK provenance quickstart - locally sign, verify, and retain a sample provenance record without persisting the key.
• Agent guide - using Crux as an agent memory and retrieval backend.
• ExecPlan drift guard - installing and wiring the advisory hooks that keep plan Status: lines aligned with derived state.
• Session handshake - identity, install UUIDs, and session binding.
• MCP system prompt - recommended agent runtime protocol.
• LLM shim - local shim behavior for LLM-facing integrations.

Trust Surface

• Threat model - security assumptions and boundaries.
• Trust Contract - the promises the daemon makes, each verifiable from this repository's source.
• Agent codebase docs - reading order, crate atlas, claims, and invariants for AI agents exploring or modifying this repo.
• Usage receipts - consent-gated, signed usage pings.
• Activity log - signed activity and receipt timelines.
• Benchmarks - reproducible performance baselines.
• Security policy - private vulnerability reporting and supported versions.

More

• Architecture - the daemon's major internal planes.
• Lens cookbook - linking capabilities, tasks, and plans.
• Licence FAQ - practical notes on the CueCrux Community Licence.