Installation¶

Requirements¶

Python 3.9 or higher
pip (Python package manager)

Install with pip¶

The recommended way to install Klondike is via pip:

pip install klondike-spec

Install a Specific Version¶

For stability, you can pin to a major version:

pip install klondike-spec=="1.*"

Create a Lockfile¶

For reproducible installations across environments:

pip freeze > requirements.txt
pip install -r requirements.txt

Verify Installation¶

After installation, verify Klondike is available:

klondike --help

You should see:

klondike: Manage Klondike Spec agent workflow artifacts: features, sessions, and progress
commands: init, status, feature, session, release, validate, completion, progress, report, import-features, export-features, copilot, mcp
run: klondike <command> [args...]

Shell Completion¶

Enable shell completion for a better CLI experience:

BashZshPowerShell

klondike completion bash >> ~/.bashrc
source ~/.bashrc

klondike completion zsh >> ~/.zshrc
source ~/.zshrc

klondike completion powershell >> $PROFILE
. $PROFILE

Next Steps¶

Now that Klondike is installed, continue to the Quick Start guide to create your first project.