Skip to main content

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.

PyPI version Python 3.10+ License: MIT Tests Coverage


๐ŸŒŸ 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-github if your project already has a .github directory 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

klondike_spec_cli-0.2.11.tar.gz (196.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

klondike_spec_cli-0.2.11-py3-none-any.whl (81.4 kB view details)

Uploaded Python 3

File details

Details for the file klondike_spec_cli-0.2.11.tar.gz.

File metadata

  • Download URL: klondike_spec_cli-0.2.11.tar.gz
  • Upload date:
  • Size: 196.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for klondike_spec_cli-0.2.11.tar.gz
Algorithm Hash digest
SHA256 cd3b4c6841b46a2ca31da8d8de3872882307ef97de485ee51ec5f850d823a25f
MD5 3bf339cb00e8e5349c324bd5fd78d00d
BLAKE2b-256 1836293a3e264f3f29e68099339f5e9b2e03e1d682fe63be47538e851d049f6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for klondike_spec_cli-0.2.11.tar.gz:

Publisher: publish.yml on ThomasRohde/klondike-spec-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file klondike_spec_cli-0.2.11-py3-none-any.whl.

File metadata

File hashes

Hashes for klondike_spec_cli-0.2.11-py3-none-any.whl
Algorithm Hash digest
SHA256 327a7056865d2b131db7cb5e4fadb4496c9353e0a0357bd3f4217a126541867a
MD5 9431004f718ae39ad695d584d292d565
BLAKE2b-256 00a687b7bd5752deae1b99aa6efb20772b4b7aaaeba5fb70e56f9cf71b902f5f

See more details on using hashes here.

Provenance

The following attestation bundles were made for klondike_spec_cli-0.2.11-py3-none-any.whl:

Publisher: publish.yml on ThomasRohde/klondike-spec-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page