Browse documentation

Start here

First walkthrough

Create a project, start a session, save context, and resume work.

On this page

Start The Local App#

text
corepack pnpm dev

Open:

text
http://127.0.0.1:5174/

The normal single-user workflow starts both local processes and requires no token, launcher, or profile setup. The browser UI contains the complete React interface. See Setup and Browser UI.

Native Tauri window:

text
pnpm dev:desktop

Use dev for daily browser-based use or development. Use dev:desktop when you want the same UI in a Tauri window with OS folder picker support.

UI First Run#

For a multi-repo product:

  1. Open Setup.
  2. Choose Project only.
  3. Enter the project name and preview it.
  4. Create the project.
  5. The app opens Repos.
  6. Link each Git repo root.
  7. Open Import.
  8. Preview old memory folders with Memory Docs.
  9. Preview old session folders with Session History.
  10. Commit only after the preview counts and samples look right.
  11. Open Work -> Sessions and enable Include in graph only for imported sessions important enough to belong in the project map.

Create Project Memory#

text
pnpm dev:cli init --name "My App" --project-only --no-pointer

This creates:

  • memory workspace under the configured memory root
  • default Markdown project documents
  • project registry entry

For a single-repo project, you can also create the project and link one repo in one step:

text
pnpm dev:cli init <repo-root> --name "My App" --bootstrap AGENTS.md,CLAUDE.md
text
pnpm dev:cli link-repo <repo-root> --project my-app --name "Service API" --role service
pnpm dev:cli repos --project my-app

Import Existing Markdown#

Preview imports before committing them:

text
pnpm dev:cli import-folder <old-memory-folder> --project my-app --profile markdown-memory
pnpm dev:cli import-folder <old-sessions-folder> --project my-app --profile markdown-sessions

After the preview looks right, commit the reviewed import:

text
pnpm dev:cli import-folder <old-memory-folder> --project my-app --profile markdown-memory --commit
pnpm dev:cli import-folder <old-sessions-folder> --project my-app --profile markdown-sessions --commit

Start Session#

text
pnpm dev:cli start "Fix settings page save bug" --project my-app --agent codex

Preview Context#

text
pnpm dev:cli context --project my-app --preview

Save Checkpoint#

text
pnpm dev:cli checkpoint --project my-app --session session-id "Implemented the save flow and found a validation gotcha"

Close Session#

text
pnpm dev:cli close --project my-app --session session-id "Save bug fixed; next step is regression coverage"

Closed sessions remain searchable history. In the UI, Include in graph is off by default; enable it from Work -> Sessions only for sessions that should create graph nodes and derived relationships.

Review Memory Inbox#

text
pnpm dev:cli inbox --project my-app

Manage Deletes In The UI#

The UI moves deletions to Trash first for projects, linked repo entries, workstreams, sessions, docs, inbox proposals, and backup snapshots. Open Trash to restore an item or permanently delete it.

Search Project Memory#

text
pnpm dev:cli search --project my-app "settings save"

MCP Startup Flow#

Status: implemented. The following is the supported daily Codex/MCP flow.

An external agent should call:

text
memory.get_startup_state

Then:

text
memory.start_session
memory.search
memory.get_session_detail
memory.preview_context_bundle
memory.get_context_bundle
memory.save_checkpoint
memory.close_session

If startup reports an unregistered repo, create or link it through the UI or CLI, then retry. Project creation and durable-memory administration are not MCP tools.

Normal session and context calls are project-scoped by default. Project memory is AI-visible by default; explicit exclusions and secret checks still apply.