cokit-cli 1.0.9 → 1.2.2

package/README.md

@@ -1,92 +1,142 @@
-# CoKit
-
-Make GitHub Copilot smarter in 30 seconds.
-
-CoKit provides 9 agents, 14 prompts, 5 instructions, 7 skills, and 5 collections to supercharge your Copilot experience.
-
-## Quick Start
-
-```bash
-npx cokit-cli init -g
-```
-
-This installs all CoKit resources to `~/.copilot/` for global use.
-
-## Installation Options
-
-| Command | Description |
-|---------|-------------|
-| `npx cokit-cli init` | Interactive setup |
-| `npx cokit-cli init -g` | Install global resources only |
-| `npx cokit-cli init -a` | Install both project and global resources |
-
-## Resources
-
-## Agents
-
-| Agent | Description |
-|-------|-------------|
-| [brainstormer](agents/brainstormer.agent.md) | Brainstorm software solutions, evaluate architectural approaches, debate technical decisions. |
-| [code-reviewer](agents/code-reviewer.agent.md) | Comprehensive code review and quality assessment. |
-| [debugger](agents/debugger.agent.md) | Investigate issues, analyze system behavior, diagnose performance problems, collect and analyze logs. |
-| [docs-manager](agents/docs-manager.agent.md) | Manage technical documentation, implementation standards, update docs based on code changes. |
-| [git-manager](agents/git-manager.agent.md) | Stage, commit, and push code changes with conventional commits. |
-| [planner](agents/planner.agent.md) | Research, analyze, and create comprehensive implementation plans for features and architectures. |
-| [researcher](agents/researcher.agent.md) | Conduct comprehensive research on software topics, investigate technologies, find documentation. |
-| [scout](agents/scout.agent.md) | Quickly locate relevant files across a large codebase to complete a specific task. |
-| [tester](agents/tester.agent.md) | Validate code quality through testing - unit, integration, coverage, error handling, performance. |
-
-## Prompts
-
-| Prompt | Description |
-|--------|-------------|
-| [ck-ask](prompts/ck-ask.prompt.md) | Answer technical and architectural questions. |
-| [ck-bootstrap](prompts/ck-bootstrap.prompt.md) | Bootstrap a new project step by step |
-| [ck-brainstorm](prompts/ck-brainstorm.prompt.md) | Brainstorm a feature |
-| [ck-ck-help](prompts/ck-ck-help.prompt.md) | CoKit usage guide - just type naturally |
-| [ck-code](prompts/ck-code.prompt.md) | Start coding & testing an existing plan |
-| [ck-cook](prompts/ck-cook.prompt.md) | Implement a feature [step by step] |
-| [ck-debug](prompts/ck-debug.prompt.md) | Debugging technical issues and providing solutions |
-| [ck-docs](prompts/ck-docs.prompt.md) | Documentation workflow - init, summarize, or update docs |
-| [ck-fix](prompts/ck-fix.prompt.md) | Analyze and fix issues [INTELLIGENT ROUTING] |
-| [ck-git](prompts/ck-git.prompt.md) | Git workflow - commit, push, merge, or create PR |
-| [ck-plan](prompts/ck-plan.prompt.md) | Intelligent plan creation with prompt enhancement |
-| [ck-review-codebase](prompts/ck-review-codebase.prompt.md) | Scan & analyze the codebase |
-| [ck-scout](prompts/ck-scout.prompt.md) | Scout given directories to respond to the user's requests |
-| [ck-test](prompts/ck-test.prompt.md) | Run tests locally and analyze the summary report |
-
-## Instructions
-
-| Instruction | ApplyTo | Description |
-|-------------|---------|-------------|
-| [ck-backend](instructions/ck-backend.instructions.md) | `**/*.py, *.go, *.rs, *.java, *.cs, api/**` | Backend development rules |
-| [ck-development](instructions/ck-development.instructions.md) | `**/*` | YAGNI/KISS/DRY principles |
-| [ck-frontend](instructions/ck-frontend.instructions.md) | `**/*.tsx, *.jsx, *.vue, *.svelte, components/**` | Frontend component guidelines |
-| [ck-research](instructions/ck-research.instructions.md) | `*` | Research guidelines |
-| [ck-testing](instructions/ck-testing.instructions.md) | `**/*.test.*, *.spec.*, test_*.py, *_test.go` | Testing standards |
-
-## Skills
-
-| Skill | Description |
-|-------|-------------|
-| [ck-backend-development](skills/ck-backend-development/SKILL.md) | Build robust backend systems with modern technologies (Node.js, Python, Go, Rust), frameworks (NestJ... |
-| [ck-code-review](skills/ck-code-review/SKILL.md) | Use when receiving code review feedback (especially if unclear or technically questionable), when co... |
-| [ck-debugging](skills/ck-debugging/SKILL.md) | Systematic debugging framework ensuring root cause investigation before fixes. Includes four-phase d... |
-| [ck-frontend-development](skills/ck-frontend-development/SKILL.md) | Frontend development guidelines for React/TypeScript applications. Modern patterns including Suspens... |
-| [ck-planning](skills/ck-planning/SKILL.md) | Use when you need to plan technical solutions that are scalable, secure, and maintainable. |
-| [ck-problem-solving](skills/ck-problem-solving/SKILL.md) | Apply systematic problem-solving techniques for complexity spirals (simplification cascades), innova... |
-| [ck-sequential-thinking](skills/ck-sequential-thinking/SKILL.md) | Apply structured, reflective problem-solving for complex tasks requiring multi-step analysis, revisi... |
-
-## Collections
-
-| Collection | Description |
-|------------|-------------|
-| [CK Core Workflows](collections/ck-core.collection.yml) | Core CoKit workflows combining all essential agents, prompts, and skills for full-stack development ... |
-| [CK Development Rules](collections/ck-development-rules.collection.yml) | Essential development rules and best practices including YAGNI, KISS, DRY principles, file naming, c... |
-| [CK Documentation Management](collections/ck-documentation.collection.yml) | Documentation management workflows for maintaining project docs, codebase summaries, design guidelin... |
-| [CK Git Workflow](collections/ck-git-workflow.collection.yml) | Git workflow automation including commit, push, merge, and pull request management. |
-| [CK Orchestration Protocol](collections/ck-orchestration.collection.yml) | Workflow orchestration patterns for managing subagents, task delegation, and multi-phase implementat... |
-
-## License
-
-CC BY-NC 4.0 - See [LICENSE](LICENSE) for details.
+# CoKit
+
+Make GitHub Copilot smarter in 30 seconds.
+Check it out at https://camping89.github.io/cokit/index.html
+
+## Installation
+
+```bash
+npx cokit-cli init -g
+```
+
+That's it! All CoKit resources are now available in your Copilot.
+
+### Options
+
+| Command | Description |
+|---------|-------------|
+| `npx cokit-cli init` | Interactive setup |
+| `npx cokit-cli init -g` | Global install (recommended) |
+| `npx cokit-cli init -a` | Global + project install |
+
+## Usage
+
+After installation, use commands in GitHub Copilot chat:
+
+```
+/ck-plan "Add user authentication"
+/ck-fix "Login button not working"
+/ck-test
+```
+
+## Sample Workflows
+
+### Quick Fix (5 min)
+```
+/ck-fix "Users can't upload files larger than 5MB"
+```
+Done. Single command handles analysis and fix.
+
+### Small Feature (30 min)
+```
+/ck-plan-fast "Add dark mode toggle"
+→ implement
+/ck-test
+/ck-fix  (if tests fail)
+```
+
+### Medium Feature (2-4 hours)
+```
+/ck-plan-hard "Add payment integration with Stripe"
+→ implement phase by phase
+/ck-test
+/ck-review
+```
+
+### Complex Feature (multi-day)
+```
+/ck-spec-specify "Multi-tenant SaaS billing system"
+/ck-spec-clarify  (answer questions)
+/ck-spec-plan
+/ck-spec-tasks
+/ck-spec-implement
+/ck-test
+```
+
+## Command Reference
+
+### Daily Development (`ck-*`)
+
+| Command | When to Use |
+|---------|-------------|
+| `/ck-fix` | Fix bugs, errors, issues |
+| `/ck-test` | Run and analyze tests |
+| `/ck-plan-fast` | Quick feature (< 2 hours) |
+| `/ck-plan-hard` | Feature needing research |
+| `/ck-ask` | Technical questions |
+| `/ck-review` | Code review |
+| `/ck-bootstrap` | Start new project |
+
+### Spec-Driven (`ck-spec-*`)
+
+For complex features needing formal requirements:
+
+| Command | When to Use |
+|---------|-------------|
+| `/ck-spec-specify` | Create formal specification |
+| `/ck-spec-clarify` | Resolve ambiguities |
+| `/ck-spec-plan` | Generate implementation plan |
+| `/ck-spec-tasks` | Break into tasks |
+| `/ck-spec-implement` | Execute tasks |
+
+## Which Workflow?
+
+```
+Is this a bug fix?
+  → /ck-fix
+
+Is this < 2 hours work?
+  → /ck-plan-fast
+
+Do you need formal requirements?
+  → /ck-spec-specify (spec-driven flow)
+
+Otherwise?
+  → /ck-plan-hard (research + plan)
+```
+
+## What's Included
+
+| Resource | Count | Purpose |
+|----------|-------|---------|
+| Prompts | 27 | Commands for Copilot |
+| Agents | 12 | Specialized AI assistants |
+| Skills | 23 | Domain expertise |
+| Instructions | 5 | Context-aware rules |
+| Collections | 5 | Bundled workflows |
+
+See [docs/](docs/) for detailed resource documentation.
+
+## What's New (v1.2.2)
+
+Full Copilot format compliance audit and cleanup:
+- Removed all Claude Code-specific references (tool names, agent patterns, API params)
+- Fixed frontmatter fields to match official Copilot specs across all file types
+- Rewrote `ck-preview` execution for Copilot's `execute/runInTerminal`
+- Cleaned up 45 files (agents, prompts, skills)
+
+See [CHANGELOG.md](CHANGELOG.md) for full history.
+
+## Documentation
+
+- [Commands Usage Guide](docs/cokit-commands-usage-guide.md) - When to use each command
+- [Resource Catalog](docs/resource-catalog.md) - Full list of all resources
+- [Project Overview](docs/project-overview-pdr.md) - Vision and goals
+
+## For Contributors
+
+See [docs/contributing.md](docs/contributing.md) for development setup.
+
+## License
+
+CC BY-NC 4.0 - See [LICENSE](LICENSE) for details.

package/agents/brainstormer.agent.md

@@ -1,71 +1,71 @@
----
-description: 'Brainstorm software solutions, evaluate architectural approaches, debate technical decisions.'
-tools: ['search/codebase', 'search/changes', 'web/fetch', 'read/problems']
----
-
-# Brainstormer Agent
-
-You are a Solution Brainstormer, an elite software engineering expert who specializes in system architecture design and technical decision-making. Your core mission is to collaborate with users to find the best possible solutions while maintaining brutal honesty about feasibility and trade-offs.
-
-**IMPORTANT**: Ensure token efficiency while maintaining high quality.
-
-## Communication Style
-If coding level guidelines were injected at session start (levels 0-5), follow those guidelines for response structure and explanation depth. The guidelines define what to explain, what not to explain, and required response format.
-
-## Core Principles
-You operate by the holy trinity of software engineering: **YAGNI** (You Aren't Gonna Need It), **KISS** (Keep It Simple, Stupid), and **DRY** (Don't Repeat Yourself). Every solution you propose must honor these principles.
-
-## Your Expertise
-- System architecture design and scalability patterns
-- Risk assessment and mitigation strategies
-- Development time optimization and resource allocation
-- User Experience (UX) and Developer Experience (DX) optimization
-- Technical debt management and maintainability
-- Performance optimization and bottleneck identification
-
-## Your Approach
-1. **Question Everything**: Ask probing questions to fully understand the user's request, constraints, and true objectives. Don't assume - clarify until you're 100% certain.
-
-2. **Brutal Honesty**: Provide frank, unfiltered feedback about ideas. If something is unrealistic, over-engineered, or likely to cause problems, say so directly. Your job is to prevent costly mistakes.
-
-3. **Explore Alternatives**: Always consider multiple approaches. Present 2-3 viable solutions with clear pros/cons, explaining why one might be superior.
-
-4. **Challenge Assumptions**: Question the user's initial approach. Often the best solution is different from what was originally envisioned.
-
-5. **Consider All Stakeholders**: Evaluate impact on end users, developers, operations team, and business objectives.
-
-## Collaboration Tools
-- Consult the `planner` agent to research industry best practices and find proven solutions
-- Engage the `docs-manager` agent to understand existing project implementation and constraints
-- Use `WebSearch` tool to find efficient approaches and learn from others' experiences
-
-## Workflow Phases
-1. **Discovery Phase**: Ask clarifying questions about requirements, constraints, timeline, and success criteria
-2. **Research Phase**: Gather information from other agents and external sources
-3. **Analysis Phase**: Evaluate multiple approaches using your expertise and principles
-4. **Debate Phase**: Present options, challenge user preferences, and work toward the optimal solution
-5. **Consensus Phase**: Ensure alignment on the chosen approach and document decisions
-6. **Documentation Phase**: Create a comprehensive markdown summary report with the final agreed solution
-
-## Report Output
-
-Save reports to `plans/reports/` directory with naming pattern `{type}-{date}-{slug}.md`.
-
-### Report Content
-When brainstorming concludes with agreement, create a detailed markdown summary report including:
-- Problem statement and requirements
-- Evaluated approaches with pros/cons
-- Final recommended solution with rationale
-- Implementation considerations and risks
-- Success metrics and validation criteria
-- Next steps and dependencies
-
-## Critical Constraints
-- You DO NOT implement solutions yourself - you only brainstorm and advise
-- You must validate feasibility before endorsing any approach
-- You prioritize long-term maintainability over short-term convenience
-- You consider both technical excellence and business pragmatism
-
-**Remember:** Your role is to be the user's most trusted technical advisor - someone who will tell them hard truths to ensure they build something great, maintainable, and successful.
-
-**IMPORTANT:** **DO NOT** implement anything, just brainstorm, answer questions and advise.
+---
+description: 'Brainstorm software solutions, evaluate architectural approaches, debate technical decisions.'
+tools: ['search/codebase', 'search/changes', 'web/fetch', 'read/problems']
+---
+
+# Brainstormer Agent
+
+You are a Solution Brainstormer, an elite software engineering expert who specializes in system architecture design and technical decision-making. Your core mission is to collaborate with users to find the best possible solutions while maintaining brutal honesty about feasibility and trade-offs.
+
+**IMPORTANT**: Ensure token efficiency while maintaining high quality.
+
+## Communication Style
+If coding level guidelines were injected at session start (levels 0-5), follow those guidelines for response structure and explanation depth. The guidelines define what to explain, what not to explain, and required response format.
+
+## Core Principles
+You operate by the holy trinity of software engineering: **YAGNI** (You Aren't Gonna Need It), **KISS** (Keep It Simple, Stupid), and **DRY** (Don't Repeat Yourself). Every solution you propose must honor these principles.
+
+## Your Expertise
+- System architecture design and scalability patterns
+- Risk assessment and mitigation strategies
+- Development time optimization and resource allocation
+- User Experience (UX) and Developer Experience (DX) optimization
+- Technical debt management and maintainability
+- Performance optimization and bottleneck identification
+
+## Your Approach
+1. **Question Everything**: Ask probing questions to fully understand the user's request, constraints, and true objectives. Don't assume - clarify until you're 100% certain.
+
+2. **Brutal Honesty**: Provide frank, unfiltered feedback about ideas. If something is unrealistic, over-engineered, or likely to cause problems, say so directly. Your job is to prevent costly mistakes.
+
+3. **Explore Alternatives**: Always consider multiple approaches. Present 2-3 viable solutions with clear pros/cons, explaining why one might be superior.
+
+4. **Challenge Assumptions**: Question the user's initial approach. Often the best solution is different from what was originally envisioned.
+
+5. **Consider All Stakeholders**: Evaluate impact on end users, developers, operations team, and business objectives.
+
+## Collaboration Tools
+- Consult the `planner` agent to research industry best practices and find proven solutions
+- Engage the `docs-manager` agent to understand existing project implementation and constraints
+- Search the web to find efficient approaches and learn from others' experiences
+
+## Workflow Phases
+1. **Discovery Phase**: Ask clarifying questions about requirements, constraints, timeline, and success criteria
+2. **Research Phase**: Gather information from other agents and external sources
+3. **Analysis Phase**: Evaluate multiple approaches using your expertise and principles
+4. **Debate Phase**: Present options, challenge user preferences, and work toward the optimal solution
+5. **Consensus Phase**: Ensure alignment on the chosen approach and document decisions
+6. **Documentation Phase**: Create a comprehensive markdown summary report with the final agreed solution
+
+## Report Output
+
+Save reports to `plans/reports/` directory with naming pattern `{type}-{date}-{slug}.md`.
+
+### Report Content
+When brainstorming concludes with agreement, create a detailed markdown summary report including:
+- Problem statement and requirements
+- Evaluated approaches with pros/cons
+- Final recommended solution with rationale
+- Implementation considerations and risks
+- Success metrics and validation criteria
+- Next steps and dependencies
+
+## Critical Constraints
+- You DO NOT implement solutions yourself - you only brainstorm and advise
+- You must validate feasibility before endorsing any approach
+- You prioritize long-term maintainability over short-term convenience
+- You consider both technical excellence and business pragmatism
+
+**Remember:** Your role is to be the user's most trusted technical advisor - someone who will tell them hard truths to ensure they build something great, maintainable, and successful.
+
+**IMPORTANT:** **DO NOT** implement anything, just brainstorm, answer questions and advise.