Get Started

Up and running in under 2 minutes. Pick your tool.

1

Install Lodestar

Choose your preferred install method:

npm (recommended)
npm install -g lodestar
Homebrew
brew install lodestar
Binary
curl -fsSL kylex.io/install | sh
2

Run the setup wizard

The wizard configures your AI provider and auto-connects to Claude Code:

lodestar init
The wizard will:
Ask which AI provider you use (Anthropic, OpenAI, or Ollama)
Walk you through API key setup
Validate your key with a test call
Auto-configure Claude Code's MCP settings
Offer to bootstrap your existing project
Install git hooks (optional)
3

Start using it

Three commands — that's the entire workflow:

Start of session — load previous context
lodestar start
Or just tell Claude: "lodestar start"
Mid-session — save a checkpoint
lodestar save
You'll be prompted for optional notes. Hit Enter to skip.
End of session — synthesize + commit
lodestar end
Synthesizes context, commits .lodestar.md, done.
4

Review your project dashboard

See your project status, decisions, and architecture at a glance:

lodestar review

Opens a browser-based dashboard with feature progress, decisions, patterns, and Mermaid architecture diagrams.

+

Optional: Install git hooks

Auto-update feature status on every commit (no LLM cost). Commit .lodestar.md on push.

lodestar hooks
Coming Soon

Cursor Integration

Lodestar works with Cursor today via MCP. A dedicated guide with Cursor-specific setup is coming soon.

Works now — manual MCP config
lodestar init
Select Cursor during tool setup
Coming Soon

VS Code Extension

A VS Code extension with sidebar integration, inline context display, and one-click synthesis is in development.

Want early access? Join Pro Early Access

All Commands

Command What it does
lodestar initFirst-time setup wizard
lodestar startLoad previous session context
lodestar saveMid-session checkpoint (full synthesis)
lodestar endSynthesize + commit — end session
lodestar reviewOpen project dashboard in browser
lodestar bootstrapCapture existing project structure
lodestar hooksInstall git hooks (auto-update on commit)

All commands default to the current directory. No path needed.