Docs for onboarding, operating, and extending Lattice OS
New users get a clear path from install to first memory-aware workspace. Power users get direct entry points for Docker appliance deployment, V3 licensing, air-gapped operation, Enterprise rollout, route verification, and incident debugging.
Onboarding-first
Maps the fastest route through beta tracks, CLI install, license activation, deployment, and first useful workspace.
Appliance-ready
Explains the Docker appliance path, preflight validation, health checks, backups, upgrades, and rollback workflows.
Security-aware
Makes trust boundaries, public routes, workspace isolation, and cryptographic license verification explicit.
New user path
If someone just received access, this is the shortest path from zero context to a working local Lattice OS instance.
Pick the right track
New testers should start with the beta track that matches their intent: quick evaluation, source build, enterprise rollout, or privacy/compliance review.
Open beta tracksInstall the lattice CLI
The CLI manages auth, license activation, Docker appliance deployment, preflight checks, logs, backups, and upgrades.
curl -sL https://raw.githubusercontent.com/invidias-codem/ai-saas/main/scripts/lattice-cli/install.sh | bash
lattice --versionActivate licensing and initialize
V3 licenses are ed25519-signed and verified locally, so Enterprise features can unlock without a phone-home dependency.
lattice license activate <lattice-v3-key>
lattice deploy init --name beta --tier enterpriseRun preflight, deploy, then smoke test
Deployment starts with Docker, Compose v2, resources, ports, disk, auth, and license checks. Finish by creating a workspace and verifying memory-aware chat.
lattice deploy start --name beta
lattice health check --instance betaHow to use this docs set
New users
Start with the beta track picker, install the CLI, deploy locally, create a workspace, and verify the first memory-aware conversation.
Developers
Use the architecture, reference, CLI, and source-file map docs to understand where behavior lives and how the major subsystems fit together.
Operators
Use truth surfaces, deployment, preflight, route verification, and incident debugging docs to diagnose live-system issues more reliably.
Power users
Use the recipe cards to jump straight to niche flows: air-gapped deployments, custom registries, Enterprise rollout, backups, and rollback.
Power-user recipes
For niche questions, start from the recipe that matches the job instead of reading the docs linearly.
Self-hosted Docker appliance
Use the CLI and deployment docs when you need a single-server install with explicit data-residency control.
Air-gapped / regulated environment
Use local license verification, pre-loaded Docker images, no-egress configuration, and audit-oriented health evidence.
Enterprise rollout
Understand workspace-as-project isolation, Enterprise feature gates, SSO/RBAC expectations, backup cadence, and rollback paths.
Debug a weird route or runtime issue
Start from truth surfaces, verify public/protected boundaries, then use request examples and source maps to find the owning code path.
Overview
Start here for the high-level platform story, technology transparency, and positioning.
Documentation Index
The backbone index for the repository documentation system and the best place to see what exists today.
docs/README.mdView source Technology Transparency
Explicit explanation of the stack, hosting surfaces, AI/runtime layers, and major product boundaries.
docs/overview/technology-transparency.mdView source SEO Strategy
How Lattice OS should talk about memory-native AI, hybrid inference, and workspace intelligence for search and discovery.
docs/overview/seo-strategy.mdView source Onboarding
Guided paths for beta testers, developers, enterprise evaluators, and privacy-focused teams.
Beta Track Picker
Choose between Quick Start, Developer, Enterprise, and Privacy & Compliance onboarding paths.
Quick Start
15-minute path from CLI install to first workspace and first memory-aware conversation.
Developer Track
Source builds, custom registries, CI deployment stubs, and standalone binary builds.
Enterprise Track
Licensing, workspace isolation, SSO/RBAC expectations, backups, health checks, upgrades, and rollback.
Privacy & Compliance Track
Air-gapped deployment pattern for regulated environments where data cannot leave the network.
CLI & Appliance
Manage Lattice OS as an installable Docker appliance with local preflight checks and cryptographic licensing.
lattice-cli Command Reference
Install options, auth, deploy, health, upgrade, backup, restore, and configuration reference for lattice-cli v0.3.0.
scripts/lattice-cli/README.mdView source V3 Cryptographic Licensing
ed25519-signed license payloads with embedded public-key verification for offline-capable Enterprise activation.
scripts/lattice-cli/lattice_cli/crypto_license.pyView source Self-Hosted Topology
How the app, database, storage, auth, and optional workers fit together in self-hosted installs.
docs/operations/self-hosted-topology.mdView source Self-Hosted Preflight Checklist
The practical preflight and smoke-test checklist for deciding whether a fresh install is usable.
docs/operations/self-hosted-preflight-checklist.mdView source Architecture
Understand how Lattice OS is structured and where the platform is headed.
System Architecture
High-level system layers, trust zones, and request flow.
docs/architecture/system-architecture.mdView source Runtime Mode Routing
How the server resolves effective runtime behavior from context instead of trusting client toggles.
docs/architecture/runtime-mode-routing.mdView source Memory and Context Architecture
Prepared context, layered memory direction, and why raw history is not enough.
docs/architecture/memory-and-context-architecture.mdView source Workspace and Operating Profile Model
Why workspace is the primary container and operating profile is the behavior-shaping layer.
docs/architecture/workspace-operating-profile-model.mdView source Retrieval and Graph Strategy
How retrieval and future graph-aware systems support structured context assembly.
docs/architecture/retrieval-and-graph-strategy.mdView source Security
Make route visibility, trust boundaries, and authority models explicit.
Public Routes
Which routes are intended to remain public and how route gating is actually enforced.
docs/security/public-routes.mdView source Trust Boundaries
The platform’s major trust zones across public users, authenticated users, backend jobs, integrations, and operators.
docs/security/trust-boundaries.mdView source License Verification Boundary
Power users can inspect the public-key verification path without exposing the private signing key.
scripts/lattice-cli/lattice_cli/crypto_license.pyView source Operations
Operational discipline for deployment, verification, and debugging in a multi-surface platform.
Truth Surfaces
How to choose the right evidence source when code, CI, deploy logs, and runtime disagree.
docs/operations/truth-surfaces.mdView source Deployment
How code moves from repo state to live runtime and what to verify along the way.
docs/operations/deployment.mdView source Deployment Modes
Official business deployment modes and the recommended support order for self-hosted adoption.
docs/operations/deployment-modes.mdView source Route Verification Checklist
Checklist for validating public, protected, localized, and API-dependent routes.
docs/operations/route-verification-checklist.mdView source Incident Debugging
A practical method for classifying incidents, choosing truth surfaces, and narrowing failure boundaries.
docs/operations/incident-debugging.mdView source Reference
Concrete developer-facing reference material for APIs, environment configuration, and repo navigation.
API Reference
Human-readable map of important API surfaces, public/protected boundaries, and debugging notes.
docs/reference/api-reference.mdView source Environment Variables
Public vs server-only configuration surfaces and the major variables that shape runtime behavior.
docs/reference/environment-variables.mdView source Request and Response Examples
Concrete payload examples for important API routes.
docs/reference/request-response-examples.mdView source Source File Map
Where important route, runtime, auth, and subsystem files live in the repository.
docs/reference/source-file-map.mdView source Decisions
Architectural decision records that capture why the platform evolved the way it did.
Current ADR Set
Covers workspace-first architecture, server-resolved runtime routing, prepared context, public/authenticated boundary separation, deploy truth vs runtime truth, and more.
docs/decisions/View source