CLI Commands Reference¶

Complete reference for all Klondike CLI commands.

Command Overview¶

Command	Description
`init`	Initialize a new Klondike project
`status`	Show project status and feature summary
`feature`	Manage features: add, list, start, verify, block
`session`	Manage coding sessions: start, end
`release`	Automate version bumping and release tagging
`validate`	Validate artifact integrity
`progress`	Regenerate agent-progress.md
`report`	Generate stakeholder progress report
`completion`	Generate shell completion scripts
`import-features`	Import features from file
`export-features`	Export features to file
`copilot`	Launch GitHub Copilot CLI with context
`mcp`	Manage MCP server for AI integration

init¶

Initialize a new Klondike project in the current directory.

klondike init [--name <text>] [--force] [--skip-github]

Options¶

Option	Short	Type	Description
`--name`	`-n`	text	Project name
`--force`	`-f`	flag	Overwrite existing `.klondike`
`--skip-github`		flag	Skip creating `.github` directory

Examples¶

klondike init
klondike init --name my-project
klondike init --force
klondike init --skip-github

What It Creates¶

.klondike/ - Artifacts directory
.klondike/features.json - Feature registry
.klondike/agent-progress.json - Progress data
agent-progress.md - Human-readable progress
.github/copilot-instructions.md - Agent instructions

status¶

Show project status and feature summary.

klondike status [--json]

Options¶

Option	Type	Description
`--json`	flag	Output as JSON

Examples¶

klondike status
klondike status --json

Output¶

📊 Project: my-project v0.2.0
   Completion: 40.0%

Progress: [████████░░░░░░░░░░░░] 40.0%

📅 Last Session: #5 (2024-01-15)
   Focus: F003 - Password reset

feature¶

Manage features: add, list, start, verify, block, show, edit.

klondike feature <action> [<feature_id>] [options]

Actions¶

Action	Description
`add`	Add a new feature
`list`	List all features
`start`	Mark feature as in-progress
`verify`	Verify a completed feature
`block`	Block a feature
`show`	Show feature details
`edit`	Edit feature metadata

Options¶

Option	Short	Type	Description
`--description`	`-d`	text	Feature description
`--category`	`-c`	text	Feature category
`--priority`	`-p`	integer	Priority (1-5)
`--criteria`		text	Acceptance criteria (comma-separated)
`--add-criteria`		text	Add acceptance criteria
`--evidence`	`-e`	text	Evidence file paths (comma-separated)
`--reason`	`-r`	text	Block reason
`--status`	`-s`	text	Filter by status
`--json`		flag	Output as JSON
`--notes`		text	Additional notes

Examples¶

# Add a feature
klondike feature add "User login" --category core --priority 1 \
  --criteria "Form displays,Validation works,JWT returned"

# List features
klondike feature list
klondike feature list --status not-started
klondike feature list --json

# Start working
klondike feature start F001

# Verify complete
klondike feature verify F001 --evidence "tests/login.test.js"

# Block with reason
klondike feature block F002 --reason "Waiting for API"

# Show details
klondike feature show F001

# Edit feature
klondike feature edit F001 --notes "Consider OAuth"
klondike feature edit F001 --add-criteria "Support SSO"

session¶

Manage coding sessions: start and end.

klondike session <action> [options]

Actions¶

Action	Description
`start`	Start a new session
`end`	End the current session

Options¶

Option	Short	Type	Description
`--focus`	`-f`	text	Session focus/feature
`--summary`	`-s`	text	Session summary
`--completed`	`-c`	text	Completed items (comma-separated)
`--blockers`	`-b`	text	Blockers encountered
`--next`	`-n`	text	Next steps (comma-separated)
`--auto-commit`		flag	Auto-commit changes on end

Examples¶

# Start session
klondike session start --focus "F001 - User login"

# End session
klondike session end \
  --summary "Completed login form" \
  --completed "Form UI,Validation,API integration" \
  --next "Add forgot password,Add remember me"

# End with auto-commit
klondike session end --summary "Done" --auto-commit

release¶

Automate version bumping and release tagging.

klondike release [<version>] [options]

Arguments¶

Argument	Type	Description
`version`	text	Version to release (e.g., `0.2.0`)

Options¶

Option	Short	Type	Default	Description
`--bump`	`-b`	text		Bump type: `major`, `minor`, `patch`
`--message`	`-m`	text	`Release vX.Y.Z`	Release message
`--dry-run`		flag	`false`	Preview without changes
`--push/--no-push`		flag	`true`	Push to remote
`--skip-tests`		flag	`false`	Skip running tests

Examples¶

# Show current version
klondike release

# Bump version
klondike release --bump patch
klondike release --bump minor
klondike release --bump major

# Specific version
klondike release 1.0.0

# Preview first
klondike release --bump minor --dry-run

# Skip push
klondike release --bump patch --no-push

validate¶

Validate artifact integrity.

klondike validate

What It Checks¶

.klondike/ directory exists
features.json is valid JSON with correct schema
agent-progress.json is valid JSON
Feature IDs are unique
Status values are valid

Examples¶

klondike validate

progress¶

Regenerate agent-progress.md from JSON data.

klondike progress [--output <text>]

Options¶

Option	Short	Type	Description
`--output`	`-o`	text	Output file path

Examples¶

klondike progress
klondike progress --output docs/progress.md

report¶

Generate stakeholder progress report.

klondike report [options]

Options¶

Option	Short	Type	Default	Description
`--format`	`-f`	text	`markdown`	Output format: `markdown`, `plain`
`--output`	`-o`	text		Output file path
`--details`	`-d`	flag	`false`	Include feature details

Examples¶

klondike report
klondike report --format plain
klondike report --output report.md --details

completion¶

Generate shell completion scripts.

klondike completion <shell> [--output <text>]

Arguments¶

Argument	Type	Description
`shell`	text	Shell type: `bash`, `zsh`, `powershell`

Options¶

Option	Short	Type	Description
`--output`	`-o`	text	Output file path

Examples¶

# Output to stdout
klondike completion bash
klondike completion zsh
klondike completion powershell

# Save to file
klondike completion zsh --output ~/.zsh/completions/_klondike
klondike completion powershell >> $PROFILE

import-features¶

Import features from YAML or JSON file.

klondike import-features <file_path> [--dry-run]

Arguments¶

Argument	Type	Description
`file_path`	text	Path to YAML or JSON file

Options¶

Option	Type	Description
`--dry-run`	flag	Preview import without changes

Examples¶

klondike import-features features.yaml
klondike import-features backlog.json --dry-run

File Format¶

# features.yaml
- description: User login
  category: core
  priority: 1
  acceptance_criteria:
    - Form displays
    - Validation works

export-features¶

Export features to YAML or JSON file.

klondike export-features <output> [options]

Arguments¶

Argument	Type	Description
`output`	text	Output file path (`.yaml`, `.yml`, or `.json`)

Options¶

Option	Short	Type	Description
`--status`	`-s`	text	Filter by status
`--all`		flag	Include all fields (including internal)

Examples¶

klondike export-features features.yaml
klondike export-features backlog.json --status not-started
klondike export-features full-export.yaml --all

copilot¶

Launch GitHub Copilot CLI with Klondike context.

klondike copilot <action> [options]

Actions¶

Action	Description
`start`	Launch Copilot session

Options¶

Option	Short	Type	Description
`--model`	`-m`	text	Model to use (e.g., `claude-sonnet`)
`--resume`	`-r`	flag	Resume previous session
`--feature`	`-f`	text	Focus on specific feature
`--instructions`	`-i`	text	Additional instructions
`--allow-tools`		text	Comma-separated allowed tools
`--dry-run`		flag	Show command without executing

Examples¶

klondike copilot start
klondike copilot start --model claude-sonnet
klondike copilot start --feature F001
klondike copilot start --resume
klondike copilot start --dry-run

mcp¶

Manage MCP server for AI agent integration.

klondike mcp <action> [options]

Actions¶

Action	Description
`serve`	Start the MCP server
`install`	Install MCP config to VS Code
`config`	Generate MCP config file

Options¶

Option	Short	Type	Default	Description
`--transport`	`-t`	text	`stdio`	Transport: `stdio`, `streamable-http`
`--output`	`-o`	text		Output path for config file

Examples¶

klondike mcp serve
klondike mcp serve --transport streamable-http
klondike mcp config --output mcp-config.json
klondike mcp install

Getting Help¶

For any command, use klondike pith for contextual help:

# Basic help
klondike pith <command>

# With options
klondike pith <command> -v

# With examples
klondike pith <command> -vv