Thanks to visit codestin.com
Credit goes to Github.com

Skip to content

Goal Driven Development - Transform software development from task execution to outcome achievement with goal-driven development methodology.

License

Notifications You must be signed in to change notification settings

Nom-nom-hub/goal-kit

Repository files navigation

🎯 Goal Kit

Build software by focusing on outcomes, not specifications.

Goal Kit transforms software development from task execution to outcome achievement using Goal-Driven Development methodology.

GitHub Release Release Workflow License


⚑ Quick Start (5 minutes)

1. Install

uv tool install --from git+https://github.com/Nom-nom-hub/goal-kit.git goalkeeper-cli

2. Initialize Project

goalkeeper init my-project
cd my-project

3. Use 9 Goal Kit Commands

Core workflow (vision β†’ goal β†’ strategy β†’ milestones β†’ execution):

/goalkit.vision          # Establish vision and principles
/goalkit.goal            # Define measurable goals
/goalkit.strategies      # Explore multiple strategies
/goalkit.milestones      # Create measurable milestones
/goalkit.execute         # Execute with learning

Extended workflow (execution β†’ tasks β†’ metrics β†’ review):

/goalkit.tasks           # Break down into detailed tasks
/goalkit.report          # Generate progress reports
/goalkit.review          # Conduct retrospectives
/goalkit.taskstoissues   # Convert tasks to GitHub issues

Done! Your workflow is set up.

For the 5-minute walkthrough, see Quick Start Guide.


🌟 What is Goal-Driven Development?

Goal-Driven Development focuses on outcomes over specifications:

Aspect Spec-Driven Goal-Driven
Starting Point Detailed specs High-level goals
Focus Requirements Outcomes
Strategy Single approach Multiple approaches
Success Specification compliance Goal achievement

The 9 Goal Kit Commands

Core Workflow (Always Use):

# Command Purpose Focus
1️⃣ /goalkit.vision Project principles Why we're building this
2️⃣ /goalkit.goal Measurable outcomes What success looks like
3️⃣ /goalkit.strategies Multiple approaches How we might achieve it
4️⃣ /goalkit.milestones Progress checkpoints Breaking into steps
5️⃣ /goalkit.execute Adaptive implementation Building with learning

Extended Workflow (As Needed):

# Command Purpose Focus
6️⃣ /goalkit.tasks Task breakdown Breaking execution into detailed work
7️⃣ /goalkit.report Progress metrics Measuring achievement and trends
8️⃣ /goalkit.review Retrospective Assessing achievement and learning
9️⃣ /goalkit.taskstoissues GitHub integration Converting tasks to issues

πŸ“ What Gets Created

After goalkeeper init:

my-project/
β”œβ”€β”€ .goalkit/
β”‚   β”œβ”€β”€ vision.md                  # Project vision
β”‚   └── goals/
β”‚       └── 001-goal-name/
β”‚           β”œβ”€β”€ goal.md            # Goal definition
β”‚           β”œβ”€β”€ strategies.md       # Implementation approaches
β”‚           β”œβ”€β”€ milestones.md       # Progress checkpoints
β”‚           └── execution.md        # Implementation plan
β”œβ”€β”€ CLAUDE.md                       # Agent context
β”œβ”€β”€ CURSOR.md                       # Agent context
└── ... (your code)

Lite Templates (New!)

For smaller projects or quick iterations, you can use the Lite templates:

  • templates/lite-goal-template.md
  • templates/lite-metrics-template.md

πŸ€– Supported AI Agents

Works with all major AI coding assistants:

  • Claude Code
  • GitHub Copilot
  • Google Gemini
  • Cursor
  • Qwen Code
  • Windsurf
  • Kilo Code
  • Amazon Q
  • opencode
  • And others

πŸš€ Installation Options

Option 1: uv (Recommended)

From GitHub:

uv tool install --from git+https://github.com/Nom-nom-hub/goal-kit.git goalkeeper-cli

From local repo:

uv tool install --from . goalkeeper-cli

Option 2: pip

pip install git+https://github.com/Nom-nom-hub/goal-kit.git

Or locally:

pip install -e .

Option 3: One-Time Usage

uv run --from git+https://github.com/Nom-nom-hub/goal-kit.git goalkeeper-cli init my-project

For detailed installation instructions, see Installation Guide.


πŸ“š Documentation

Getting Started

Learning & Reference

Guides & Troubleshooting

Change History

  • Changelog - Version history and release notes

πŸ’‘ Core Principles

1. Goals Over Specs

Focus on outcomes, not implementation details

2. Multiple Strategies

Always explore multiple valid approaches

3. Measurable Success

Define clear metrics before building

4. Adaptive Execution

Be willing to pivot based on evidence

5. Learning Integration

Treat implementation as hypothesis testing


🎯 Typical Workflow

1. Define Vision
   ↓
2. Create Goal (with success metrics)
   ↓
3. Explore Strategies (3+ approaches)
   ↓
4. Plan Milestones (measurable steps)
   ↓
5. Execute (with continuous learning)
   ↓
6. Measure Results
   ↓
7. Repeat for next goal

πŸ”§ Prerequisites

  • Python: 3.8+
  • Git: For version control
  • OS: Linux, macOS, or Windows
  • uv: For package management (optional but recommended)

πŸ†˜ Getting Help


✨ Key Features

  • βœ… 9 commands for complete workflow (vision β†’ goal β†’ strategies β†’ milestones β†’ execute β†’ tasks β†’ report β†’ review)
  • βœ… Works with all major AI agents (Claude, Copilot, Cursor, Gemini, etc.)
  • βœ… Cross-platform (Linux, macOS, Windows)
  • βœ… Git integrated for branch management
  • βœ… Measurable outcomes over tasks
  • βœ… Multiple strategy exploration built-in
  • βœ… Learning-focused execution
  • βœ… Easy installation with uv
  • βœ… VSCode optimized with settings templates and recommended extensions
  • βœ… Agent integration guides included in box

πŸ€– Working with AI Agents

Goal Kit includes built-in support for AI agents like Claude, Cursor, and Copilot:

  1. Copy agent template: Use templates/agent-file-template.md to create CLAUDE.md (or other agents)
  2. Share with agent: Provide the customized agent file when asking for Goal Kit help
  3. Agent executes: The agent follows the methodology guides automatically
  4. VSCode integration: Developers review and refine with optimized editor settings

See Agent & VSCode Setup for complete instructions.


πŸ’» VSCode Integration

Goal Kit provides optimized VSCode configuration:

  • Auto-formatting for Python (Black), Markdown, JSON
  • 100-character ruler for consistent code style
  • GitLens integration for tracking goal milestones
  • Recommended extensions for development (15+ tools)
  • File nesting shows goal document relationships in Explorer

Setup in 2 steps:

cp templates/.vscode-settings-template.json .vscode/settings.json
cp templates/.vscode-extensions-template.json .vscode/extensions.json

VSCode will automatically suggest installing recommended extensions.


πŸš€ Next Steps

  1. Install: uv tool install --from . goalkeeper-cli
  2. Initialize: goalkeeper init my-project
  3. Get Started: Read Quick Start Guide
  4. Learn: Read Goal-Driven Development

Ready to focus on outcomes instead of specifications? Start with the Quick Start Guide.

About

Goal Driven Development - Transform software development from task execution to outcome achievement with goal-driven development methodology.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •