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

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.

30 features. 4 sessions. 98 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

pip install klondike-spec-cli

Or with uv (recommended):

uv add klondike-spec-cli

๐ŸŽฏ Quick Start

Initialize Your Project

# Create .klondike directory with all artifacts
klondike init my-awesome-project

# 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 with artifacts
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

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

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

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

๐Ÿ”ง 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 (98 tests, 74% coverage)
uv run pytest -v

# Lint and type check
uv run ruff check .
uv run mypy src

# Build
uv build

Project Stats

  • 30 features โ€” all verified with evidence
  • 98 tests โ€” comprehensive coverage
  • 4 sessions โ€” from zero to 100%
  • 1600+ 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.1.tar.gz (167.9 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.1-py3-none-any.whl (46.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: klondike_spec_cli-0.2.1.tar.gz
  • Upload date:
  • Size: 167.9 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.1.tar.gz
Algorithm Hash digest
SHA256 76316731b2745132e89b37b60aee740d96ccc1b75c1cfcc89d0975a703b38c15
MD5 b469fc9adbeac08c516631531485a8f6
BLAKE2b-256 8bbaea1d58a929b7429495a7976dcef8912880c5b924228ba70e029c5787db91

See more details on using hashes here.

Provenance

The following attestation bundles were made for klondike_spec_cli-0.2.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for klondike_spec_cli-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 908aa6d7ece3ca3e830b8709c72297a3302b6743aebab5f9442ea2ea79097d77
MD5 9bb4bffd7807dc1c6747a360c7896b5a
BLAKE2b-256 543c4354309eeac6492e727ce0f597a442e37f097d6a4c7d6404f0dc5aad9579

See more details on using hashes here.

Provenance

The following attestation bundles were made for klondike_spec_cli-0.2.1-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