Store Claude Code plans in Inkdrop for better readability and progress tracking
This is a fork of everything-claude-code that integrates with Inkdrop, a markdown note-taking app, to persist plans and track execution progress.
When Claude Code creates a plan, it displays in the terminal. But terminal output is hard to read for complex plans with multiple phases, code snippets, and detailed steps.
By storing plans in Inkdrop, you get:
- Beautiful markdown rendering - Plans are much easier to read with proper formatting, syntax highlighting, Mermaid diagrams, and LaTeX math blocks
- Easy to edit - Modify the plan before confirming, add notes, or adjust steps directly with the robust Markdown editor in Inkdrop
- Multi-device review - Review and edit plans from any device, including your phone
- Revision history - Track exactly when work started, what changed, and when it completed, with Inkdrop's revision history
- Progress tracking - Watch checkboxes get ticked off and status updates appear in real-time
- Request a plan - Run the
/plancommand with your task description - Plan is created - Claude Code analyzes the codebase and generates a detailed implementation plan
- Saved to Inkdrop - The plan is automatically saved as a note with status
none - Review and confirm - Read the plan in Inkdrop's markdown renderer, then confirm to proceed
- Execution begins - Status changes to
active, work starts - Progress updates - Checkboxes are checked off, deviations annotated, blockers noted
- Completion - Status changes to
completed, outcome section appended
Plans are stored with YAML frontmatter containing:
---
projectDir: /path/to/your/project
description: Brief summary of what the plan accomplishes
gitBranch: feature-branch (optional)
---| Status | Meaning |
|---|---|
none |
Plan created, awaiting confirmation |
active |
Work in progress |
completed |
Successfully finished |
onHold |
Blocked or paused |
dropped |
Abandoned |
Plans can include:
- Codeblock attributes - Show line numbers, filenames, commit hashes, and URLs
- Mermaid diagrams - Visualize architecture and flow
- LaTeX math - Document algorithms and calculations
See commands/plan.md for syntax examples.
This fork modifies three files from the original repository:
| File | Change |
|---|---|
rules/note-taking.md |
NEW - Core rules for Inkdrop integration |
agents/planner.md |
Added mcp__inkdrop__* tools for note access |
commands/plan.md |
Added Inkdrop codeblock syntax tips |
- Claude Code CLI installed
- Inkdrop - v5 or v6
- Inkdrop MCP server configured
-
Set up the Inkdrop MCP server following the instructions
-
Copy the rule file to your Claude Code rules directory:
cp rules/note-taking.md ~/.claude/rules/ -
Copy the modified agent and command (optional, for enhanced planning):
cp agents/planner.md ~/.claude/agents/ cp commands/plan.md ~/.claude/commands/
Edit rules/note-taking.md and update the notebook name to match your Inkdrop setup:
Store notes in the notebook `<NODEBOOK_NAME>`.If you'd like to specify by notebook ID instead, use the dev-tools plugin to quickly copy the ID.
You can find your notebook ID in Inkdrop's developer tools or by using the MCP server's list-notebooks tool.
This fork maintains the same structure as the original. Key directories:
agents/ # Specialized subagents (planner modified for Inkdrop)
commands/ # Slash commands (/plan modified for Inkdrop)
rules/ # Always-follow guidelines (note-taking.md added)
skills/ # Workflow definitions
hooks/ # Trigger-based automations
See the original repository for the complete structure and documentation.
This project is a fork of everything-claude-code by Affaan Mustafa, winner of the Anthropic Hackathon. The original repository provides production-ready Claude Code configurations developed over 10+ months of intensive use.
- everything-claude-code - Original repository
- Inkdrop - Markdown note-taking app
- Inkdrop MCP Server - MCP server for Inkdrop integration
- Claude Code Documentation - Official docs