Skip to Content Skip to main content

Documentation

Keep moving.

Install the local core, understand what it records, or inspect the boundary before you wire it into your work.

Quickstart

Three commands. One local memory.

Install the published package, wire the supported agent hooks, then check the whole path.

  1. 01

    Install the package

    npm install -g waykeep
  2. 02

    Initialize agent wiring

    waykeep init
  3. 03

    Run the health check

    waykeep doctor

Read the full installation guide

Architecture at a glance

The local loop comes first.

Hooks and tools record useful context locally. The next session receives a briefing or warning; Team is an optional paid branch.

Visible architecture legend
  1. 1 · Agent hooks and toolsClaude Code and Codex record decisions, corrections, failures, and plans.
  2. 2 · Local memory engineSQLite, full-text search, and local embeddings keep the free core on your machine.
  3. 3 · Next briefing or warningRelevant context returns at session start or before a repeated pitfall.
  4. Optional · Waykeep TeamEligible project memory follows an entitlement-gated hosted sync path.

Truth and limits

Inspect the boundary before adoption.

What Waykeep records

Hooks and MCP tools retain useful records such as pitfalls, decisions, corrections, facts, patterns, goals, and plan state, with provenance.

What stays local

The free core, SQLite database, full-text index, and embeddings run locally. Private-project content is excluded from other project contexts and Team sync.

What Team sync changes

Eligible memory for an enrolled project can flow to entitled members through hosted, eventually consistent sync. Losing entitlement returns clients to local-only operation.

Help

A recovery path when the path is unclear.