cokit-cli 1.0.0 → 1.0.2

package/AGENTS.md

@@ -0,0 +1,103 @@
+# AGENTS.md
+
+## Project Overview
+
+CoKit is a collection of agents, prompts, instructions, and skills designed to enhance GitHub Copilot experiences. The project converts ClaudeKit resources to Awesome Copilot format for use with GitHub Copilot.
+
+- **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 ClaudeKit 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

@@ -28,7 +28,7 @@ Yes! Edit any `.prompt.md` file in `.github/prompts/`.
 
 Type the prompt name in Copilot Chat:
 ```
-/fix my login function throws an error
+/ck-fix my login function throws an error
 ```
 
 ### Why isn't Copilot responding to my prompts?
@@ -55,12 +55,12 @@ Your instructions here...
 **Repo-level (`.github/`):**
 - `copilot-instructions.md` - Project rules
 - `AGENTS.md` - Agent behavior
-- `prompts/*.prompt.md` - 6 prompt files
-- `skills/*/SKILL.md` - 2 skill files
-- `instructions/*.instructions.md` - 4 instruction files
+- `prompts/ck-*.prompt.md` - 6 prompt files (ck-fix, ck-plan, etc.)
+- `skills/ck-*/SKILL.md` - 2 skill files (ck-debugging, ck-code-review)
+- `instructions/ck-*.instructions.md` - 4 instruction files
 
 **User-level (`~/.copilot/skills/`):**
-- 5 skill directories with SKILL.md + references
+- 5 skill directories: ck-debugging, ck-code-review, ck-planning, ck-docs-seeker, ck-sequential-thinking
 
 ### Does CoKit modify my code?
 

package/QUICK-START.md

@@ -12,7 +12,7 @@ Open your project in VS Code.
 
 ## Step 3: Try It
 
-Type `/fix` in Copilot Chat.
+Type `/ck-fix` in Copilot Chat.
 
 ## Done!
 
@@ -24,9 +24,9 @@ You now have 6 prompts and 5 skills ready to use.
 
 Try these prompts in Copilot Chat:
 
-- `/fix` - Got a bug? Copilot will debug it
-- `/plan` - Need a feature? Copilot will plan it
-- `/review` - Ready to commit? Copilot will review it
+- `/ck-fix` - Got a bug? Copilot will debug it
+- `/ck-plan` - Need a feature? Copilot will plan it
+- `/ck-review` - Ready to commit? Copilot will review it
 
 ## Need Help?
 

package/README.FLOW.md

@@ -0,0 +1,237 @@
+# Copilot Flow Diagrams
+
+Visual diagrams showing how Copilot processes resources.
+
+---
+
+## Main Processing Flow
+
+```
+┌──────────────────────────────────────────────────────────────────────────────┐
+│                           USER INPUT                                         │
+│                    "/ck-cook implement login"                                │
+└─────────────────────────────────┬────────────────────────────────────────────┘
+                                  │
+                                  ▼
+┌──────────────────────────────────────────────────────────────────────────────┐
+│  STEP 1: PROMPT LOADING                                                      │
+│  ────────────────────────────────────────────────────────────────────────    │
+│  Copilot finds file: prompts/ck-cook.prompt.md                               │
+│  Loads YAML front matter + body content                                      │
+│  ${input} = "implement login"                                                │
+└─────────────────────────────────┬────────────────────────────────────────────┘
+                                  │
+                                  ▼
+┌──────────────────────────────────────────────────────────────────────────────┐
+│  STEP 2: AGENT ASSIGNMENT                                                    │
+│  ────────────────────────────────────────────────────────────────────────    │
+│  Prompt specifies: agent: 'agent' or agent: 'planner'                        │
+│  Copilot loads agent config from agents/*.agent.md                           │
+│  Agent receives context + instructions from prompt                           │
+└─────────────────────────────────┬────────────────────────────────────────────┘
+                                  │
+                                  ▼
+┌──────────────────────────────────────────────────────────────────────────────┐
+│  STEP 3: INSTRUCTION INJECTION (Auto)                                        │
+│  ────────────────────────────────────────────────────────────────────────    │
+│  When agent works with files, Copilot checks glob patterns:                  │
+│                                                                              │
+│  Current file: src/components/Login.tsx                                      │
+│       ↓                                                                      │
+│  Check: applyTo: "**/*.tsx" → Match!                                         │
+│       ↓                                                                      │
+│  Inject: ck-frontend.instructions.md into context                            │
+│                                                                              │
+│  ┌────────────────────────────────────────────────────────────────┐          │
+│  │  Instructions injected in order:                               │          │
+│  │  1. copilot-instructions.md (global)                           │          │
+│  │  2. *.instructions.md matching pattern (file-specific)         │          │
+│  └────────────────────────────────────────────────────────────────┘          │
+└─────────────────────────────────┬────────────────────────────────────────────┘
+                                  │
+                                  ▼
+┌──────────────────────────────────────────────────────────────────────────────┐
+│  STEP 4: SKILL ACTIVATION (On-demand)                                        │
+│  ────────────────────────────────────────────────────────────────────────    │
+│  Agent/User activates skill when specialized knowledge needed:               │
+│                                                                              │
+│  Prompt: "Use frontend-design skill for UI"                                  │
+│       ↓                                                                      │
+│  Load: skills/frontend-design/SKILL.md                                       │
+│       ↓                                                                      │
+│  Inject specialized knowledge into agent context                             │
+│                                                                              │
+│  ┌────────────────────────────────────────────────────────────────┐          │
+│  │  Skill may include:                                            │          │
+│  │  - SKILL.md (main instructions)                                │          │
+│  │  - Scripts (*.py, *.js)                                        │          │
+│  │  - Templates, examples                                         │          │
+│  └────────────────────────────────────────────────────────────────┘          │
+└─────────────────────────────────┬────────────────────────────────────────────┘
+                                  │
+                                  ▼
+┌──────────────────────────────────────────────────────────────────────────────┐
+│  STEP 5: EXECUTION                                                           │
+│  ────────────────────────────────────────────────────────────────────────    │
+│  Agent executes with full context:                                           │
+│                                                                              │
+│  ┌─────────────────────────────────────────────────────────────┐             │
+│  │  AGENT CONTEXT                                              │             │
+│  │  ├── Prompt instructions (workflow)                         │             │
+│  │  ├── Global instructions (project rules)                    │             │
+│  │  ├── File instructions (pattern-matched)                    │             │
+│  │  ├── Activated skills (specialized knowledge)               │             │
+│  │  └── User input + conversation history                      │             │
+│  └─────────────────────────────────────────────────────────────┘             │
+│                                                                              │
+│  Agent actions: Read files → Generate code → Edit files → Run commands       │
+└─────────────────────────────────┬────────────────────────────────────────────┘
+                                  │
+                                  ▼
+┌──────────────────────────────────────────────────────────────────────────────┐
+│  STEP 6: OUTPUT                                                              │
+│  ────────────────────────────────────────────────────────────────────────    │
+│  - Code changes applied                                                      │
+│  - Explanation/summary provided                                              │
+│  - Follow-up suggestions                                                     │
+└──────────────────────────────────────────────────────────────────────────────┘
+```
+
+---
+
+## Resource Hierarchy
+
+```
+┌─────────────────────────────────────────────────────────────────┐
+│                      COPILOT RESOURCES                          │
+├─────────────┬─────────────┬─────────────┬─────────────┬─────────┤
+│   Prompt    │    Agent    │ Instruction │    Skill    │Collection│
+│  (Workflow) │  (Executor) │   (Rules)   │ (Knowledge) │ (Bundle) │
+└─────────────┴─────────────┴─────────────┴─────────────┴─────────┘
+```
+
+---
+
+## Resource Relationships
+
+```
+Collection (Bundle)
+    │
+    ├── contains ──► Prompts (Workflows)
+    │                    │
+    │                    └── uses ──► Agents (Executors)
+    │                                     │
+    │                                     ├── auto-receives ──► Instructions (Rules)
+    │                                     │
+    │                                     └── can-activate ──► Skills (Knowledge)
+    │
+    └── contains ──► Instructions, Skills, Agents...
+```
+
+---
+
+## Instruction Injection Flow
+
+```
+┌─────────────────────────────────────────────────────────────────────────┐
+│                         FILE EDITING                                    │
+│                   User opens: src/App.tsx                               │
+└────────────────────────────────┬────────────────────────────────────────┘
+                                 │
+                                 ▼
+┌─────────────────────────────────────────────────────────────────────────┐
+│  PATTERN MATCHING                                                       │
+│  ─────────────────────────────────────────────────────────────────────  │
+│                                                                         │
+│  ┌─────────────────────────────────────────────────────────────────┐    │
+│  │  File: src/App.tsx                                              │    │
+│  │                                                                 │    │
+│  │  Check instructions/*.instructions.md files:                    │    │
+│  │                                                                 │    │
+│  │  ├── ck-frontend.instructions.md                                │    │
+│  │  │   applyTo: "**/*.{tsx,jsx}" → MATCH ✓                        │    │
+│  │  │                                                              │    │
+│  │  ├── ck-testing.instructions.md                                 │    │
+│  │  │   applyTo: "**/*.test.ts" → NO MATCH ✗                       │    │
+│  │  │                                                              │    │
+│  │  └── ck-backend.instructions.md                                 │    │
+│  │      applyTo: "src/api/**/*.ts" → NO MATCH ✗                    │    │
+│  └─────────────────────────────────────────────────────────────────┘    │
+└────────────────────────────────┬────────────────────────────────────────┘
+                                 │
+                                 ▼
+┌─────────────────────────────────────────────────────────────────────────┐
+│  CONTEXT ASSEMBLY                                                       │
+│  ─────────────────────────────────────────────────────────────────────  │
+│                                                                         │
+│  Final context includes:                                                │
+│  1. copilot-instructions.md (global - always)                           │
+│  2. ck-frontend.instructions.md (matched)                               │
+│                                                                         │
+└─────────────────────────────────────────────────────────────────────────┘
+```
+
+---
+
+## Skill Activation Flow
+
+```
+┌─────────────────────────────────────────────────────────────────────────┐
+│                      SKILL NEEDED                                       │
+│            Agent needs specialized UI design knowledge                  │
+└────────────────────────────────┬────────────────────────────────────────┘
+                                 │
+                                 ▼
+┌─────────────────────────────────────────────────────────────────────────┐
+│  SKILL LOADING                                                          │
+│  ─────────────────────────────────────────────────────────────────────  │
+│                                                                         │
+│  Load: skills/frontend-design/                                          │
+│                                                                         │
+│  ┌─────────────────────────────────────────────────────────────────┐    │
+│  │  Skill Package Contents:                                        │    │
+│  │                                                                 │    │
+│  │  frontend-design/                                               │    │
+│  │  ├── SKILL.md           ← Main instructions (loaded)            │    │
+│  │  ├── templates/                                                 │    │
+│  │  │   ├── component.tsx  ← Code templates (available)            │    │
+│  │  │   └── styles.css                                             │    │
+│  │  └── examples/                                                  │    │
+│  │      └── hero-section/  ← Reference examples (available)        │    │
+│  └─────────────────────────────────────────────────────────────────┘    │
+└────────────────────────────────┬────────────────────────────────────────┘
+                                 │
+                                 ▼
+┌─────────────────────────────────────────────────────────────────────────┐
+│  CONTEXT ENRICHMENT                                                     │
+│  ─────────────────────────────────────────────────────────────────────  │
+│                                                                         │
+│  Agent context now includes:                                            │
+│  - Original prompt workflow                                             │
+│  - Global + file-specific instructions                                  │
+│  - Skill knowledge (design principles, patterns, templates)             │
+│                                                                         │
+└─────────────────────────────────────────────────────────────────────────┘
+```
+
+---
+
+## Comparison Matrix
+
+```
+┌─────────────┬──────────────┬──────────────┬────────────────┬───────────────┐
+│             │   Trigger    │    Scope     │   Persistence  │    Purpose    │
+├─────────────┼──────────────┼──────────────┼────────────────┼───────────────┤
+│ Prompt      │ /prompt-name │ Single task  │ Per invocation │ Workflow      │
+│ Agent       │ Prompt refs  │ Task exec    │ Per invocation │ Execution     │
+│ Instruction │ Auto (glob)  │ File-based   │ Always active  │ Rules/Style   │
+│ Skill       │ On-demand    │ Knowledge    │ When activated │ Expertise     │
+│ Collection  │ User install │ Resource set │ Permanent      │ Bundling      │
+└─────────────┴──────────────┴──────────────┴────────────────┴───────────────┘
+```
+
+---
+
+## One-liner Summary
+
+> User calls **Prompt** → Prompt uses **Agent** → Agent auto-receives **Instructions** by file pattern → Agent activates **Skills** when needed → All can be bundled in **Collection**.