Skip to main content

Installation

Users can install the Knowledge Management Graph using a universal installer — a single markdown file that any AI assistant can execute for automated setup.


How It Works

The universal installer detects the platform (Claude Code, Cursor, Windsurf, Continue.dev, JetBrains, VS Code, Aider, or other AI assistants), configures the appropriate components, and initializes a knowledge graph automatically.

Installation takes approximately 5 minutes.


Get the Installer

Important: Use the Raw File

This page shows a preview of the installer. To actually install, copy and paste the raw markdown file into an AI assistant. → Get the raw installer file

  • Click the link above
  • Select all text (Ctrl+A / Cmd+A)
  • Copy to clipboard (Ctrl+C / Cmd+C)
  • Paste into Claude, ChatGPT, Cursor, or any AI assistant
  • Follow the assistant's instructions

For Claude Code Users

Claude Code Quick Start

Claude Code users can follow a manual setup walkthrough instead: → Claude Code Setup Guide Or paste the universal installer above for the same automated experience.


Not using Claude Code?

The commands/, skills/, agents/, and hooks/ directories in this repo are loaded exclusively by the Claude Code plugin system. Do not copy these directories if using Cursor, Windsurf, Continue.dev, JetBrains, VS Code, or any other tool — they will not work outside the plugin system. All cross-platform functionality is provided through the MCP server as kg_* tools.

Platform Capabilities

Users can install on multiple platforms with varying automation levels:

PlatformAutomationHow to Install
Claude CodeFull automationPaste installer (recommended) or follow Getting Started
CursorMedium (MCP tools)Paste installer; MCP server handles data layer
WindsurfMedium (MCP tools)Paste installer; MCP server handles data layer
Continue.devMedium (MCP tools)Paste installer; MCP server handles data layer
JetBrains IDEMedium (MCP tools)Paste installer; configure in Settings → Tools → AI Assistant
VS CodeMedium (MCP tools)Paste installer; MCP server handles data layer
Claude DesktopMedium (MCP tools)Paste installer; configure in Desktop settings
AiderLow (manual workflows)Paste installer; follow templates manually
GitHub CopilotLow (manual workflows)Paste installer; follow templates manually

What Gets Installed

The installer sets up:

  • Configuration file~/.claude/kg-config.json (stores knowledge graph locations and metadata)
  • Directory structureknowledge/, lessons-learned/, decisions/, sessions/, chat-history/
  • Identity filesknowledge/me.md (contributor identity, gitignored), knowledge/rules.md (project conventions, committed), and knowledge/triggers.md (rule timing, when each rule applies). See Portable AI Identity.
  • Wiki links — Cross-references throughout the KG are converted to Obsidian [[wiki link]] format, enabling graph view navigation in Obsidian and compatible editors
  • MCP server — Provides knowledge graph tools for non-Claude-Code platforms
  • Templates — Starter scaffolds for capturing lessons and decisions

Upgrade Checks

When running /kmgraph:init on an existing installation, the wizard inspects your setup and reports what it finds:

CheckWhat it looks for
a. DirectoriesMissing subdirectories (knowledge/, decisions/, sessions/, etc.)
b. Config fieldsMissing fields in ~/.claude/kg-config.json introduced in newer versions
c. TemplatesTemplate files that have been updated or added since your install
d. Platform splitClaude-specific tool directives in knowledge/rules.md that belong in CLAUDE.md
e. Wiki passBare ADR-NNN, ENH-NNN, #NNN, and lesson filename references not yet converted to [[wiki links]] — runs once per KG, skipped on re-run if already complete
f. Docs migrationdocs/enhancements/ or docs/issues/ subdirectories that should be moved into the knowledge graph structure
g. FTS5 cleanupStale in-project FTS5 index files (knowledge/fts5/) left behind by older versions
h. Identity scaffoldMissing me.md, rules.md, or triggers.md — presents a dry-run preview, scans existing platform files (CLAUDE.md, GEMINI.md, .cursorrules, etc.), README, ADRs, and sessions to pre-populate recommendations, then archives any originals before writing
Re-running the wizard

/kmgraph:init is safe to re-run at any time. It skips steps already complete and only offers items still pending for your install.


Next Steps

After installation, users can:

  1. Capture a lesson — Document a problem solved, pattern learned, or decision made
  2. Create architecture decisions — Record important design choices
  3. Search knowledge — Find lessons and patterns across sessions
  4. Sync knowledge — Automatically extract and organize captured content

See Getting Started for detailed walkthroughs.


Having Issues?

  • Installation failed? Paste the full error message into the installer file's troubleshooting section
  • MCP tools not visible? Restart the IDE after configuring the MCP server
  • Config file not found? Run the installer again to create it

See FAQ for additional help.