Skip to content

Quick Start

Install

bash
# Codex Git-backed marketplace
codex plugin marketplace add KKenny0/Lode

# Or local development
codex plugin marketplace add ./path/to/Lode

# Verify installation
npx @lode/cli doctor

First Run

Run the cold-start interview once to configure Lode:

/lode:cold-start-interview

This creates ~/.lode/config.yaml with your vault path, project identity, language, and report preferences.

Daily Use

Start a session:

开工

or

/lode:recall

Lode surfaces recent decisions, risks, open questions, and relevant docs from your vault.

End a session:

收工

or

/lode:capture

Lode classifies the session archetype and captures what matters — decisions, risks, abandoned paths, artifact changes.

Periodic Reviews

CommandWhenOutput
/lode:dailyDailyObsidian daily note from raw entries + git history
/lode:weeklyWeeklyWeekly outline with conditional hard-stuff section
/lode:monthlyMonthlyMonthly review + candidate rules from repeated evidence
/lode:roadmapAny timeNarrative decision roadmap with accumulating risks

Configuration

Lode reads config from (in priority order):

  1. {project}/.lode/config.yaml — project-level
  2. ~/.lode/config.yaml — global
yaml
knowledge_vault: /path/to/your/knowledge-vault
project_slug: my-project

profile:
  project_name: My Project
  report_language: mixed
  weekly_mode: tech
  team_context: solo

See the config template for all options.

Zero-Config

Skip the vault entirely. capture outputs structured Markdown right in the conversation. recall works from conversation context alone. You get immediate value from the first session.

Configure a vault later when you want compounding reports.

Last updated:

Released under the MIT License.