cokit-cli 1.0.9 → 1.2.0

package/templates/repo/.github/spec-kit/templates/tasks-template.md

@@ -0,0 +1,268 @@
+---
+
+description: "Task list template for feature implementation (master file)"
+---
+
+# Tasks: [FEATURE NAME]
+
+**Input**: Design documents from `/specs/[###-feature-name]/`
+**Prerequisites**: plan.md (required), spec.md (required for user stories), research.md, data-model.md, contracts/
+
+**Structure**: This is the master task file. Individual phase details are in `tasks/phase-*.md` files.
+
+**Tests**: Tests are OPTIONAL - only include them if explicitly requested in the feature specification.
+
+**Organization**: Tasks are grouped by user story to enable independent implementation and testing of each story.
+
+## Phase Summary
+
+| Phase | Title | Status | Tasks | Dependencies |
+|-------|-------|--------|-------|--------------|
+| 1 | [Setup](tasks/phase-01-setup.md) | pending | X | - |
+| 2 | [Foundation](tasks/phase-02-foundation.md) | pending | X | Phase 1 |
+| 3 | [US1: Title](tasks/phase-03-us1-slug.md) | pending | X | Phase 2 |
+| 4 | [US2: Title](tasks/phase-04-us2-slug.md) | pending | X | Phase 2 |
+| N | [Polish](tasks/phase-NN-polish.md) | pending | X | All US phases |
+
+## Dependency Graph
+
+```
+Phase 1 (Setup)
+    ↓
+Phase 2 (Foundation) ─── BLOCKS ALL USER STORIES
+    ↓
+┌───┴───┬───────┐
+↓       ↓       ↓
+US1     US2     US3   (can run in parallel)
+↓       ↓       ↓
+└───┬───┴───────┘
+    ↓
+Phase N (Polish)
+```
+
+## Task Format: `[ID] [P?] [Story?] Description`
+
+- **[P]**: Can run in parallel (different files, no dependencies)
+- **[Story]**: Which user story this task belongs to (e.g., US1, US2, US3)
+- Include exact file paths in descriptions
+
+## Path Conventions
+
+- **Single project**: `src/`, `tests/` at repository root
+- **Web app**: `backend/src/`, `frontend/src/`
+- **Mobile**: `api/src/`, `ios/src/` or `android/src/`
+- Paths shown below assume single project - adjust based on plan.md structure
+
+---
+
+<!--
+  ============================================================================
+  BELOW: Quick reference of phases. Full task details are in tasks/phase-*.md
+  ============================================================================
+-->
+
+## Phase 1: Setup (Shared Infrastructure)
+
+**Purpose**: Project initialization and basic structure
+
+- [ ] T001 Create project structure per implementation plan
+- [ ] T002 Initialize [language] project with [framework] dependencies
+- [ ] T003 [P] Configure linting and formatting tools
+
+---
+
+## Phase 2: Foundational (Blocking Prerequisites)
+
+**Purpose**: Core infrastructure that MUST be complete before ANY user story can be implemented
+
+**⚠️ CRITICAL**: No user story work can begin until this phase is complete
+
+Examples of foundational tasks (adjust based on your project):
+
+- [ ] T004 Setup database schema and migrations framework
+- [ ] T005 [P] Implement authentication/authorization framework
+- [ ] T006 [P] Setup API routing and middleware structure
+- [ ] T007 Create base models/entities that all stories depend on
+- [ ] T008 Configure error handling and logging infrastructure
+- [ ] T009 Setup environment configuration management
+
+**Checkpoint**: Foundation ready - user story implementation can now begin in parallel
+
+---
+
+## Phase 3: User Story 1 - [Title] (Priority: P1) 🎯 MVP
+
+**Goal**: [Brief description of what this story delivers]
+
+**Independent Test**: [How to verify this story works on its own]
+
+### Tests for User Story 1 (OPTIONAL - only if tests requested) ⚠️
+
+> **NOTE: Write these tests FIRST, ensure they FAIL before implementation**
+
+- [ ] T010 [P] [US1] Contract test for [endpoint] in tests/contract/test_[name].py
+- [ ] T011 [P] [US1] Integration test for [user journey] in tests/integration/test_[name].py
+
+### Implementation for User Story 1
+
+- [ ] T012 [P] [US1] Create [Entity1] model in src/models/[entity1].py
+- [ ] T013 [P] [US1] Create [Entity2] model in src/models/[entity2].py
+- [ ] T014 [US1] Implement [Service] in src/services/[service].py (depends on T012, T013)
+- [ ] T015 [US1] Implement [endpoint/feature] in src/[location]/[file].py
+- [ ] T016 [US1] Add validation and error handling
+- [ ] T017 [US1] Add logging for user story 1 operations
+
+**Checkpoint**: At this point, User Story 1 should be fully functional and testable independently
+
+---
+
+## Phase 4: User Story 2 - [Title] (Priority: P2)
+
+**Goal**: [Brief description of what this story delivers]
+
+**Independent Test**: [How to verify this story works on its own]
+
+### Tests for User Story 2 (OPTIONAL - only if tests requested) ⚠️
+
+- [ ] T018 [P] [US2] Contract test for [endpoint] in tests/contract/test_[name].py
+- [ ] T019 [P] [US2] Integration test for [user journey] in tests/integration/test_[name].py
+
+### Implementation for User Story 2
+
+- [ ] T020 [P] [US2] Create [Entity] model in src/models/[entity].py
+- [ ] T021 [US2] Implement [Service] in src/services/[service].py
+- [ ] T022 [US2] Implement [endpoint/feature] in src/[location]/[file].py
+- [ ] T023 [US2] Integrate with User Story 1 components (if needed)
+
+**Checkpoint**: At this point, User Stories 1 AND 2 should both work independently
+
+---
+
+## Phase 5: User Story 3 - [Title] (Priority: P3)
+
+**Goal**: [Brief description of what this story delivers]
+
+**Independent Test**: [How to verify this story works on its own]
+
+### Tests for User Story 3 (OPTIONAL - only if tests requested) ⚠️
+
+- [ ] T024 [P] [US3] Contract test for [endpoint] in tests/contract/test_[name].py
+- [ ] T025 [P] [US3] Integration test for [user journey] in tests/integration/test_[name].py
+
+### Implementation for User Story 3
+
+- [ ] T026 [P] [US3] Create [Entity] model in src/models/[entity].py
+- [ ] T027 [US3] Implement [Service] in src/services/[service].py
+- [ ] T028 [US3] Implement [endpoint/feature] in src/[location]/[file].py
+
+**Checkpoint**: All user stories should now be independently functional
+
+---
+
+[Add more user story phases as needed, following the same pattern]
+
+---
+
+## Phase N: Polish & Cross-Cutting Concerns
+
+**Purpose**: Improvements that affect multiple user stories
+
+- [ ] TXXX [P] Documentation updates in docs/
+- [ ] TXXX Code cleanup and refactoring
+- [ ] TXXX Performance optimization across all stories
+- [ ] TXXX [P] Additional unit tests (if requested) in tests/unit/
+- [ ] TXXX Security hardening
+- [ ] TXXX Run quickstart.md validation
+
+---
+
+## Dependencies & Execution Order
+
+### Phase Dependencies
+
+- **Setup (Phase 1)**: No dependencies - can start immediately
+- **Foundational (Phase 2)**: Depends on Setup completion - BLOCKS all user stories
+- **User Stories (Phase 3+)**: All depend on Foundational phase completion
+  - User stories can then proceed in parallel (if staffed)
+  - Or sequentially in priority order (P1 → P2 → P3)
+- **Polish (Final Phase)**: Depends on all desired user stories being complete
+
+### User Story Dependencies
+
+- **User Story 1 (P1)**: Can start after Foundational (Phase 2) - No dependencies on other stories
+- **User Story 2 (P2)**: Can start after Foundational (Phase 2) - May integrate with US1 but should be independently testable
+- **User Story 3 (P3)**: Can start after Foundational (Phase 2) - May integrate with US1/US2 but should be independently testable
+
+### Within Each User Story
+
+- Tests (if included) MUST be written and FAIL before implementation
+- Models before services
+- Services before endpoints
+- Core implementation before integration
+- Story complete before moving to next priority
+
+### Parallel Opportunities
+
+- All Setup tasks marked [P] can run in parallel
+- All Foundational tasks marked [P] can run in parallel (within Phase 2)
+- Once Foundational phase completes, all user stories can start in parallel (if team capacity allows)
+- All tests for a user story marked [P] can run in parallel
+- Models within a story marked [P] can run in parallel
+- Different user stories can be worked on in parallel by different team members
+
+---
+
+## Parallel Example: User Story 1
+
+```bash
+# Launch all tests for User Story 1 together (if tests requested):
+Task: "Contract test for [endpoint] in tests/contract/test_[name].py"
+Task: "Integration test for [user journey] in tests/integration/test_[name].py"
+
+# Launch all models for User Story 1 together:
+Task: "Create [Entity1] model in src/models/[entity1].py"
+Task: "Create [Entity2] model in src/models/[entity2].py"
+```
+
+---
+
+## Implementation Strategy
+
+### MVP First (User Story 1 Only)
+
+1. Complete Phase 1: Setup
+2. Complete Phase 2: Foundational (CRITICAL - blocks all stories)
+3. Complete Phase 3: User Story 1
+4. **STOP and VALIDATE**: Test User Story 1 independently
+5. Deploy/demo if ready
+
+### Incremental Delivery
+
+1. Complete Setup + Foundational → Foundation ready
+2. Add User Story 1 → Test independently → Deploy/Demo (MVP!)
+3. Add User Story 2 → Test independently → Deploy/Demo
+4. Add User Story 3 → Test independently → Deploy/Demo
+5. Each story adds value without breaking previous stories
+
+### Parallel Team Strategy
+
+With multiple developers:
+
+1. Team completes Setup + Foundational together
+2. Once Foundational is done:
+   - Developer A: User Story 1
+   - Developer B: User Story 2
+   - Developer C: User Story 3
+3. Stories complete and integrate independently
+
+---
+
+## Notes
+
+- [P] tasks = different files, no dependencies
+- [Story] label maps task to specific user story for traceability
+- Each user story should be independently completable and testable
+- Verify tests fail before implementing
+- Commit after each task or logical group
+- Stop at any checkpoint to validate story independently
+- Avoid: vague tasks, same file conflicts, cross-story dependencies that break independence

package/templates/repo/.github/spec-kit/templates/vscode-settings.json

@@ -0,0 +1,14 @@
+{
+    "chat.promptFilesRecommendations": {
+        "speckit.constitution": true,
+        "speckit.specify": true,
+        "speckit.plan": true,
+        "speckit.tasks": true,
+        "speckit.implement": true
+    },
+    "chat.tools.terminal.autoApprove": {
+        ".specify/scripts/bash/": true,
+        ".specify/scripts/powershell/": true
+    }
+}
+

package/templates/repo/.vscode/settings.json

@@ -1,70 +1,70 @@
-{
-  "// GitHub Copilot Settings": "",
-  "github.copilot.enable": {
-    "*": true,
-    "markdown": true,
-    "yaml": true,
-    "plaintext": true
-  },
-  "// Editor Settings": "",
-  "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit",
-    "source.organizeImports": "explicit"
-  },
-  "editor.inlineSuggest.enabled": true,
-  "editor.quickSuggestions": {
-    "other": true,
-    "comments": true,
-    "strings": true
-  },
-  "editor.tabSize": 2,
-  "editor.insertSpaces": true,
-  "editor.detectIndentation": true,
-  "editor.wordWrap": "on",
-  "// Files Settings": "",
-  "files.autoSave": "onFocusChange",
-  "files.trimTrailingWhitespace": true,
-  "files.insertFinalNewline": true,
-  "files.encoding": "utf8",
-  "files.eol": "\n",
-  "// Terminal Settings": "",
-  "terminal.integrated.defaultProfile.windows": "PowerShell",
-  "terminal.integrated.enablePersistentSessions": true,
-  "terminal.integrated.cursorBlinking": true,
-  "// Search Settings": "",
-  "search.exclude": {
-    "**/node_modules": true,
-    "**/dist": true,
-    "**/build": true,
-    "**/out": true,
-    "**/.git": true,
-    "**/package-lock.json": true
-  },
-  "// Markdown Settings": "",
-  "markdown.preview.breaks": true,
-  "markdown.preview.linkify": true,
-  "// Git Settings": "",
-  "git.autofetch": true,
-  "git.confirmSync": false,
-  "git.enableSmartCommit": true,
-  "// Formatting": "",
-  "[markdown]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.wordWrap": "on",
-    "editor.quickSuggestions": {
-      "comments": true,
-      "strings": true,
-      "other": true
-    }
-  },
-  "[javascript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[json]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[yaml]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  }
-}
+{
+  "// GitHub Copilot Settings": "",
+  "github.copilot.enable": {
+    "*": true,
+    "markdown": true,
+    "yaml": true,
+    "plaintext": true
+  },
+  "// Editor Settings": "",
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "explicit",
+    "source.organizeImports": "explicit"
+  },
+  "editor.inlineSuggest.enabled": true,
+  "editor.quickSuggestions": {
+    "other": true,
+    "comments": true,
+    "strings": true
+  },
+  "editor.tabSize": 2,
+  "editor.insertSpaces": true,
+  "editor.detectIndentation": true,
+  "editor.wordWrap": "on",
+  "// Files Settings": "",
+  "files.autoSave": "onFocusChange",
+  "files.trimTrailingWhitespace": true,
+  "files.insertFinalNewline": true,
+  "files.encoding": "utf8",
+  "files.eol": "\n",
+  "// Terminal Settings": "",
+  "terminal.integrated.defaultProfile.windows": "PowerShell",
+  "terminal.integrated.enablePersistentSessions": true,
+  "terminal.integrated.cursorBlinking": true,
+  "// Search Settings": "",
+  "search.exclude": {
+    "**/node_modules": true,
+    "**/dist": true,
+    "**/build": true,
+    "**/out": true,
+    "**/.git": true,
+    "**/package-lock.json": true
+  },
+  "// Markdown Settings": "",
+  "markdown.preview.breaks": true,
+  "markdown.preview.linkify": true,
+  "// Git Settings": "",
+  "git.autofetch": true,
+  "git.confirmSync": false,
+  "git.enableSmartCommit": true,
+  "// Formatting": "",
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.wordWrap": "on",
+    "editor.quickSuggestions": {
+      "comments": true,
+      "strings": true,
+      "other": true
+    }
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

package/.vscode/settings.json

@@ -1,70 +0,0 @@
-{
-  "// GitHub Copilot Settings": "",
-  "github.copilot.enable": {
-    "*": true,
-    "markdown": true,
-    "yaml": true,
-    "plaintext": true
-  },
-  "// Editor Settings": "",
-  "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit",
-    "source.organizeImports": "explicit"
-  },
-  "editor.inlineSuggest.enabled": true,
-  "editor.quickSuggestions": {
-    "other": true,
-    "comments": true,
-    "strings": true
-  },
-  "editor.tabSize": 2,
-  "editor.insertSpaces": true,
-  "editor.detectIndentation": true,
-  "editor.wordWrap": "on",
-  "// Files Settings": "",
-  "files.autoSave": "onFocusChange",
-  "files.trimTrailingWhitespace": true,
-  "files.insertFinalNewline": true,
-  "files.encoding": "utf8",
-  "files.eol": "\n",
-  "// Terminal Settings": "",
-  "terminal.integrated.defaultProfile.windows": "PowerShell",
-  "terminal.integrated.enablePersistentSessions": true,
-  "terminal.integrated.cursorBlinking": true,
-  "// Search Settings": "",
-  "search.exclude": {
-    "**/node_modules": true,
-    "**/dist": true,
-    "**/build": true,
-    "**/out": true,
-    "**/.git": true,
-    "**/package-lock.json": true
-  },
-  "// Markdown Settings": "",
-  "markdown.preview.breaks": true,
-  "markdown.preview.linkify": true,
-  "// Git Settings": "",
-  "git.autofetch": true,
-  "git.confirmSync": false,
-  "git.enableSmartCommit": true,
-  "// Formatting": "",
-  "[markdown]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "editor.wordWrap": "on",
-    "editor.quickSuggestions": {
-      "comments": true,
-      "strings": true,
-      "other": true
-    }
-  },
-  "[javascript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[json]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[yaml]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  }
-}

package/AGENTS.md

@@ -1,103 +0,0 @@
-# AGENTS.md
-
-## Project Overview
-
-CoKit is a collection of agents, prompts, instructions, and skills designed to enhance GitHub Copilot experiences in Awesome Copilot format.
-
-- **Agents** - Specialized GitHub Copilot agents for various tasks
-- **Prompts** - Task-specific prompts for code generation and problem-solving
-- **Instructions** - Coding standards and best practices applied to specific file patterns
-- **Skills** - Self-contained folders with instructions and bundled resources
-- **Collections** - Curated collections organized around specific themes
-
-## Repository Structure
-
-```
-.
-├── agents/           # Custom agent definitions (.agent.md files)
-├── prompts/          # Task-specific prompts (.prompt.md files)
-├── instructions/     # Coding standards (.instructions.md files)
-├── skills/           # Agent Skills folders (SKILL.md + bundled assets)
-├── collections/      # Curated collections (.collection.yml files)
-├── docs/             # Documentation
-├── eng/              # Build and conversion scripts
-├── src/              # CLI source code
-├── bin/              # CLI entry point
-└── templates/        # Project templates for init command
-```
-
-## Setup Commands
-
-```bash
-# Install dependencies
-npm ci
-
-# Build (generate README.md)
-npm run build
-
-# Convert all resources
-npm run convert:all
-
-# Convert individually
-npm run convert:agents
-npm run convert:commands
-npm run convert:skills
-```
-
-## Development Workflow
-
-### Working with Agents, Prompts, Instructions, and Skills
-
-All files must include proper markdown front matter:
-
-#### Agent Files (*.agent.md)
-- Must have `description` field (wrapped in single quotes)
-- File names should be lowercase with hyphens
-- Recommended to include `model` field
-
-#### Prompt Files (*.prompt.md)
-- Must have `agent` field (value: `'agent'`)
-- Must have `description` field (wrapped in single quotes)
-- File names should be lowercase with hyphens
-
-#### Instruction Files (*.instructions.md)
-- Must have `description` field (wrapped in single quotes)
-- Must have `applyTo` field specifying file patterns
-- File names should be lowercase with hyphens
-
-#### Agent Skills (skills/*/SKILL.md)
-- Each skill is a folder containing a `SKILL.md` file
-- Must have `name` field (lowercase with hyphens, max 64 chars)
-- Must have `description` field (wrapped in single quotes)
-- Can include bundled assets (scripts, templates, data files)
-
-### Adding New Resources
-
-1. Create the file with proper front matter
-2. Add to the appropriate directory
-3. Run `npm run build` to update README.md
-4. Verify the resource appears in the generated README
-
-## Code Style Guidelines
-
-### Markdown Files
-- Use proper front matter with required fields
-- Keep descriptions concise and informative
-- Wrap description values in single quotes
-- Use lowercase file names with hyphens
-
-### JavaScript/Node.js Scripts
-- Located in `eng/` and `src/` directories
-- Follow Node.js ES module conventions (.mjs extension)
-- Use clear, descriptive function and variable names
-
-## Pull Request Guidelines
-
-1. Run `npm run build` before committing
-2. Ensure all markdown files have required front matter
-3. Verify file names follow naming convention
-4. Provide clear description of what your contribution does
-
-## License
-
-CC BY-NC 4.0 - See [LICENSE](LICENSE) for details

package/FAQ.md

@@ -1,101 +0,0 @@
-# FAQ
-
-## Installation
-
-### What's the difference between repo and global?
-
-| Type | Location | Scope | Share with Team |
-|------|----------|-------|-----------------|
-| Repo | `.github/` | This project only | Yes (via git) |
-| Global | `~/.copilot/skills/` | All your projects | No |
-
-### Do I need to edit any files?
-
-No. Just run `npx cokit init` and you're done.
-
-### Can I customize the prompts?
-
-Yes! Edit any `.prompt.md` file in `.github/prompts/`.
-
-### Does this work with JetBrains IDEs?
-
-- **Prompts**: Yes
-- **Skills**: Partial support (check JetBrains docs)
-
-## Usage
-
-### How do I use a prompt?
-
-Type the prompt name in Copilot Chat:
-```
-/ck-fix my login function throws an error
-```
-
-### Why isn't Copilot responding to my prompts?
-
-1. Restart VS Code after installing
-2. Make sure Copilot extension is active
-3. Run `npx cokit doctor` to check setup
-
-### Can I add my own prompts?
-
-Yes! Create a file like `.github/prompts/my-prompt.prompt.md`:
-```yaml
----
-mode: agent
-description: What this prompt does
----
-Your instructions here...
-```
-
-## Technical
-
-### What files does CoKit create?
-
-**Repo-level (`.github/`):**
-- `copilot-instructions.md` - Project rules
-- `AGENTS.md` - Agent behavior
-- `agents/*.agent.md` - 9 agent files
-- `prompts/ck-*.prompt.md` - 14 prompt files
-- `skills/ck-*/SKILL.md` - 7 skill directories
-- `instructions/ck-*.instructions.md` - 5 instruction files
-- `collections/*.collection.yml` - 5 collection files
-
-### Does CoKit modify my code?
-
-No. It only creates configuration files for Copilot.
-
-### How do I uninstall?
-
-Delete the files:
-```bash
-rm -rf .github/prompts .github/skills .github/instructions
-rm .github/copilot-instructions.md .github/AGENTS.md
-```
-
-For global:
-```bash
-rm -rf ~/.copilot/skills
-```
-
-## Troubleshooting
-
-### "Permission denied" error
-
-Use sudo (macOS/Linux) or run as admin (Windows):
-```bash
-sudo npx cokit init --global
-```
-
-### "Node.js not found"
-
-Install Node.js 18+ from https://nodejs.org
-
-### Skills not working
-
-Enable in VS Code settings:
-```json
-{
-  "github.copilot.chat.useAgentSkills": true
-}
-```