Docs
VaultCrux documentation
This documentation explains how to use Crux locally, CueCrux Pro in local-first/cloud-only/hybrid mode, and Max private deployments.
Formerly docs.vaultcrux.com. Every page kept its address — /architecture is now /docs/architecture. Deeper technical guides and the defensibility FAQ live on Guides.
Start Here
What VaultCrux is, how to get moving, and what it costs.
- What is VaultCrux?This documentation explains how to use Crux locally, CueCrux Pro in local-first/cloud-only/hybrid mode, and Max private deployments.
- Start HereCrux is the local-first daemon for agents that need auditable outputs. CueCrux Pro adds MemoryCrux, Agent Workbench, collaboration, optional hosted memory, and managed compute without weakening the fr
- Pricing + CreditsCrux pricing and credit usage are designed to keep the local safety baseline free while charging for agent acceleration, collaboration, managed services, and private deployment depth.
For Agents
MCP wiring, auth, and the tool contracts an agent runtime needs.
- For AgentsIf you are integrating VaultCrux into an autonomous workflow, start with these pages.
- Agent QuickstartThis quickstart shows the fastest external path to validate VaultCrux with minimal setup.
- MCP Config SnippetsUse these snippets to connect Claude Desktop, Cursor, or VS Code to VaultCrux MCP.
- MCP ArchitectureVaultCrux v1.2 introduces a dedicated MCP service at VaultCrux/apps/mcp.
- API + AuthVaultCrux uses tenant-scoped API keys persisted in vaultcrux.apikeys.
- Auth ContractSelf-signup sessions authenticate with:
- Skill ContractVaultCrux Sprint 8 adds two public MCP methods under POST /rpc/public.
For Teams
The procurement view: controls, evidence, and commercial shape.
- For TeamsPro includes collaboration and governance for personal and business tenants. Teams can share tenant memory, pool credits, manage seats, and keep offboarding auditable without merging business memory i
- Compliance SummaryThis page summarizes the current VaultCrux compliance posture for customer and procurement conversations.
- Security WhitepaperThis page summarizes the current VaultCrux security model for technical due-diligence and procurement reviews.
- Pricing + CreditsCrux pricing and credit usage are designed to keep the local safety baseline free while charging for agent acceleration, collaboration, managed services, and private deployment depth.
Security & Compliance
Controls, the Shield capability firewall, and receipt verification.
- Security + ComplianceVaultCrux is designed for private data handling with verifiable outputs.
- Shield SecurityVaultCrux Shield is the control layer that evaluates MCP tool calls and sensitive API mutations before execution.
- Compliance SummaryThis page summarizes the current VaultCrux compliance posture for customer and procurement conversations.
- Security WhitepaperThis page summarizes the current VaultCrux security model for technical due-diligence and procurement reviews.
- Receipt VerificationVaultCrux receipts are signed evidence records that allow independent replay and audit of retrieval/proof outcomes.
Core Concepts
How content enters the system, gets ranked, and gets paid for.
- ArchitectureVaultCrux is split into four repos:
- Ingestion1. API accepts POST /v1/ingest and records a queued job in vaultcrux.ingestjobs. 2. Worker claims queued jobs with FOR UPDATE SKIP LOCKED. 3. Worker applies policy gates and PII redaction. 4. Worker c
- RetrievalVaultCrux retrieval combines multiple relevance signals:
- Citation + Credit1. API receives citation intent and writes to vaultcrux.citationstaging. 2. Worker processes staging records asynchronously. 3. Worker writes: - agentcontributions - contributioncitations - agentcredi
- Economy + MarketplaceQuery charging · Balance surface · Conversion (Paddle) · Platform tips · Cross-tenant bundles · Economy metrics
Quickstarts & Examples
Copy-paste runs for residency, proofing, private RAG, and watch.
- Agent Residency QuickstartAgent residency lets a long-running agent maintain continuity across sessions: reading prior context, writing journal events, and detecting stale state. This requires FEATUREAGENTRESIDENCY=true on the
- Document Proofing QuickstartThis quickstart covers uploading a document, triggering a proof job, polling for completion, reading chunks, and retrieving a signed receipt/proofpack.
- Private Team RAG QuickstartThis quickstart covers bootstrapping a tenant, inviting a team member, uploading private documents, and querying the team-scoped corpus.
- Watch QuickstartWatches let you register a query and receive alerts when the corpus answer drifts. This is useful for monitoring policy documents, regulatory content, or any corpus where changes should trigger re-eva
- Proof End-to-EndThis example walks through the full document proofing flow: upload, proof job creation, polling, chunk inspection, receipt retrieval, and proofpack verification. All commands use curl and assume the t
- Watch Drift DetectionThis example shows how to use the watch feature to detect when a corpus change causes a query's answer to drift. The scenario: you ask a question about your data retention policy, register a watch, up
Reference
Headers, endpoints, the OpenAPI document, and what changed when.
- ReferenceOpenAPI · Header glossary · Service status endpoints · Additional references
- OpenAPI JSONThe full OpenAPI 3.0 document for the VaultCrux API.
- Auth ContractSelf-signup sessions authenticate with:
- Skill ContractVaultCrux Sprint 8 adds two public MCP methods under POST /rpc/public.
- Release HistoryThis page tracks immutable SemVer tags used for production-aligned deploys across VaultCrux repos.
- Receipt VerificationVaultCrux receipts are signed evidence records that allow independent replay and audit of retrieval/proof outcomes.
- Docs ChangelogSee Release History for SemVer-tagged release tracking.
Crux Daemon
Thirteen chapters on extending corecruxd. Already published on the library rail — these link straight through.
- IndexChapter of the Crux Daemon developer guide, on the library rail.
- ArchitectureChapter of the Crux Daemon developer guide, on the library rail.
- Integration packsChapter of the Crux Daemon developer guide, on the library rail.
- Capabilities & grantsChapter of the Crux Daemon developer guide, on the library rail.
- Signing & trustChapter of the Crux Daemon developer guide, on the library rail.
- External toolsChapter of the Crux Daemon developer guide, on the library rail.
- WASM extensionsChapter of the Crux Daemon developer guide, on the library rail.
- Connectors & syncChapter of the Crux Daemon developer guide, on the library rail.
- Studio packs & workspacesChapter of the Crux Daemon developer guide, on the library rail.
- Registry & publishingChapter of the Crux Daemon developer guide, on the library rail.
- MCP surfaceChapter of the Crux Daemon developer guide, on the library rail.
- Security modelChapter of the Crux Daemon developer guide, on the library rail.
- TroubleshootingChapter of the Crux Daemon developer guide, on the library rail.