cokit-cli 1.0.0
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 +102 -0
- package/LICENSE +32 -0
- package/QUICK-START.md +37 -0
- package/README.md +110 -0
- package/bin/cokit.js +4 -0
- package/docs/cokit-comprehensive-mapping-guide.md +937 -0
- package/docs/cokit-slides.md +205 -0
- package/docs/cokit-team-presentation.md +319 -0
- package/docs/migration-guide.md +120 -0
- package/docs/project-roadmap.md +257 -0
- package/package.json +35 -0
- package/plans/260106-1102-cokit-implementation/phases/phase-01-cli-tool.md +151 -0
- package/plans/260106-1102-cokit-implementation/phases/phase-02-repo-level-templates.md +198 -0
- package/plans/260106-1102-cokit-implementation/phases/phase-03-user-level-skills.md +219 -0
- package/plans/260106-1102-cokit-implementation/phases/phase-04-prompt-files.md +328 -0
- package/plans/260106-1102-cokit-implementation/phases/phase-05-documentation.md +166 -0
- package/plans/260106-1102-cokit-implementation/plan.md +130 -0
- package/plans/260106-1102-cokit-implementation/research/researcher-01-copilot-skills-spec.md +182 -0
- package/plans/260106-1102-cokit-implementation/research/researcher-02-copilot-instructions-prompts.md +201 -0
- package/plans/reports/code-reviewer-260106-1718-phase2-repo-templates.md +184 -0
- package/plans/reports/code-reviewer-260106-1728-phase3-review.md +486 -0
- package/plans/reports/code-reviewer-260106-1742-phase4-prompts.md +235 -0
- package/plans/reports/code-reviewer-260106-1753-phase5-docs.md +275 -0
- package/plans/reports/docs-manager-260106-1217-phase1-completion.md +45 -0
- package/plans/reports/docs-manager-260106-1734-phase3-skills.md +108 -0
- package/plans/reports/docs-manager-260106-1746-phase4-prompt-files.md +75 -0
- package/plans/reports/project-manager-260106-1734-SUMMARY.md +354 -0
- package/plans/reports/project-manager-260106-1734-phase3-completion.md +257 -0
- package/plans/reports/project-manager-260106-1734-phase3-to-phase4-transition.md +274 -0
- package/plans/reports/project-manager-260106-1734-phase4-kickoff.md +343 -0
- package/plans/reports/project-manager-260106-1734-project-status.md +355 -0
- package/plans/reports/project-manager-260106-1746-phase4-completion.md +249 -0
- package/plans/reports/project-manager-260106-1746-phase4-deliverables.md +350 -0
- package/plans/reports/project-manager-260106-1804-project-complete.md +297 -0
- package/plans/reports/tester-260106-1717-phase2-templates.md +216 -0
- package/plans/reports/tester-260106-1726-phase3-user-skills.md +256 -0
- package/plans/reports/tester-260106-1741-phase4-prompts.md +202 -0
- package/plans/reports/tester-260106-1751-phase5-docs.md +301 -0
- package/skills/code-review/SKILL.md +86 -0
- package/skills/code-review/references/code-review-reception.md +76 -0
- package/skills/code-review/references/verification-before-completion.md +86 -0
- package/skills/debugging/SKILL.md +70 -0
- package/skills/debugging/references/root-cause-tracing.md +65 -0
- package/skills/debugging/references/systematic-debugging.md +74 -0
- package/skills/debugging/references/verification.md +74 -0
- package/skills/docs-seeker/SKILL.md +91 -0
- package/skills/docs-seeker/references/search-patterns.md +93 -0
- package/skills/docs-seeker/references/source-evaluation.md +77 -0
- package/skills/planning/SKILL.md +82 -0
- package/skills/planning/references/plan-organization.md +88 -0
- package/skills/planning/references/research-phase.md +56 -0
- package/skills/planning/references/solution-design.md +65 -0
- package/skills/sequential-thinking/SKILL.md +80 -0
- package/skills/sequential-thinking/references/advanced-techniques.md +88 -0
- package/skills/sequential-thinking/references/core-patterns.md +87 -0
- package/src/commands/add.js +93 -0
- package/src/commands/doctor.js +117 -0
- package/src/commands/init.js +152 -0
- package/src/commands/list.js +91 -0
- package/src/commands/update.js +22 -0
- package/src/index.js +23 -0
- package/src/utils/colors.js +14 -0
- package/src/utils/copy.js +122 -0
- package/src/utils/paths.js +35 -0
- package/templates/repo/.github/.cokit-version +4 -0
- package/templates/repo/.github/AGENTS.md +55 -0
- package/templates/repo/.github/copilot-instructions.md +45 -0
- package/templates/repo/.github/instructions/backend.instructions.md +35 -0
- package/templates/repo/.github/instructions/development.instructions.md +25 -0
- package/templates/repo/.github/instructions/frontend.instructions.md +31 -0
- package/templates/repo/.github/instructions/testing.instructions.md +31 -0
- package/templates/repo/.github/prompts/code.prompt.md +28 -0
- package/templates/repo/.github/prompts/docs.prompt.md +23 -0
- package/templates/repo/.github/prompts/fix.prompt.md +24 -0
- package/templates/repo/.github/prompts/plan.prompt.md +24 -0
- package/templates/repo/.github/prompts/review.prompt.md +24 -0
- package/templates/repo/.github/prompts/test.prompt.md +23 -0
- package/templates/repo/.github/skills/code-review/SKILL.md +46 -0
- package/templates/repo/.github/skills/debugging/SKILL.md +34 -0
- package/templates/repo/.vscode/settings.json +6 -0
- package/templates/repo/prompts/code.prompt.md +40 -0
- package/templates/repo/prompts/docs.prompt.md +29 -0
- package/templates/repo/prompts/fix.prompt.md +35 -0
- package/templates/repo/prompts/plan.prompt.md +41 -0
- package/templates/repo/prompts/review.prompt.md +38 -0
- package/templates/repo/prompts/test.prompt.md +29 -0
package/FAQ.md
ADDED
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# FAQ
|
|
2
|
+
|
|
3
|
+
## Installation
|
|
4
|
+
|
|
5
|
+
### What's the difference between repo and global?
|
|
6
|
+
|
|
7
|
+
| Type | Location | Scope | Share with Team |
|
|
8
|
+
|------|----------|-------|-----------------|
|
|
9
|
+
| Repo | `.github/` | This project only | Yes (via git) |
|
|
10
|
+
| Global | `~/.copilot/skills/` | All your projects | No |
|
|
11
|
+
|
|
12
|
+
### Do I need to edit any files?
|
|
13
|
+
|
|
14
|
+
No. Just run `npx cokit init` and you're done.
|
|
15
|
+
|
|
16
|
+
### Can I customize the prompts?
|
|
17
|
+
|
|
18
|
+
Yes! Edit any `.prompt.md` file in `.github/prompts/`.
|
|
19
|
+
|
|
20
|
+
### Does this work with JetBrains IDEs?
|
|
21
|
+
|
|
22
|
+
- **Prompts**: Yes
|
|
23
|
+
- **Skills**: Partial support (check JetBrains docs)
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
### How do I use a prompt?
|
|
28
|
+
|
|
29
|
+
Type the prompt name in Copilot Chat:
|
|
30
|
+
```
|
|
31
|
+
/fix my login function throws an error
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Why isn't Copilot responding to my prompts?
|
|
35
|
+
|
|
36
|
+
1. Restart VS Code after installing
|
|
37
|
+
2. Make sure Copilot extension is active
|
|
38
|
+
3. Run `npx cokit doctor` to check setup
|
|
39
|
+
|
|
40
|
+
### Can I add my own prompts?
|
|
41
|
+
|
|
42
|
+
Yes! Create a file like `.github/prompts/my-prompt.prompt.md`:
|
|
43
|
+
```yaml
|
|
44
|
+
---
|
|
45
|
+
mode: agent
|
|
46
|
+
description: What this prompt does
|
|
47
|
+
---
|
|
48
|
+
Your instructions here...
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Technical
|
|
52
|
+
|
|
53
|
+
### What files does CoKit create?
|
|
54
|
+
|
|
55
|
+
**Repo-level (`.github/`):**
|
|
56
|
+
- `copilot-instructions.md` - Project rules
|
|
57
|
+
- `AGENTS.md` - Agent behavior
|
|
58
|
+
- `prompts/*.prompt.md` - 6 prompt files
|
|
59
|
+
- `skills/*/SKILL.md` - 2 skill files
|
|
60
|
+
- `instructions/*.instructions.md` - 4 instruction files
|
|
61
|
+
|
|
62
|
+
**User-level (`~/.copilot/skills/`):**
|
|
63
|
+
- 5 skill directories with SKILL.md + references
|
|
64
|
+
|
|
65
|
+
### Does CoKit modify my code?
|
|
66
|
+
|
|
67
|
+
No. It only creates configuration files for Copilot.
|
|
68
|
+
|
|
69
|
+
### How do I uninstall?
|
|
70
|
+
|
|
71
|
+
Delete the files:
|
|
72
|
+
```bash
|
|
73
|
+
rm -rf .github/prompts .github/skills .github/instructions
|
|
74
|
+
rm .github/copilot-instructions.md .github/AGENTS.md
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
For global:
|
|
78
|
+
```bash
|
|
79
|
+
rm -rf ~/.copilot/skills
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Troubleshooting
|
|
83
|
+
|
|
84
|
+
### "Permission denied" error
|
|
85
|
+
|
|
86
|
+
Use sudo (macOS/Linux) or run as admin (Windows):
|
|
87
|
+
```bash
|
|
88
|
+
sudo npx cokit init --global
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### "Node.js not found"
|
|
92
|
+
|
|
93
|
+
Install Node.js 18+ from https://nodejs.org
|
|
94
|
+
|
|
95
|
+
### Skills not working
|
|
96
|
+
|
|
97
|
+
Enable in VS Code settings:
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"github.copilot.chat.useAgentSkills": true
|
|
101
|
+
}
|
|
102
|
+
```
|
package/LICENSE
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
Creative Commons Attribution-NonCommercial 4.0 International License (CC BY-NC 4.0)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 camping89
|
|
4
|
+
|
|
5
|
+
This work is licensed under the Creative Commons Attribution-NonCommercial 4.0
|
|
6
|
+
International License.
|
|
7
|
+
|
|
8
|
+
You are free to:
|
|
9
|
+
- Share: copy and redistribute the material in any medium or format
|
|
10
|
+
- Adapt: remix, transform, and build upon the material
|
|
11
|
+
|
|
12
|
+
Under the following terms:
|
|
13
|
+
- Attribution: You must give appropriate credit, provide a link to the license,
|
|
14
|
+
and indicate if changes were made.
|
|
15
|
+
- NonCommercial: You may not use the material for commercial purposes.
|
|
16
|
+
This includes use by companies, corporations, or for-profit organizations.
|
|
17
|
+
|
|
18
|
+
No additional restrictions: You may not apply legal terms or technological
|
|
19
|
+
measures that legally restrict others from doing anything the license permits.
|
|
20
|
+
|
|
21
|
+
PERMITTED USES:
|
|
22
|
+
- Personal projects
|
|
23
|
+
- Educational purposes
|
|
24
|
+
- Academic research
|
|
25
|
+
- Non-profit organizations
|
|
26
|
+
|
|
27
|
+
PROHIBITED USES:
|
|
28
|
+
- Commercial products or services
|
|
29
|
+
- Corporate/company internal use
|
|
30
|
+
- Revenue-generating applications
|
|
31
|
+
|
|
32
|
+
Full license text: https://creativecommons.org/licenses/by-nc/4.0/legalcode
|
package/QUICK-START.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# 30-Second Setup
|
|
2
|
+
|
|
3
|
+
## Step 1: Install
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npx cokit init
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Step 2: Open VS Code
|
|
10
|
+
|
|
11
|
+
Open your project in VS Code.
|
|
12
|
+
|
|
13
|
+
## Step 3: Try It
|
|
14
|
+
|
|
15
|
+
Type `/fix` in Copilot Chat.
|
|
16
|
+
|
|
17
|
+
## Done!
|
|
18
|
+
|
|
19
|
+
You now have 6 prompts and 5 skills ready to use.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## What's Next?
|
|
24
|
+
|
|
25
|
+
Try these prompts in Copilot Chat:
|
|
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
|
|
30
|
+
|
|
31
|
+
## Need Help?
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npx cokit doctor
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
This checks your setup and suggests fixes.
|
package/README.md
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# CoKit
|
|
2
|
+
|
|
3
|
+
Make GitHub Copilot smarter in 30 seconds.
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/cokit)
|
|
6
|
+
[](https://creativecommons.org/licenses/by-nc/4.0/)
|
|
7
|
+
|
|
8
|
+
## Quick Start
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npx cokit init
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
That's it! Now open VS Code and try `/fix` in Copilot Chat.
|
|
15
|
+
|
|
16
|
+
## What You Get
|
|
17
|
+
|
|
18
|
+
### Prompts (type in Copilot Chat)
|
|
19
|
+
|
|
20
|
+
| Command | What it does |
|
|
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 |
|
|
28
|
+
|
|
29
|
+
### Skills (automatic)
|
|
30
|
+
|
|
31
|
+
CoKit teaches Copilot how to:
|
|
32
|
+
- Debug systematically (not randomly)
|
|
33
|
+
- Review code like a senior dev
|
|
34
|
+
- Plan before coding
|
|
35
|
+
- Find documentation efficiently
|
|
36
|
+
- Think through complex problems
|
|
37
|
+
|
|
38
|
+
## Installation Options
|
|
39
|
+
|
|
40
|
+
### Option 1: Project Only (Recommended)
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx cokit init
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Creates files in `.github/` - share with your team via git.
|
|
47
|
+
|
|
48
|
+
### Option 2: Personal Skills
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npx cokit init --global
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Creates files in `~/.copilot/skills/` - works in all projects.
|
|
55
|
+
|
|
56
|
+
### Option 3: Both
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
npx cokit init --all
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Commands
|
|
63
|
+
|
|
64
|
+
| Command | Description |
|
|
65
|
+
|---------|-------------|
|
|
66
|
+
| `cokit init` | Set up CoKit in your project |
|
|
67
|
+
| `cokit add <skill>` | Add a specific skill |
|
|
68
|
+
| `cokit list` | Show available skills and prompts |
|
|
69
|
+
| `cokit doctor` | Check your setup |
|
|
70
|
+
| `cokit update` | Update to latest version |
|
|
71
|
+
|
|
72
|
+
## Troubleshooting
|
|
73
|
+
|
|
74
|
+
Run the doctor:
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
npx cokit doctor
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Common Issues
|
|
81
|
+
|
|
82
|
+
**"Copilot doesn't see my prompts"**
|
|
83
|
+
- Restart VS Code after running `npx cokit init`
|
|
84
|
+
|
|
85
|
+
**"Skills not working"**
|
|
86
|
+
- Enable in VS Code: Settings → `github.copilot.chat.useAgentSkills`
|
|
87
|
+
|
|
88
|
+
**"Command not found"**
|
|
89
|
+
- Make sure you have Node.js 18+ installed
|
|
90
|
+
|
|
91
|
+
## For Claude Code Users
|
|
92
|
+
|
|
93
|
+
Migrating from Claude Code? See [Migration Guide](docs/migration-guide.md).
|
|
94
|
+
|
|
95
|
+
Key differences:
|
|
96
|
+
- No hooks (static config only)
|
|
97
|
+
- No subagents (single Copilot agent)
|
|
98
|
+
- No `$ARGUMENTS` (user provides context in chat)
|
|
99
|
+
|
|
100
|
+
## Documentation
|
|
101
|
+
|
|
102
|
+
- [Quick Start](QUICK-START.md) - 30-second setup
|
|
103
|
+
- [FAQ](FAQ.md) - Common questions
|
|
104
|
+
- [Migration Guide](docs/migration-guide.md) - For Claude Code users
|
|
105
|
+
|
|
106
|
+
## License
|
|
107
|
+
|
|
108
|
+
CC BY-NC 4.0 - Free for personal and educational use.
|
|
109
|
+
|
|
110
|
+
Commercial use requires a license. Contact for details.
|
package/bin/cokit.js
ADDED