cokit-cli 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FAQ.md +5 -5
- package/QUICK-START.md +4 -4
- package/README.md +9 -7
- package/docs/migration-guide.md +12 -12
- package/package.json +1 -1
- package/src/commands/init.js +1 -1
- package/templates/repo/prompts/code.prompt.md +0 -40
- package/templates/repo/prompts/docs.prompt.md +0 -29
- package/templates/repo/prompts/fix.prompt.md +0 -35
- package/templates/repo/prompts/plan.prompt.md +0 -41
- package/templates/repo/prompts/review.prompt.md +0 -38
- package/templates/repo/prompts/test.prompt.md +0 -29
- /package/skills/{code-review → ck-code-review}/SKILL.md +0 -0
- /package/skills/{code-review → ck-code-review}/references/code-review-reception.md +0 -0
- /package/skills/{code-review → ck-code-review}/references/verification-before-completion.md +0 -0
- /package/skills/{debugging → ck-debugging}/SKILL.md +0 -0
- /package/skills/{debugging → ck-debugging}/references/root-cause-tracing.md +0 -0
- /package/skills/{debugging → ck-debugging}/references/systematic-debugging.md +0 -0
- /package/skills/{debugging → ck-debugging}/references/verification.md +0 -0
- /package/skills/{docs-seeker → ck-docs-seeker}/SKILL.md +0 -0
- /package/skills/{docs-seeker → ck-docs-seeker}/references/search-patterns.md +0 -0
- /package/skills/{docs-seeker → ck-docs-seeker}/references/source-evaluation.md +0 -0
- /package/skills/{planning → ck-planning}/SKILL.md +0 -0
- /package/skills/{planning → ck-planning}/references/plan-organization.md +0 -0
- /package/skills/{planning → ck-planning}/references/research-phase.md +0 -0
- /package/skills/{planning → ck-planning}/references/solution-design.md +0 -0
- /package/skills/{sequential-thinking → ck-sequential-thinking}/SKILL.md +0 -0
- /package/skills/{sequential-thinking → ck-sequential-thinking}/references/advanced-techniques.md +0 -0
- /package/skills/{sequential-thinking → ck-sequential-thinking}/references/core-patterns.md +0 -0
- /package/templates/repo/.github/instructions/{backend.instructions.md → ck-backend.instructions.md} +0 -0
- /package/templates/repo/.github/instructions/{development.instructions.md → ck-development.instructions.md} +0 -0
- /package/templates/repo/.github/instructions/{frontend.instructions.md → ck-frontend.instructions.md} +0 -0
- /package/templates/repo/.github/instructions/{testing.instructions.md → ck-testing.instructions.md} +0 -0
- /package/templates/repo/.github/prompts/{code.prompt.md → ck-code.prompt.md} +0 -0
- /package/templates/repo/.github/prompts/{docs.prompt.md → ck-docs.prompt.md} +0 -0
- /package/templates/repo/.github/prompts/{fix.prompt.md → ck-fix.prompt.md} +0 -0
- /package/templates/repo/.github/prompts/{plan.prompt.md → ck-plan.prompt.md} +0 -0
- /package/templates/repo/.github/prompts/{review.prompt.md → ck-review.prompt.md} +0 -0
- /package/templates/repo/.github/prompts/{test.prompt.md → ck-test.prompt.md} +0 -0
- /package/templates/repo/.github/skills/{code-review → ck-code-review}/SKILL.md +0 -0
- /package/templates/repo/.github/skills/{debugging → ck-debugging}/SKILL.md +0 -0
package/FAQ.md
CHANGED
|
@@ -28,7 +28,7 @@ Yes! Edit any `.prompt.md` file in `.github/prompts/`.
|
|
|
28
28
|
|
|
29
29
|
Type the prompt name in Copilot Chat:
|
|
30
30
|
```
|
|
31
|
-
/fix my login function throws an error
|
|
31
|
+
/ck-fix my login function throws an error
|
|
32
32
|
```
|
|
33
33
|
|
|
34
34
|
### Why isn't Copilot responding to my prompts?
|
|
@@ -55,12 +55,12 @@ Your instructions here...
|
|
|
55
55
|
**Repo-level (`.github/`):**
|
|
56
56
|
- `copilot-instructions.md` - Project rules
|
|
57
57
|
- `AGENTS.md` - Agent behavior
|
|
58
|
-
- `prompts
|
|
59
|
-
- `skills
|
|
60
|
-
- `instructions
|
|
58
|
+
- `prompts/ck-*.prompt.md` - 6 prompt files (ck-fix, ck-plan, etc.)
|
|
59
|
+
- `skills/ck-*/SKILL.md` - 2 skill files (ck-debugging, ck-code-review)
|
|
60
|
+
- `instructions/ck-*.instructions.md` - 4 instruction files
|
|
61
61
|
|
|
62
62
|
**User-level (`~/.copilot/skills/`):**
|
|
63
|
-
- 5 skill directories
|
|
63
|
+
- 5 skill directories: ck-debugging, ck-code-review, ck-planning, ck-docs-seeker, ck-sequential-thinking
|
|
64
64
|
|
|
65
65
|
### Does CoKit modify my code?
|
|
66
66
|
|
package/QUICK-START.md
CHANGED
|
@@ -12,7 +12,7 @@ Open your project in VS Code.
|
|
|
12
12
|
|
|
13
13
|
## Step 3: Try It
|
|
14
14
|
|
|
15
|
-
Type `/fix` in Copilot Chat.
|
|
15
|
+
Type `/ck-fix` in Copilot Chat.
|
|
16
16
|
|
|
17
17
|
## Done!
|
|
18
18
|
|
|
@@ -24,9 +24,9 @@ You now have 6 prompts and 5 skills ready to use.
|
|
|
24
24
|
|
|
25
25
|
Try these prompts in Copilot Chat:
|
|
26
26
|
|
|
27
|
-
- `/fix` - Got a bug? Copilot will debug it
|
|
28
|
-
- `/plan` - Need a feature? Copilot will plan it
|
|
29
|
-
- `/review` - Ready to commit? Copilot will review it
|
|
27
|
+
- `/ck-fix` - Got a bug? Copilot will debug it
|
|
28
|
+
- `/ck-plan` - Need a feature? Copilot will plan it
|
|
29
|
+
- `/ck-review` - Ready to commit? Copilot will review it
|
|
30
30
|
|
|
31
31
|
## Need Help?
|
|
32
32
|
|
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ Make GitHub Copilot smarter in 30 seconds.
|
|
|
11
11
|
npx cokit init
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
That's it! Now open VS Code and try `/fix` in Copilot Chat.
|
|
14
|
+
That's it! Now open VS Code and try `/ck-fix` in Copilot Chat.
|
|
15
15
|
|
|
16
16
|
## What You Get
|
|
17
17
|
|
|
@@ -19,12 +19,14 @@ That's it! Now open VS Code and try `/fix` in Copilot Chat.
|
|
|
19
19
|
|
|
20
20
|
| Command | What it does |
|
|
21
21
|
|---------|--------------|
|
|
22
|
-
| `/fix` | Debug and fix code issues |
|
|
23
|
-
| `/plan` | Create implementation plans |
|
|
24
|
-
| `/review` | Review code before committing |
|
|
25
|
-
| `/test` | Write tests for your code |
|
|
26
|
-
| `/code` | Implement from a plan |
|
|
27
|
-
| `/docs` | Update documentation |
|
|
22
|
+
| `/ck-fix` | Debug and fix code issues |
|
|
23
|
+
| `/ck-plan` | Create implementation plans |
|
|
24
|
+
| `/ck-review` | Review code before committing |
|
|
25
|
+
| `/ck-test` | Write tests for your code |
|
|
26
|
+
| `/ck-code` | Implement from a plan |
|
|
27
|
+
| `/ck-docs` | Update documentation |
|
|
28
|
+
|
|
29
|
+
> **Why `ck-` prefix?** Prevents conflicts with other tools. Easy to identify CoKit prompts.
|
|
28
30
|
|
|
29
31
|
### Skills (automatic)
|
|
30
32
|
|
package/docs/migration-guide.md
CHANGED
|
@@ -6,12 +6,12 @@ This guide helps Claude Code users adapt to GitHub Copilot with CoKit.
|
|
|
6
6
|
|
|
7
7
|
| Feature | Claude Code | CoKit/Copilot |
|
|
8
8
|
|---------|-------------|---------------|
|
|
9
|
-
| Commands | `/fix:types`, `/plan:auto` | `/fix`, `/plan` |
|
|
9
|
+
| Commands | `/fix:types`, `/plan:auto` | `/ck-fix`, `/ck-plan` |
|
|
10
10
|
| Arguments | `$ARGUMENTS` variable | User provides in chat |
|
|
11
11
|
| Subagents | Task tool with agents | Single Copilot agent |
|
|
12
12
|
| Hooks | Pre/post execution | Not supported |
|
|
13
|
-
| Skills | `~/.claude/skills/` | `~/.copilot/skills
|
|
14
|
-
| Prompts | `~/.claude/commands/` | `.github/prompts
|
|
13
|
+
| Skills | `~/.claude/skills/` | `~/.copilot/skills/ck-*/` |
|
|
14
|
+
| Prompts | `~/.claude/commands/` | `.github/prompts/ck-*.prompt.md` |
|
|
15
15
|
|
|
16
16
|
## What's Different
|
|
17
17
|
|
|
@@ -25,8 +25,8 @@ This guide helps Claude Code users adapt to GitHub Copilot with CoKit.
|
|
|
25
25
|
|
|
26
26
|
**Copilot:**
|
|
27
27
|
```
|
|
28
|
-
/fix the type errors in auth.ts
|
|
29
|
-
/fix the failing tests in user.test.ts
|
|
28
|
+
/ck-fix the type errors in auth.ts
|
|
29
|
+
/ck-fix the failing tests in user.test.ts
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
Provide context directly in your message.
|
|
@@ -78,11 +78,11 @@ After fixing:
|
|
|
78
78
|
|
|
79
79
|
| Claude Skill | CoKit Skill | Notes |
|
|
80
80
|
|--------------|-------------|-------|
|
|
81
|
-
| debugging | debugging | Same methodology |
|
|
82
|
-
| code-review | code-review | Same principles |
|
|
83
|
-
| planning | planning | Simplified workflow |
|
|
84
|
-
| docs-seeker | docs-seeker | Same search patterns |
|
|
85
|
-
| sequential-thinking | sequential-thinking | Same approach |
|
|
81
|
+
| debugging | ck-debugging | Same methodology |
|
|
82
|
+
| code-review | ck-code-review | Same principles |
|
|
83
|
+
| planning | ck-planning | Simplified workflow |
|
|
84
|
+
| docs-seeker | ck-docs-seeker | Same search patterns |
|
|
85
|
+
| sequential-thinking | ck-sequential-thinking | Same approach |
|
|
86
86
|
|
|
87
87
|
## What Works the Same
|
|
88
88
|
|
|
@@ -100,8 +100,8 @@ After fixing:
|
|
|
100
100
|
|
|
101
101
|
2. Use prompts directly:
|
|
102
102
|
```
|
|
103
|
-
/fix (describe your issue)
|
|
104
|
-
/plan (describe your feature)
|
|
103
|
+
/ck-fix (describe your issue)
|
|
104
|
+
/ck-plan (describe your feature)
|
|
105
105
|
```
|
|
106
106
|
|
|
107
107
|
3. Skills work automatically - no changes needed.
|
package/package.json
CHANGED
package/src/commands/init.js
CHANGED
|
@@ -88,7 +88,7 @@ export const initCommand = new Command('init')
|
|
|
88
88
|
|
|
89
89
|
// Success message
|
|
90
90
|
done('Done! Open VS Code and start using Copilot.');
|
|
91
|
-
hint('Try typing /fix in Copilot Chat.');
|
|
91
|
+
hint('Try typing /ck-fix in Copilot Chat.');
|
|
92
92
|
console.log();
|
|
93
93
|
|
|
94
94
|
} catch (err) {
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
mode: agent
|
|
3
|
-
description: Implement from existing plan
|
|
4
|
-
---
|
|
5
|
-
# Implement Plan
|
|
6
|
-
|
|
7
|
-
Implement the specified plan phase.
|
|
8
|
-
|
|
9
|
-
## Process
|
|
10
|
-
|
|
11
|
-
1. **Read Plan**
|
|
12
|
-
- Load plan.md completely
|
|
13
|
-
- Identify current phase
|
|
14
|
-
- List tasks to complete
|
|
15
|
-
|
|
16
|
-
2. **Implement**
|
|
17
|
-
- Work through tasks sequentially
|
|
18
|
-
- Follow existing patterns
|
|
19
|
-
- Run type checks frequently
|
|
20
|
-
|
|
21
|
-
3. **Test**
|
|
22
|
-
- Write tests for new code
|
|
23
|
-
- Run full test suite
|
|
24
|
-
- Fix any failures
|
|
25
|
-
|
|
26
|
-
4. **Review**
|
|
27
|
-
- Check for security issues
|
|
28
|
-
- Verify error handling
|
|
29
|
-
- Ensure code quality
|
|
30
|
-
|
|
31
|
-
5. **Complete**
|
|
32
|
-
- Update plan status
|
|
33
|
-
- Summarize changes
|
|
34
|
-
- List remaining work
|
|
35
|
-
|
|
36
|
-
## Guidelines
|
|
37
|
-
- Follow YAGNI/KISS/DRY
|
|
38
|
-
- Keep files under 200 lines
|
|
39
|
-
- Document complex logic
|
|
40
|
-
- No TODO without issue tracking
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
mode: agent
|
|
3
|
-
description: Update project documentation
|
|
4
|
-
---
|
|
5
|
-
# Update Documentation
|
|
6
|
-
|
|
7
|
-
Update documentation for recent changes.
|
|
8
|
-
|
|
9
|
-
## Process
|
|
10
|
-
|
|
11
|
-
1. **Identify Changes**
|
|
12
|
-
- Review recent commits
|
|
13
|
-
- List new features
|
|
14
|
-
- Note API changes
|
|
15
|
-
|
|
16
|
-
2. **Update Docs**
|
|
17
|
-
- README.md for user-facing changes
|
|
18
|
-
- API docs for endpoint changes
|
|
19
|
-
- Architecture docs for structural changes
|
|
20
|
-
|
|
21
|
-
3. **Verify**
|
|
22
|
-
- Links work
|
|
23
|
-
- Examples accurate
|
|
24
|
-
- No outdated references
|
|
25
|
-
|
|
26
|
-
## Guidelines
|
|
27
|
-
- Keep concise
|
|
28
|
-
- Use examples
|
|
29
|
-
- Update table of contents
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
mode: agent
|
|
3
|
-
description: Debug and fix code issues
|
|
4
|
-
---
|
|
5
|
-
# Fix Issue
|
|
6
|
-
|
|
7
|
-
Analyze the described issue and fix it systematically.
|
|
8
|
-
|
|
9
|
-
## Process
|
|
10
|
-
|
|
11
|
-
1. **Identify Issue Type**
|
|
12
|
-
- Type errors → Check TypeScript config, type definitions
|
|
13
|
-
- UI/UX issues → Check styles, layout, responsiveness
|
|
14
|
-
- Test failures → Run tests, analyze failures
|
|
15
|
-
- Build errors → Check dependencies, config
|
|
16
|
-
|
|
17
|
-
2. **Investigate Root Cause**
|
|
18
|
-
- Read error messages completely
|
|
19
|
-
- Find working examples in codebase
|
|
20
|
-
- Trace back to source of problem
|
|
21
|
-
|
|
22
|
-
3. **Apply Fix**
|
|
23
|
-
- Make minimal changes
|
|
24
|
-
- Follow existing patterns
|
|
25
|
-
- Update related tests
|
|
26
|
-
|
|
27
|
-
4. **Verify**
|
|
28
|
-
- Run tests
|
|
29
|
-
- Check types compile
|
|
30
|
-
- Confirm issue resolved
|
|
31
|
-
|
|
32
|
-
## Guidelines
|
|
33
|
-
- No fixes without understanding root cause
|
|
34
|
-
- One fix at a time
|
|
35
|
-
- Verify before claiming done
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
mode: agent
|
|
3
|
-
description: Create implementation plan for features
|
|
4
|
-
---
|
|
5
|
-
# Create Plan
|
|
6
|
-
|
|
7
|
-
Create a detailed implementation plan for the described task.
|
|
8
|
-
|
|
9
|
-
## Process
|
|
10
|
-
|
|
11
|
-
1. **Understand Requirements**
|
|
12
|
-
- Clarify scope and constraints
|
|
13
|
-
- Identify dependencies
|
|
14
|
-
- Note assumptions
|
|
15
|
-
|
|
16
|
-
2. **Research**
|
|
17
|
-
- Review relevant codebase areas
|
|
18
|
-
- Check existing patterns
|
|
19
|
-
- Identify technical approach
|
|
20
|
-
|
|
21
|
-
3. **Design Solution**
|
|
22
|
-
- Break into phases
|
|
23
|
-
- List tasks per phase
|
|
24
|
-
- Estimate effort
|
|
25
|
-
|
|
26
|
-
4. **Document Plan**
|
|
27
|
-
- Create plan file in ./plans/
|
|
28
|
-
- Include success criteria
|
|
29
|
-
- List open questions
|
|
30
|
-
|
|
31
|
-
## Output
|
|
32
|
-
Create `./plans/{date}-{name}/plan.md` with:
|
|
33
|
-
- Overview (1-3 sentences)
|
|
34
|
-
- Phases table
|
|
35
|
-
- Success criteria checklist
|
|
36
|
-
- Unresolved questions
|
|
37
|
-
|
|
38
|
-
## Principles
|
|
39
|
-
- YAGNI: Don't over-engineer
|
|
40
|
-
- KISS: Prefer simple solutions
|
|
41
|
-
- DRY: Identify reusable patterns
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
mode: agent
|
|
3
|
-
description: Review code for issues
|
|
4
|
-
---
|
|
5
|
-
# Code Review
|
|
6
|
-
|
|
7
|
-
Review the specified code for quality and issues.
|
|
8
|
-
|
|
9
|
-
## Check Categories
|
|
10
|
-
|
|
11
|
-
### Security
|
|
12
|
-
- [ ] Input validation
|
|
13
|
-
- [ ] No hardcoded secrets
|
|
14
|
-
- [ ] SQL injection prevention
|
|
15
|
-
- [ ] XSS prevention
|
|
16
|
-
|
|
17
|
-
### Performance
|
|
18
|
-
- [ ] No N+1 queries
|
|
19
|
-
- [ ] Appropriate caching
|
|
20
|
-
- [ ] No memory leaks
|
|
21
|
-
|
|
22
|
-
### Quality
|
|
23
|
-
- [ ] YAGNI compliance
|
|
24
|
-
- [ ] KISS compliance
|
|
25
|
-
- [ ] DRY compliance
|
|
26
|
-
- [ ] Error handling
|
|
27
|
-
- [ ] Test coverage
|
|
28
|
-
|
|
29
|
-
### Maintainability
|
|
30
|
-
- [ ] Clear naming
|
|
31
|
-
- [ ] Reasonable file size
|
|
32
|
-
- [ ] Documentation for complex logic
|
|
33
|
-
|
|
34
|
-
## Output
|
|
35
|
-
List issues by severity:
|
|
36
|
-
- **Critical**: Must fix before merge
|
|
37
|
-
- **Important**: Should fix soon
|
|
38
|
-
- **Minor**: Nice to have
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
mode: agent
|
|
3
|
-
description: Run tests and analyze results
|
|
4
|
-
---
|
|
5
|
-
# Run Tests
|
|
6
|
-
|
|
7
|
-
Run the test suite and analyze results.
|
|
8
|
-
|
|
9
|
-
## Process
|
|
10
|
-
|
|
11
|
-
1. **Run Tests**
|
|
12
|
-
- Execute test command (npm test, pytest, etc.)
|
|
13
|
-
- Capture full output
|
|
14
|
-
|
|
15
|
-
2. **Analyze Results**
|
|
16
|
-
- Count passed/failed/skipped
|
|
17
|
-
- Identify failure patterns
|
|
18
|
-
- Check for flaky tests
|
|
19
|
-
|
|
20
|
-
3. **Report**
|
|
21
|
-
- Summary: X passed, Y failed, Z skipped
|
|
22
|
-
- List failing tests with error messages
|
|
23
|
-
- Suggest fixes for failures
|
|
24
|
-
|
|
25
|
-
## If Tests Fail
|
|
26
|
-
- Read error message completely
|
|
27
|
-
- Find root cause before fixing
|
|
28
|
-
- Fix one issue at a time
|
|
29
|
-
- Re-run to verify fix
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/skills/{sequential-thinking → ck-sequential-thinking}/references/advanced-techniques.md
RENAMED
|
File without changes
|
|
File without changes
|
/package/templates/repo/.github/instructions/{backend.instructions.md → ck-backend.instructions.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
/package/templates/repo/.github/instructions/{testing.instructions.md → ck-testing.instructions.md}
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|