Quickstart

Run Locus in minutes.

Pick your path: containerized MCP, gateway service mode, or source-driven local development. Everything below is tuned for fast first success.

MCP via image

Fastest path for assistant tools and non-code workflows.

docker run --rm -i -v "$PWD/locus-data:/data" ghcr.io/entasislabs/locus-mcp:0.1.0

Gateway via image

Run HTTP and gRPC endpoints for application integration.

docker run --rm -p 8080:8080 -p 8081:8081 -v "$PWD/locus-data:/data" ghcr.io/entasislabs/locus-gateway:2.0.0

Source (dev)

Local runtime for implementation and debugging work.

LOCUS_MCP_IN_MEMORY=true cargo run --manifest-path locus-mcp/Cargo.toml
cargo run --manifest-path locus-gateway/Cargo.toml

SDK examples

Validate core memory composition and provider patterns.

cargo run -p locus-sdk --example provider_registry_setup
cargo run -p locus-sdk --example memory_composition
cargo run -p locus-sdk --example recursive_composite_pipeline

Release-safe baseline

  1. Run workspace checks: cargo check --workspace.
  2. Run tests: cargo test --workspace.
  3. Build SDK examples: cargo check --examples -p locus-sdk.
  4. Use mounted data paths for persistence separation.