CLI tool for managing Klondike Spec agent workflow artifacts
Project description
๐ด Klondike Spec CLI
The CLI that built itself โ A tool for managing AI agent workflows, created through the very methodology it implements.
๐ The Story: When AI Builds Its Own Tools
What happens when you ask an AI coding agent to build a tool for managing AI coding agents?
You get Klondike Spec CLI โ a project that went from concept to 100% feature completion in just 4 coding sessions, with the AI agent using the very methodology and artifacts the tool was designed to manage.
The Challenge
Modern AI coding agents like GitHub Copilot are powerful, but they face a fundamental limitation: context windows reset between sessions. Every new conversation starts fresh, losing the accumulated knowledge, decisions, and progress from previous work.
Anthropic's research on effective harnesses for long-running agents highlighted this challenge and inspired a solution: structured artifacts that bridge context windows.
The Solution: Klondike Spec
The Klondike Spec framework provides:
- ๐ A feature registry that prevents "victory declarations" (agents claiming completion prematurely)
- ๐ A progress log for session-to-session handoffs
- โ Verification evidence requirements before features can be marked complete
- ๐ Structured workflows that guide agents through complex, multi-session projects
๐ Python-First: Klondike Spec is currently optimized for Python development workflows, with built-in support for
uv,pytest,ruff, and modern Python tooling. The instructions and CI/CD patterns assume a Python project structure. Contributions to support other ecosystems are welcome!
The Meta-Journey
This CLI tool was built by an AI agent following the Klondike Spec methodology โ tracking its own features, managing its own sessions, and providing verification evidence for each completed feature. The dog ate its own dog food, and it was delicious.
40 features. 7 sessions. 142 tests. 100% verified.
โก Built with Pith: Agent-Native CLI Design
Klondike Spec CLI is powered by Pith โ a revolutionary CLI framework designed specifically for AI agents.
Unlike traditional CLI frameworks that prioritize human interaction patterns, Pith implements progressive discovery:
Tier 1: pith โ Overview of all commands
Tier 2: command โ Synopsis and usage
Tier 3: command --help โ Full documentation
AI agents can efficiently navigate the CLI surface, discovering exactly what they need without overwhelming context. Pith also supports:
- ๐ฏ Semantic intents โ Commands can be invoked by meaning, not just exact syntax
- ๐ Structured output โ JSON mode for programmatic integration
- ๐ง Schema export โ Full command structure for AI tooling
๐ Installation
Global Installation (Recommended)
Install klondike as a globally available command using uv or pipx:
# Using uv (fastest)
uv tool install klondike-spec-cli
# Using pipx
pipx install klondike-spec-cli
This makes the klondike command available system-wide, isolated from your project dependencies.
Project Dependency
Add to your project's dependencies:
# Using uv
uv add klondike-spec-cli
# Using pip
pip install klondike-spec-cli
๐ฏ Quick Start
Initialize Your Project
# Create .klondike directory and .github templates
klondike init my-awesome-project
# Skip .github scaffolding if you already have it
klondike init my-awesome-project --skip-github
# See where you stand
klondike status
๐ Project: my-awesome-project v0.1.0
Completion: 0.0%
Progress: [โโโโโโโโโโโโโโโโโโโโ] 0.0%
โณ Not Started 0
๐ฏ Ready to add features!
Define Your Features
# Add features with acceptance criteria
klondike feature add -d "User authentication" -c core -p 1 \
--criteria "Login form works,Password validation,Session management"
klondike feature add -d "Dashboard UI" -c ui -p 2 \
--criteria "Responsive layout,Data visualization,Real-time updates"
# See your feature backlog
klondike feature list
Work Through Features
# Start a coding session
klondike session start --focus "F001 - User authentication"
# Mark what you're working on
klondike feature start F001
# When complete with evidence
klondike feature verify F001 --evidence "All tests pass, demo video recorded"
# End the session
klondike session end --summary "Auth complete" --completed "Login,Logout,Sessions"
Track Progress Across Sessions
# Check overall status (includes git info!)
klondike status
๐ Project: my-awesome-project v0.1.0
Completion: 50.0%
Progress: [โโโโโโโโโโโโโโโโโโโโ] 50.0%
โ
Verified 1
โณ Not Started 1
๐
Last Session: #1 (2025-12-07)
Focus: F001 - User authentication
๐ Git Status: โ
Clean (branch: main)
Recent commits:
abc123 2025-12-07 feat(auth): implement user login
๐ฏ Next Priority Features:
โณ Not started F002: Dashboard UI
๐ Complete Command Reference
Project Commands
| Command | Description |
|---|---|
klondike init [name] |
Initialize .klondike directory and .github templates |
klondike init --skip-github |
Initialize without .github scaffolding |
klondike status |
Show project status, git info, and next priorities |
klondike validate |
Check artifact integrity and consistency |
klondike progress |
Regenerate agent-progress.md from JSON |
klondike report |
Generate detailed status report |
klondike release [version] |
Automate version bumping and release tagging |
Feature Management
| Command | Description |
|---|---|
klondike feature add |
Add a new feature with description and criteria |
klondike feature list |
List features with optional status filter |
klondike feature show <id> |
Display full feature details |
klondike feature start <id> |
Mark feature as in-progress |
klondike feature verify <id> |
Mark as verified with evidence |
klondike feature block <id> |
Mark as blocked with reason |
klondike feature edit <id> |
Edit notes, criteria, priority |
Session Management
| Command | Description |
|---|---|
klondike session start |
Begin session (validates artifacts, shows status) |
klondike session end |
End session with summary and handoff notes |
AI Agent Integration
| Command | Description |
|---|---|
klondike copilot start |
Launch GitHub Copilot CLI with klondike context |
klondike mcp serve |
Start MCP server for AI agent integration |
klondike mcp install |
Generate MCP server config for VS Code |
klondike mcp config |
Output MCP configuration JSON |
Import/Export
| Command | Description |
|---|---|
klondike import-features <file> |
Import features from YAML/JSON |
klondike export-features <file> |
Export features to YAML/JSON |
Shell Completion
# Bash
klondike completion bash >> ~/.bashrc
# Zsh
klondike completion zsh > ~/.zsh/completions/_klondike
# PowerShell
klondike completion powershell >> $PROFILE
๐ Project Structure
After running klondike init, your project will have:
your-project/
โโโ .klondike/
โ โโโ features.json # ๐ Feature registry (source of truth)
โ โโโ agent-progress.json # ๐ Session log and handoffs
โ โโโ config.yaml # โ๏ธ CLI configuration
โโโ agent-progress.md # ๐ Generated human-readable progress
โโโ .github/
โโโ copilot-instructions.md # ๐ค Agent behavior rules
โโโ instructions/ # ๐ Workflow instruction files
โ โโโ git-practices.instructions.md
โ โโโ session-artifacts.instructions.md
โ โโโ testing-practices.instructions.md
โโโ prompts/ # ๐ฌ Reusable prompt templates
โ โโโ add-features.prompt.md
โ โโโ progress-report.prompt.md
โ โโโ recover-from-failure.prompt.md
โ โโโ session-end.prompt.md
โ โโโ session-start.prompt.md
โ โโโ verify-feature.prompt.md
โโโ templates/ # ๐ Init scripts and schemas
โโโ agent-progress.template.md
โโโ features.schema.json
โโโ init.ps1
โโโ init.sh
Tip: Use
--skip-githubif your project already has a.githubdirectory you want to preserve.
๐ง Configuration
.klondike/config.yaml:
# Default category for new features
default_category: core
# Default priority (1=critical, 5=nice-to-have)
default_priority: 2
# Who verifies features
verified_by: coding-agent
# Where to generate the markdown progress file
progress_output_path: agent-progress.md
# Auto-regenerate markdown on changes
auto_regenerate_progress: true
๐ค Integration with Klondike Spec Framework
This CLI is designed to work seamlessly with the Klondike Spec prompting framework for GitHub Copilot.
The framework provides:
- ๐ Copilot instructions that embed agent behavior rules
- ๐ฌ Slash commands (
/session-start,/session-end,/verify-feature) - ๐ Templates for consistent project structure
The CLI handles artifact manipulation. The framework guides agent behavior.
Together, they enable sophisticated multi-session agent workflows that maintain coherence across context window resets.
๐งช Development
# Clone and setup
git clone https://github.com/ThomasRohde/klondike-spec-cli.git
cd klondike-spec-cli
uv sync
# Run tests (142 tests)
uv run pytest -v
# Lint and type check
uv run ruff check .
uv run mypy src
# Build
uv build
Project Stats
- 40 features โ all verified with evidence
- 142 tests โ comprehensive coverage
- 7 sessions โ iterative development
- 4200+ lines of well-structured Python
๐ด Why "Klondike"?
Like the classic card game, building complex software with AI agents requires patience, strategy, and careful arrangement of moving pieces. You can't just pile cards randomly โ you need structure, rules, and a clear view of your progress.
Klondike Spec provides that structure. The CLI gives you the tools to maintain it.
๐ License
MIT โ See LICENSE for details.
๐ Related Projects
- Klondike Spec โ The prompting framework for GitHub Copilot
- Pith โ Agent-native CLI framework with progressive discovery
Built with ๐ค by AI, for AI, verified by humans
"The best way to predict the future is to build the tools that build the future."
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file klondike_spec_cli-0.2.9.tar.gz.
File metadata
- Download URL: klondike_spec_cli-0.2.9.tar.gz
- Upload date:
- Size: 193.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1b4bd88e957a6986bcbd3273e9373817b3a63c1d5cf595f01d9290f1837f8b16
|
|
| MD5 |
7f233cfeb63f1cc2c70c9ccae74823b9
|
|
| BLAKE2b-256 |
489e403d2d35f75e622adbef6f807470afd47c01a7da15d000429d7adf944141
|
Provenance
The following attestation bundles were made for klondike_spec_cli-0.2.9.tar.gz:
Publisher:
publish.yml on ThomasRohde/klondike-spec-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
klondike_spec_cli-0.2.9.tar.gz -
Subject digest:
1b4bd88e957a6986bcbd3273e9373817b3a63c1d5cf595f01d9290f1837f8b16 - Sigstore transparency entry: 748532586
- Sigstore integration time:
-
Permalink:
ThomasRohde/klondike-spec-cli@bbe9a606c30c34317c90a0afd57429b995c3afd7 -
Branch / Tag:
refs/tags/v0.2.9 - Owner: https://github.com/ThomasRohde
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@bbe9a606c30c34317c90a0afd57429b995c3afd7 -
Trigger Event:
push
-
Statement type:
File details
Details for the file klondike_spec_cli-0.2.9-py3-none-any.whl.
File metadata
- Download URL: klondike_spec_cli-0.2.9-py3-none-any.whl
- Upload date:
- Size: 79.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
791aa8dba5dd744327627354407c512b9c51d5987fd35f698f60522cfbcd35bf
|
|
| MD5 |
24a4fe346f5907fe7b7c12fe367b1f2d
|
|
| BLAKE2b-256 |
f0a6f8ca13473f869f5a1e3c0f72607672a66146f232b44b224dff80501d4da7
|
Provenance
The following attestation bundles were made for klondike_spec_cli-0.2.9-py3-none-any.whl:
Publisher:
publish.yml on ThomasRohde/klondike-spec-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
klondike_spec_cli-0.2.9-py3-none-any.whl -
Subject digest:
791aa8dba5dd744327627354407c512b9c51d5987fd35f698f60522cfbcd35bf - Sigstore transparency entry: 748532588
- Sigstore integration time:
-
Permalink:
ThomasRohde/klondike-spec-cli@bbe9a606c30c34317c90a0afd57429b995c3afd7 -
Branch / Tag:
refs/tags/v0.2.9 - Owner: https://github.com/ThomasRohde
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@bbe9a606c30c34317c90a0afd57429b995c3afd7 -
Trigger Event:
push
-
Statement type: