Get started

Prerequisites

Git, Claude Code, and Go (or download a binary from the releases page).

Install

go install github.com/markwharton/plankit/cmd/pk@latest

Setup your project

cd your-project
pk setup

This creates a CLAUDE.md with critical rules, installs guidelines as .claude/rules/ files, adds skills for changelog, release, plan preservation, and project initialization, and writes a bootstrap script that fetches pk into cloud sandboxes. Restart Claude Code to apply changes.

Then run /init in Claude Code to add project-specific conventions. It analyzes your codebase, asks about branch protection, and proposes a ## Project Conventions section for your CLAUDE.md.

Try it

Start Claude Code in your project and try the core loop:

• /plan Enter plan mode. Claude explores the codebase, proposes an approach. You review and approve. The plan is preserved to docs/plans/ — timestamped, committed, protected.
• /changelog Generate a changelog from conventional commits. Preview with --dry-run, confirm, then commit. The version is carried as a Release-Tag: trailer — no git tag yet.
• /release Read the trailer, create the git tag, merge to the release branch, push. Pre-flight checks run first. One command, fully validated.

Commands

• pk setup Configure hooks, skills, rules, and CLAUDE.md for your project.
• pk status Report what’s installed — setup state, configured hooks, and modified files.
• pk teardown Remove plankit from a project (preview by default, --confirm to execute).
• pk changelog Generate CHANGELOG.md from conventional commits and commit the result.
• pk release Tag, merge to the release branch, validate, and push.
• pk version Print version and check for updates.

Hook commands (pk guard, pk pin, pk preserve, pk protect) run automatically — triggered by Claude Code or by other pk commands. You don’t invoke them directly. Full command documentation is on GitHub.