metacoding 1.5.1 → 2.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/CHANGELOG.md +45 -0
- package/README.md +108 -514
- package/lib/cli.d.ts.map +1 -1
- package/lib/cli.js +18 -19
- package/lib/cli.js.map +1 -1
- package/lib/commands/init.d.ts +8 -14
- package/lib/commands/init.d.ts.map +1 -1
- package/lib/commands/init.js +105 -387
- package/lib/commands/init.js.map +1 -1
- package/lib/commands/update.d.ts +9 -9
- package/lib/commands/update.d.ts.map +1 -1
- package/lib/commands/update.js +141 -320
- package/lib/commands/update.js.map +1 -1
- package/lib/services/backup.d.ts +1 -1
- package/lib/services/backup.d.ts.map +1 -1
- package/lib/services/backup.js +10 -6
- package/lib/services/backup.js.map +1 -1
- package/lib/services/filesystem.d.ts.map +1 -1
- package/lib/services/filesystem.js +11 -5
- package/lib/services/filesystem.js.map +1 -1
- package/lib/services/gitignore-manager.js +5 -5
- package/lib/services/gitignore-manager.js.map +1 -1
- package/lib/services/project-detector.d.ts +9 -8
- package/lib/services/project-detector.d.ts.map +1 -1
- package/lib/services/project-detector.js +79 -197
- package/lib/services/project-detector.js.map +1 -1
- package/lib/services/skill-manager.d.ts +23 -0
- package/lib/services/skill-manager.d.ts.map +1 -0
- package/lib/services/skill-manager.js +212 -0
- package/lib/services/skill-manager.js.map +1 -0
- package/lib/types/index.d.ts +5 -15
- package/lib/types/index.d.ts.map +1 -1
- package/package.json +9 -17
- package/skills/metacoding-workflow/SKILL.md +52 -0
- package/skills/metacoding-workflow/agents/openai.yaml +4 -0
- package/skills/metacoding-workflow/assets/templates/changelog-entry.md +6 -0
- package/skills/metacoding-workflow/assets/templates/project-context.md +18 -0
- package/skills/metacoding-workflow/assets/templates/repeated-task-checklist.md +8 -0
- package/skills/metacoding-workflow/assets/templates/task-entry.md +9 -0
- package/skills/metacoding-workflow/assets/templates/test-plan.md +8 -0
- package/skills/metacoding-workflow/references/javascript.md +7 -0
- package/skills/metacoding-workflow/references/node.md +7 -0
- package/skills/metacoding-workflow/references/platform-adaptation.md +37 -0
- package/skills/metacoding-workflow/references/python.md +7 -0
- package/skills/metacoding-workflow/references/react.md +7 -0
- package/skills/metacoding-workflow/references/repository-organization.md +84 -0
- package/skills/metacoding-workflow/references/typescript.md +7 -0
- package/skills/metacoding-workflow/references/workflow-rules.md +54 -0
- package/skills/vendor-templates/claude-agent.md.template +41 -0
- package/lib/services/assistant-adapter.d.ts +0 -18
- package/lib/services/assistant-adapter.d.ts.map +0 -1
- package/lib/services/assistant-adapter.js +0 -246
- package/lib/services/assistant-adapter.js.map +0 -1
- package/lib/services/cursor.d.ts +0 -47
- package/lib/services/cursor.d.ts.map +0 -1
- package/lib/services/cursor.js +0 -314
- package/lib/services/cursor.js.map +0 -1
- package/lib/services/template-manager.d.ts +0 -23
- package/lib/services/template-manager.d.ts.map +0 -1
- package/lib/services/template-manager.js +0 -374
- package/lib/services/template-manager.js.map +0 -1
- package/lib/services/vscode.d.ts +0 -10
- package/lib/services/vscode.d.ts.map +0 -1
- package/lib/services/vscode.js +0 -108
- package/lib/services/vscode.js.map +0 -1
- package/templates/assistants/AGENTS.md +0 -203
- package/templates/assistants/CLAUDE.md +0 -156
- package/templates/assistants/GEMINI.md +0 -193
- package/templates/general/code-review.instructions.md +0 -265
- package/templates/general/copilot-instructions.md +0 -427
- package/templates/general/docs-update.instructions.md +0 -275
- package/templates/general/release.instructions.md +0 -242
- package/templates/general/template.json +0 -9
- package/templates/general/test-runner.instructions.md +0 -188
- package/templates/javascript/javascript.coding.instructions.md +0 -500
- package/templates/javascript/javascript.docs.instructions.md +0 -563
- package/templates/javascript/javascript.testing.instructions.md +0 -686
- package/templates/javascript/template.json +0 -36
- package/templates/node/nodejs.coding.instructions.md +0 -249
- package/templates/node/nodejs.docs.instructions.md +0 -261
- package/templates/node/nodejs.testing.instructions.md +0 -373
- package/templates/node/template.json +0 -23
- package/templates/python/python.coding.instructions.md +0 -338
- package/templates/python/python.docs.instructions.md +0 -1178
- package/templates/python/python.testing.instructions.md +0 -1073
- package/templates/python/template.json +0 -75
- package/templates/react/react.coding.instructions.md +0 -694
- package/templates/react/react.docs.instructions.md +0 -451
- package/templates/react/react.testing.instructions.md +0 -192
- package/templates/react/template.json +0 -14
- package/templates/react/test-runner.instructions.md +0 -135
- package/templates/typescript/template.json +0 -16
- package/templates/typescript/typescript.coding.instructions.md +0 -368
- package/templates/typescript/typescript.docs.instructions.md +0 -760
- package/templates/typescript/typescript.testing.instructions.md +0 -739
package/README.md
CHANGED
|
@@ -1,552 +1,146 @@
|
|
|
1
|
-
# `metacoding`:
|
|
1
|
+
# `metacoding`: Workflow Skill for Coding Agents
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/metacoding)
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
|
-
[](https://github.com/features/copilot)
|
|
6
|
-
[](https://claude.ai/)
|
|
7
|
-
[](https://www.cursor.com/)
|
|
8
|
-
[](https://cloud.google.com/gemini)
|
|
9
5
|
|
|
10
|
-
|
|
6
|
+
`metacoding` packages a cross-agent workflow skill that enforces disciplined delivery for modern coding agents. Instead of generating editor-specific instruction files, it installs vendor-specific skills for Codex, Claude Code, or Antigravity from one shared workflow bundle.
|
|
11
7
|
|
|
12
|
-
##
|
|
8
|
+
## What It Installs
|
|
13
9
|
|
|
14
|
-
|
|
15
|
-
- [💬 How to Use `metacoding` with AI Assistants](#-how-to-use-metacoding-with-ai-assistants)
|
|
16
|
-
- [🛠 Installation Guide](#-installation-guide)
|
|
17
|
-
- [📦 Using the `metacoding` CLI](#-using-the-metacoding-cli)
|
|
18
|
-
- [🆘 Getting Help](#-getting-help)
|
|
19
|
-
- [🤝 Contributing](#-contributing)
|
|
20
|
-
- [📄 License](#-license)
|
|
10
|
+
Running `metacoding init` now asks which coding agent you use:
|
|
21
11
|
|
|
22
|
-
|
|
12
|
+
- `Codex`
|
|
13
|
+
- `Claude Code`
|
|
14
|
+
- `Antigravity`
|
|
23
15
|
|
|
24
|
-
|
|
16
|
+
You can also pass `--vendor codex`, `--vendor claude-code`, or `--vendor antigravity`.
|
|
17
|
+
For mixed-agent teams, you can use `--vendor all` to install all workspace-scoped variants.
|
|
25
18
|
|
|
26
|
-
|
|
27
|
-
- **Quality standards** that help you avoid common mistakes
|
|
28
|
-
- **Test-driven development** that's encouraged and guided step-by-step
|
|
29
|
-
- **Documentation guidance** that keeps your projects maintainable
|
|
30
|
-
- **Multi-assistant support** with a single canonical workflow adapted for each AI assistant
|
|
19
|
+
The installed entrypoint depends on that choice:
|
|
31
20
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
### The `metacoding` 7-Step Development Workflow
|
|
37
|
-
|
|
38
|
-
Every development task follows this mandatory workflow to ensure quality and consistency:
|
|
39
|
-
|
|
40
|
-
#### Step 1: Describe Your Feature or Task
|
|
41
|
-
|
|
42
|
-
Be specific about what you want to build. Copilot will automatically follow the workflow and create a comprehensive plan for your approval.
|
|
43
|
-
|
|
44
|
-
- **Be specific about requirements**: Clearly describe the feature, functionality, or problem to solve
|
|
45
|
-
- **Provide context**: Include relevant constraints, user needs, or business requirements
|
|
46
|
-
- **Review Copilot's plan**: Copilot will automatically create an implementation outline following workflow standards
|
|
47
|
-
- **Approve or refine**: Confirm the plan meets your needs or request adjustments
|
|
48
|
-
- **Example prompt**: _"I want to add user authentication to my web app. Users should be able to register with email/password, login securely, logout, and have password reset functionality. The system should handle validation errors gracefully."_
|
|
49
|
-
|
|
50
|
-
#### Step 2: Verify Task Documentation
|
|
51
|
-
|
|
52
|
-
Copilot will automatically document tasks following the workflow. Your role is to review and approve the breakdown.
|
|
53
|
-
|
|
54
|
-
- **Review task breakdown**: Copilot will add tasks to your project list and create subtasks
|
|
55
|
-
- **Verify scope boundaries**: Ensure what's included and excluded is clear and appropriate
|
|
56
|
-
- **Approve documentation**: Confirm the task structure before Copilot proceeds to testing
|
|
57
|
-
- **Example verification**: _"Review the authentication tasks you've added. Does this scope make sense for our current iteration?"_
|
|
58
|
-
|
|
59
|
-
#### Step 3: Validate Test Strategy
|
|
60
|
-
|
|
61
|
-
Copilot will automatically document test cases before implementation. You verify the testing approach meets your quality standards.
|
|
62
|
-
|
|
63
|
-
- **Review test documentation**: Copilot will document all test scenarios following TDD principles
|
|
64
|
-
- **Verify coverage**: Ensure happy paths, error scenarios, and edge cases are included
|
|
65
|
-
- **Approve test approach**: Confirm the testing strategy before Copilot implements failing tests
|
|
66
|
-
- **Example verification**: _"Check the test cases you've documented for authentication. Are we covering all the important scenarios?"_
|
|
67
|
-
|
|
68
|
-
#### Step 4: Monitor Implementation Progress
|
|
69
|
-
|
|
70
|
-
Copilot will implement functionality to make tests pass. You track progress and validate the working solution.
|
|
71
|
-
|
|
72
|
-
- **Track implementation**: Copilot will write minimal code following TDD red-green-refactor cycle
|
|
73
|
-
- **Verify test results**: Copilot will run tests and report results - you confirm they're passing
|
|
74
|
-
- **Test functionality yourself**: Validate that the implementation works as expected in practice
|
|
75
|
-
- **Example check**: _"Show me the test results and let me verify the authentication is working correctly."_
|
|
76
|
-
|
|
77
|
-
#### Step 5: Review Documentation Updates
|
|
78
|
-
|
|
79
|
-
Copilot will automatically update all documentation. You verify completeness and accuracy of updates.
|
|
80
|
-
|
|
81
|
-
- **Review documentation changes**: Copilot will update README, API docs, and code comments
|
|
82
|
-
- **Verify task status updates**: Confirm completed work is properly marked in project management docs
|
|
83
|
-
- **Approve changelog entries**: Review user-facing changes recorded in changelog
|
|
84
|
-
- **Example review**: _"Show me what documentation you've updated for the authentication feature. Let me verify it's accurate and complete."_
|
|
85
|
-
|
|
86
|
-
#### Step 6: Approve Version Control
|
|
87
|
-
|
|
88
|
-
Copilot will create proper commits following conventional standards. You approve the commit structure and messages.
|
|
89
|
-
|
|
90
|
-
- **Review commit structure**: Copilot will prepare atomic commits with conventional messages
|
|
91
|
-
- **Verify file inclusion**: Ensure all related files (code, tests, docs) are included together
|
|
92
|
-
- **Approve commits**: Confirm the commit represents complete, working functionality
|
|
93
|
-
- **Example approval**: _"Show me the commit you've prepared for the authentication feature. Does it include everything we've built?"_
|
|
94
|
-
|
|
95
|
-
#### Step 7: Confirm Workflow Completion
|
|
96
|
-
|
|
97
|
-
Copilot will verify workflow completion automatically. You perform final validation before moving to new work.
|
|
98
|
-
|
|
99
|
-
- **Review completion checklist**: Copilot will verify all tests pass, documentation is updated, and changes are committed
|
|
100
|
-
- **Confirm clean repository state**: Verify temporary files are cleaned up and repository is organized
|
|
101
|
-
- **Approve workflow completion**: Give explicit approval before starting any new tasks
|
|
102
|
-
- **Example confirmation**: _"Confirm our authentication workflow is complete and we're ready for the next feature."_
|
|
103
|
-
|
|
104
|
-
### Workflow Enforcement and Quality Assurance
|
|
105
|
-
|
|
106
|
-
`metacoding` enforces strict quality practices:
|
|
107
|
-
|
|
108
|
-
- **Documentation-First Principle**: No coding begins until documentation is complete
|
|
109
|
-
- **Single-Task Focus**: One change at a time - never mix unrelated tasks
|
|
110
|
-
- **Confirmation Gates**: User approval required before proceeding with implementation
|
|
111
|
-
- **Test Coverage**: Comprehensive testing mandatory for all functionality
|
|
112
|
-
- **Repository Hygiene**: Clean up temporary files and maintain organization
|
|
113
|
-
|
|
114
|
-
### Effective Workflow Prompts
|
|
115
|
-
|
|
116
|
-
**Starting a new feature:**
|
|
117
|
-
_"Let's implement feature X following the 7-step workflow. First, help me understand requirements and create an implementation plan."_
|
|
118
|
-
|
|
119
|
-
**During development:**
|
|
120
|
-
_"We're on step 3 of our workflow. Document the test cases for this component before implementing tests."_
|
|
121
|
-
|
|
122
|
-
**Scope management:**
|
|
123
|
-
_"I want to add feature Y, but we're working on feature X. Add Y to the task list and let's complete X first."_
|
|
124
|
-
|
|
125
|
-
**Quality check:**
|
|
126
|
-
_"Review our current workflow step. Are we ready to proceed, or do we need to complete documentation first?"_
|
|
127
|
-
|
|
128
|
-
### Automatic Context Application
|
|
129
|
-
|
|
130
|
-
GitHub Copilot automatically applies relevant instruction files based on your work:
|
|
131
|
-
|
|
132
|
-
- **Test files** → Applies test-driven development and quality standards
|
|
133
|
-
- **Documentation** → Enforces documentation architecture and maintenance guidelines
|
|
134
|
-
- **Code files** → Provides code review criteria and quality standards
|
|
135
|
-
- **Release files** → Guides version management and release procedures
|
|
136
|
-
|
|
137
|
-
### Manual Instruction Reference
|
|
138
|
-
|
|
139
|
-
For specific guidance, explicitly reference instruction files:
|
|
140
|
-
|
|
141
|
-
- _"Use the 7-step workflow to implement user registration"_
|
|
142
|
-
- _"Apply code review guidelines to check this function"_
|
|
143
|
-
- _"Follow test documentation standards to update our test cases"_
|
|
144
|
-
- _"Use release instructions to prepare version 2.1.0"_
|
|
145
|
-
|
|
146
|
-
### Workflow Violations and Corrections
|
|
147
|
-
|
|
148
|
-
If you try to skip steps or mix tasks, Copilot will redirect you:
|
|
149
|
-
|
|
150
|
-
- **Skipping documentation**: _"Let's document this task first before implementing"_
|
|
151
|
-
- **Task switching**: _"I've added that to the task list. Let's complete our current workflow first"_
|
|
152
|
-
- **Missing tests**: _"We need to document and implement tests before the production code"_
|
|
153
|
-
|
|
154
|
-
### Best Practices for Workflow Success
|
|
155
|
-
|
|
156
|
-
1. **Start small**: Begin with simple features to practice the workflow
|
|
157
|
-
2. **Stay focused**: Complete one task fully before starting another
|
|
158
|
-
3. **Trust the process**: The workflow prevents technical debt and quality issues
|
|
159
|
-
4. **Attach context**: Include task lists, documentation, and related files in prompts
|
|
160
|
-
5. **Confirm understanding**: Always confirm plans before implementation begins
|
|
161
|
-
|
|
162
|
-
The `metacoding` workflow transforms chaotic development into a structured, quality-driven process that scales from personal projects to enterprise teams.
|
|
163
|
-
|
|
164
|
-
## 🛠 Installation Guide
|
|
165
|
-
|
|
166
|
-
### Prerequisites
|
|
167
|
-
|
|
168
|
-
Before installing `metacoding`, choose your AI development setup:
|
|
169
|
-
|
|
170
|
-
#### Supported AI Assistants
|
|
171
|
-
|
|
172
|
-
- **GitHub Copilot** (VS Code) - Uses `.github/copilot-instructions.md`
|
|
173
|
-
- **Claude Code** (Terminal or IDE) - Uses `CLAUDE.md`
|
|
174
|
-
- **Codex/OpenAI** (Terminal) - Uses `AGENTS.md`
|
|
175
|
-
- **Gemini Code Assist** (VS Code/IntelliJ) - Uses `GEMINI.md`
|
|
176
|
-
- **Cursor IDE** - Uses `.cursor/rules/*.mdc` files
|
|
177
|
-
|
|
178
|
-
#### General Requirements
|
|
179
|
-
|
|
180
|
-
1. **Node.js** (version 16 or higher) for the CLI tool
|
|
181
|
-
2. **Your chosen AI assistant** configured and ready to use
|
|
182
|
-
3. **Git repository** (recommended but not required)
|
|
183
|
-
|
|
184
|
-
### Quick Setup (Recommended)
|
|
185
|
-
|
|
186
|
-
The easiest way to get started with `metacoding` is using our npm package:
|
|
187
|
-
|
|
188
|
-
1. **Install globally:** `npm install -g metacoding`
|
|
189
|
-
2. **Navigate to your project:** `cd your-project`
|
|
190
|
-
3. **Initialize `metacoding`:** `metacoding init`
|
|
191
|
-
4. **Follow the interactive prompts** to choose your AI setup and you're done!
|
|
192
|
-
|
|
193
|
-
#### Init options
|
|
194
|
-
|
|
195
|
-
**Basic usage:**
|
|
196
|
-
|
|
197
|
-
- `metacoding init` - Interactive setup with environment, IDE, and assistant selection
|
|
198
|
-
- `metacoding init --template react` - Use React template with interactive setup
|
|
199
|
-
- `metacoding init --template node` - Use Node.js template with interactive setup
|
|
200
|
-
- `metacoding init --template javascript` - Use JavaScript template with interactive setup
|
|
201
|
-
- `metacoding init --template python` - Use Python template with interactive setup
|
|
202
|
-
- `metacoding init --force` - Overwrite existing files
|
|
203
|
-
|
|
204
|
-
**Multi-assistant setup (new in v1.5.0):**
|
|
205
|
-
|
|
206
|
-
- `metacoding init --environment ide --ide vscode --assistants copilot` - VS Code with GitHub Copilot only
|
|
207
|
-
- `metacoding init --environment ide --ide vscode --assistants all` - VS Code with all compatible assistants
|
|
208
|
-
- `metacoding init --environment terminal --assistants claude` - Terminal setup for Claude Code
|
|
209
|
-
- `metacoding init --environment terminal --assistants all` - Terminal with Claude, Codex, and Gemini
|
|
210
|
-
- `metacoding init --environment ide --ide intellij --assistants gemini` - IntelliJ with Gemini Code Assist
|
|
211
|
-
|
|
212
|
-
**Legacy direct setup (backward compatible):**
|
|
213
|
-
|
|
214
|
-
- `metacoding init --vscode` - Set up for VS Code + GitHub Copilot (legacy flag)
|
|
215
|
-
- `metacoding init --cursor` - Set up for Cursor IDE (legacy flag)
|
|
216
|
-
- `metacoding init --cursor --template react` - Cursor setup with React template
|
|
217
|
-
|
|
218
|
-
#### Post-Installation Configuration
|
|
219
|
-
|
|
220
|
-
**For GitHub Copilot (VS Code):**
|
|
221
|
-
The CLI automatically configures VS Code settings for custom instructions. If you need to configure manually, add these settings to your VS Code settings.json:
|
|
222
|
-
|
|
223
|
-
```json
|
|
224
|
-
{
|
|
225
|
-
"github.copilot.chat.codeGeneration.useInstructionFiles": true,
|
|
226
|
-
"chat.promptFiles": true
|
|
227
|
-
}
|
|
21
|
+
```text
|
|
22
|
+
Codex: .codex/skills/metacoding-workflow/SKILL.md
|
|
23
|
+
Claude Code: .claude/agents/metacoding-workflow.md
|
|
24
|
+
Antigravity: .agents/skills/metacoding-workflow/SKILL.md
|
|
228
25
|
```
|
|
229
26
|
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
27
|
+
The support bundle is installed alongside the entrypoint. The shared content includes:
|
|
28
|
+
|
|
29
|
+
```text
|
|
30
|
+
references/
|
|
31
|
+
project-context.md
|
|
32
|
+
workflow-rules.md
|
|
33
|
+
platform-adaptation.md
|
|
34
|
+
typescript.md
|
|
35
|
+
javascript.md
|
|
36
|
+
node.md
|
|
37
|
+
react.md
|
|
38
|
+
python.md
|
|
39
|
+
assets/templates/
|
|
40
|
+
task-entry.md
|
|
41
|
+
test-plan.md
|
|
42
|
+
repeated-task-checklist.md
|
|
43
|
+
changelog-entry.md
|
|
44
|
+
project-context.md
|
|
235
45
|
```
|
|
236
46
|
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
openai
|
|
47
|
+
For Codex, the project install looks like:
|
|
48
|
+
|
|
49
|
+
```text
|
|
50
|
+
.codex/skills/metacoding-workflow/
|
|
51
|
+
├── SKILL.md
|
|
52
|
+
├── agents/openai.yaml
|
|
53
|
+
├── references/
|
|
54
|
+
│ ├── project-context.md
|
|
55
|
+
│ ├── workflow-rules.md
|
|
56
|
+
│ ├── platform-adaptation.md
|
|
57
|
+
│ ├── typescript.md
|
|
58
|
+
│ ├── javascript.md
|
|
59
|
+
│ ├── node.md
|
|
60
|
+
│ ├── react.md
|
|
61
|
+
│ └── python.md
|
|
62
|
+
└── assets/templates/
|
|
63
|
+
├── task-entry.md
|
|
64
|
+
├── test-plan.md
|
|
65
|
+
├── repeated-task-checklist.md
|
|
66
|
+
├── changelog-entry.md
|
|
67
|
+
└── project-context.md
|
|
243
68
|
```
|
|
244
69
|
|
|
245
|
-
|
|
246
|
-
Gemini Code Assist in VS Code/IntelliJ automatically discovers and uses `GEMINI.md` as a style guide. No additional configuration needed!
|
|
247
|
-
|
|
248
|
-
**For Cursor IDE:**
|
|
249
|
-
No additional configuration needed! Cursor automatically detects and uses `.cursor/rules/*.mdc` files.
|
|
250
|
-
|
|
251
|
-
### File Structure by AI Setup
|
|
252
|
-
|
|
253
|
-
**GitHub Copilot setup (VS Code):**
|
|
70
|
+
The installed skill preserves the original `metacoding` workflow intent:
|
|
254
71
|
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
│ ├── docs-update.instructions.md
|
|
263
|
-
│ └── code-review.instructions.md
|
|
264
|
-
├── _meta/
|
|
265
|
-
│ └── project-task-list.md
|
|
266
|
-
└── test/
|
|
267
|
-
└── test-documentation.md
|
|
268
|
-
```
|
|
269
|
-
|
|
270
|
-
**Claude Code setup:**
|
|
72
|
+
1. Ground in the repo before asking questions.
|
|
73
|
+
2. Capture scope before changing code.
|
|
74
|
+
3. Define test intent before implementation.
|
|
75
|
+
4. Execute one bounded task at a time.
|
|
76
|
+
5. Verify with tests and direct checks.
|
|
77
|
+
6. Update docs or status artifacts that materially changed.
|
|
78
|
+
7. Close with a VCS handoff or completion confirmation.
|
|
271
79
|
|
|
272
|
-
|
|
273
|
-
my-awesome-project/
|
|
274
|
-
├── CLAUDE.md # Project instructions for Claude Code
|
|
275
|
-
├── _meta/
|
|
276
|
-
│ └── project-task-list.md
|
|
277
|
-
└── test/
|
|
278
|
-
└── test-documentation.md
|
|
279
|
-
```
|
|
80
|
+
## CLI
|
|
280
81
|
|
|
281
|
-
|
|
82
|
+
### Install
|
|
282
83
|
|
|
283
|
-
```
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
│ └── project-task-list.md
|
|
288
|
-
└── test/
|
|
289
|
-
└── test-documentation.md
|
|
84
|
+
```bash
|
|
85
|
+
npm install -g metacoding
|
|
86
|
+
cd your-project
|
|
87
|
+
metacoding init
|
|
290
88
|
```
|
|
291
89
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
```
|
|
295
|
-
my-awesome-project/
|
|
296
|
-
├── GEMINI.md # Style guide for Gemini Code Assist
|
|
297
|
-
├── _meta/
|
|
298
|
-
│ └── project-task-list.md
|
|
299
|
-
└── test/
|
|
300
|
-
└── test-documentation.md
|
|
301
|
-
```
|
|
90
|
+
`init` remains interactive for project metadata such as project name, description, and tech stack. Use `--vendor` and `--template` to preselect those parts of the setup flow.
|
|
302
91
|
|
|
303
|
-
|
|
92
|
+
Common options:
|
|
304
93
|
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
│ └── project-task-list.md
|
|
316
|
-
└── test/
|
|
317
|
-
└── test-documentation.md
|
|
318
|
-
```
|
|
94
|
+
- `metacoding init --vendor codex`
|
|
95
|
+
- `metacoding init --vendor claude-code`
|
|
96
|
+
- `metacoding init --vendor antigravity`
|
|
97
|
+
- `metacoding init --vendor all`
|
|
98
|
+
- `metacoding init --template react`
|
|
99
|
+
- `metacoding init --template typescript`
|
|
100
|
+
- `metacoding init --template node`
|
|
101
|
+
- `metacoding init --template javascript`
|
|
102
|
+
- `metacoding init --template python`
|
|
103
|
+
- `metacoding init --force`
|
|
319
104
|
|
|
320
|
-
|
|
105
|
+
### Sync or Validate
|
|
321
106
|
|
|
107
|
+
```bash
|
|
108
|
+
metacoding update
|
|
109
|
+
metacoding update --dry-run
|
|
110
|
+
metacoding update --dry-run --strict
|
|
111
|
+
metacoding update --force
|
|
322
112
|
```
|
|
323
|
-
my-awesome-project/
|
|
324
|
-
├── .github/
|
|
325
|
-
│ ├── copilot-instructions.md
|
|
326
|
-
│ └── instructions/
|
|
327
|
-
│ └── [instruction files]
|
|
328
|
-
├── CLAUDE.md
|
|
329
|
-
├── AGENTS.md
|
|
330
|
-
├── GEMINI.md
|
|
331
|
-
├── _meta/
|
|
332
|
-
│ └── project-task-list.md
|
|
333
|
-
└── test/
|
|
334
|
-
└── test-documentation.md
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
│ └── code-review.mdc
|
|
338
|
-
|
|
339
|
-
````
|
|
340
|
-
|
|
341
|
-
### Test Your Setup
|
|
342
|
-
|
|
343
|
-
#### For GitHub Copilot (VS Code):
|
|
344
|
-
|
|
345
|
-
1. **Restart VS Code** to ensure all settings are applied
|
|
346
|
-
2. **Create a new file** in your project (e.g., `test.js` or `main.py`)
|
|
347
|
-
3. **Open GitHub Copilot Chat:**
|
|
348
|
-
- Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (Mac)
|
|
349
|
-
- Type "GitHub Copilot: Open Chat"
|
|
350
|
-
- Press Enter
|
|
351
|
-
4. **Test the setup:**
|
|
352
|
-
- Ask: "What is the development workflow for this project?"
|
|
353
|
-
- Copilot should reference your custom instructions and provide project-specific guidance!
|
|
354
|
-
|
|
355
|
-
#### For Claude Code:
|
|
356
|
-
|
|
357
|
-
1. **Run Claude with project instructions:**
|
|
358
|
-
```bash
|
|
359
|
-
claude --project-instructions CLAUDE.md
|
|
360
|
-
````
|
|
361
|
-
|
|
362
|
-
2. **Test the setup:**
|
|
363
|
-
- Ask: "What is the development workflow for this project?"
|
|
364
|
-
- Claude should reference the canonical 7-step workflow from your CLAUDE.md file!
|
|
365
|
-
|
|
366
|
-
#### For Codex/OpenAI:
|
|
367
|
-
|
|
368
|
-
1. **Configure your OpenAI client** to use AGENTS.md as system message
|
|
369
|
-
2. **Test the setup:**
|
|
370
|
-
- Ask: "What is the development workflow for this project?"
|
|
371
|
-
- The assistant should follow the structured workflow from your AGENTS.md file!
|
|
372
|
-
|
|
373
|
-
#### For Gemini Code Assist:
|
|
374
|
-
|
|
375
|
-
1. **Open your project** in VS Code or IntelliJ
|
|
376
|
-
2. **Gemini automatically discovers** GEMINI.md as a style guide
|
|
377
|
-
3. **Test the setup:**
|
|
378
|
-
- Ask: "What is the development workflow for this project?"
|
|
379
|
-
- Gemini should reference your configuration rules from GEMINI.md!
|
|
380
|
-
|
|
381
|
-
#### For Cursor IDE:
|
|
382
|
-
|
|
383
|
-
1. **Open your project** in Cursor IDE
|
|
384
|
-
2. **Cursor automatically detects** .cursor/rules/\*.mdc files
|
|
385
|
-
3. **Test the setup:**
|
|
386
|
-
- Open Cursor Chat (Cmd/Ctrl + L)
|
|
387
|
-
- Ask: "What is the development workflow for this project?"
|
|
388
|
-
- Cursor should reference your workflow rules!
|
|
389
|
-
|
|
390
|
-
#### For Cursor IDE:
|
|
391
|
-
|
|
392
|
-
1. **Open your project in Cursor IDE**
|
|
393
|
-
2. **Verify rules are loaded:**
|
|
394
|
-
- Check that `workflow.cursorrules` appears in the Cursor IDE interface
|
|
395
|
-
- Look for rule indicators showing active patterns
|
|
396
|
-
3. **Test the setup:**
|
|
397
|
-
- In Cursor chat, ask: "What is the development workflow for this project?"
|
|
398
|
-
- Cursor should reference your workflow rules and provide project-specific guidance!
|
|
399
|
-
|
|
400
|
-
## ✅ You're Ready to Go!
|
|
401
|
-
|
|
402
|
-
## 📦 Using the `metacoding` CLI
|
|
403
|
-
|
|
404
|
-
Once installed, you can use these commands:
|
|
405
|
-
|
|
406
|
-
### `metacoding init`
|
|
407
|
-
|
|
408
|
-
Initialize metacoding in your current project:
|
|
409
|
-
|
|
410
|
-
**Interactive setup:**
|
|
411
113
|
|
|
412
|
-
- `
|
|
413
|
-
- `
|
|
414
|
-
- `
|
|
415
|
-
- `
|
|
416
|
-
- `
|
|
417
|
-
- `metacoding init --force` - Overwrite existing files without confirmation
|
|
114
|
+
- `update` syncs the installed skill with the packaged version.
|
|
115
|
+
- `update --vendor <vendor>` syncs or validates only one installed vendor variant.
|
|
116
|
+
- `update --vendor all` syncs or validates all installed vendor variants explicitly.
|
|
117
|
+
- `update --dry-run` validates the installed skill without changing files.
|
|
118
|
+
- `update --force` overwrites local edits inside the installed skill directory.
|
|
418
119
|
|
|
419
|
-
|
|
120
|
+
## Using the Skill
|
|
420
121
|
|
|
421
|
-
|
|
422
|
-
- `metacoding init --environment terminal --assistants claude` - Terminal setup for Claude Code
|
|
423
|
-
- `metacoding init --environment ide --ide intellij --assistants gemini` - IntelliJ with Gemini Code Assist
|
|
122
|
+
After installation, point your coding agent at the installed vendor entrypoint or ask it to use the `metacoding-workflow` skill/subagent for the next task.
|
|
424
123
|
|
|
425
|
-
|
|
124
|
+
The skill will:
|
|
426
125
|
|
|
427
|
-
-
|
|
428
|
-
-
|
|
429
|
-
-
|
|
430
|
-
-
|
|
126
|
+
- inspect the repo before asking clarifying questions
|
|
127
|
+
- keep work scoped to one bounded task
|
|
128
|
+
- push test intent ahead of production edits
|
|
129
|
+
- fall back to bundled templates when the repo lacks workflow artifacts
|
|
130
|
+
- produce a commit-ready handoff when git actions are unavailable or out of scope
|
|
431
131
|
|
|
432
|
-
|
|
132
|
+
## Migration Note
|
|
433
133
|
|
|
434
|
-
|
|
134
|
+
This package no longer treats GitHub Copilot or Cursor instruction files as the primary product. The canonical content lives under `skills/metacoding-workflow/`, and the CLI now renders vendor-specific installs for Codex, Claude Code, or Antigravity from that shared bundle.
|
|
435
135
|
|
|
436
|
-
|
|
437
|
-
- `metacoding update --dry-run` - Validate current setup without making changes
|
|
438
|
-
- `metacoding update --dry-run --strict` - Strict validation rules
|
|
439
|
-
- `metacoding update --backup` - Create backup before updating
|
|
136
|
+
## Development
|
|
440
137
|
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
## 🆘 Getting Help
|
|
447
|
-
|
|
448
|
-
### Common Questions
|
|
449
|
-
|
|
450
|
-
**Q: Do I need to be an experienced developer?**
|
|
451
|
-
A: No! `metacoding` provides guidance and structure to help developers at any level adopt proven practices and improve their skills.
|
|
452
|
-
|
|
453
|
-
**Q: Which AI assistant should I choose?**
|
|
454
|
-
A: Choose based on your workflow and preferences:
|
|
455
|
-
|
|
456
|
-
- **GitHub Copilot**: Best if you use VS Code and want deep IDE integration
|
|
457
|
-
- **Claude Code**: Great for terminal-based workflows and complex reasoning
|
|
458
|
-
- **Codex/OpenAI**: Flexible for custom integrations and API usage
|
|
459
|
-
- **Gemini Code Assist**: Excellent for Google Cloud developers using VS Code/IntelliJ
|
|
460
|
-
- **Cursor IDE**: Best for AI-first development with built-in AI features
|
|
461
|
-
- **Multiple assistants**: You can configure multiple assistants in one project!
|
|
462
|
-
|
|
463
|
-
**Q: What if I don't have an AI assistant subscription?**
|
|
464
|
-
A: You'll need access to at least one of the supported AI assistants. Many offer free tiers or trials:
|
|
465
|
-
|
|
466
|
-
- GitHub Copilot: Free for students through GitHub Education
|
|
467
|
-
- Claude Code: Available with Claude Pro subscription
|
|
468
|
-
- OpenAI Codex: Available through OpenAI API
|
|
469
|
-
- Gemini Code Assist: Available for Google Cloud users
|
|
470
|
-
- Cursor IDE: Free tier available, Pro subscription for advanced features
|
|
471
|
-
|
|
472
|
-
**Q: Can I switch between VS Code and Cursor later?**
|
|
473
|
-
A: Yes! Run `metacoding init --vscode` or `metacoding init --cursor` to switch your setup. The CLI will install the appropriate files for your chosen AI assistant.
|
|
474
|
-
|
|
475
|
-
**Q: Can I use this without the CLI tool?**
|
|
476
|
-
A: The CLI tool provides the easiest setup experience. For manual setup, you can download instruction files from our GitHub repository.
|
|
477
|
-
|
|
478
|
-
**Q: Will this work with my preferred programming language?**
|
|
479
|
-
A: Yes! The general `metacoding` template works with any language supported by your AI assistant.
|
|
480
|
-
|
|
481
|
-
**Q: Can I customize the workflow for my team's needs?**
|
|
482
|
-
A: Absolutely! All instruction files can be modified to match your specific requirements.
|
|
483
|
-
|
|
484
|
-
**Q: Does this replace learning to code?**
|
|
485
|
-
A: Nope. But it's totally up to you!.
|
|
486
|
-
|
|
487
|
-
**Q: What VS Code settings are required?**
|
|
488
|
-
A: For VS Code + GitHub Copilot, you need `github.copilot.chat.codeGeneration.useInstructionFiles: true` and `chat.promptFiles: true`. The CLI configures these automatically.
|
|
489
|
-
|
|
490
|
-
**Q: Does Cursor IDE require special settings?**
|
|
491
|
-
A: No additional settings needed! Cursor automatically detects `workflow.cursorrules` and `.cursor/rules/*.mdc` files.
|
|
492
|
-
|
|
493
|
-
## Troubleshooting
|
|
494
|
-
|
|
495
|
-
**Installation Issues:**
|
|
496
|
-
|
|
497
|
-
- Make sure Node.js (version 16+) is installed: `node --version`
|
|
498
|
-
- Verify npm is working: `npm --version`
|
|
499
|
-
- Try clearing npm cache: `npm cache clean --force`
|
|
500
|
-
|
|
501
|
-
**VS Code + GitHub Copilot Issues:**
|
|
502
|
-
|
|
503
|
-
- Make sure you've restarted VS Code after installation
|
|
504
|
-
- Verify your GitHub Copilot subscription is active
|
|
505
|
-
- Check that the instruction files are in the correct `.github/` folder
|
|
506
|
-
- Ensure VS Code settings include the required custom instruction settings
|
|
507
|
-
- Try manually referencing instructions in GitHub Copilot
|
|
508
|
-
|
|
509
|
-
**Cursor IDE Issues:**
|
|
510
|
-
|
|
511
|
-
- Verify `workflow.cursorrules` file exists in your project root
|
|
512
|
-
- Check that `.cursor/rules/*.mdc` files are present
|
|
513
|
-
- Ensure Cursor IDE is updated to the latest version
|
|
514
|
-
- Look for rule indicators in Cursor IDE interface showing active patterns
|
|
515
|
-
- Try asking Cursor: "What rules are active for this project?"
|
|
516
|
-
|
|
517
|
-
**Instructions not applying automatically:**
|
|
518
|
-
|
|
519
|
-
- Ensure file names match exactly (including extensions)
|
|
520
|
-
- Verify the folder structure is correct for your AI setup
|
|
521
|
-
- Run `metacoding update --dry-run` to validate your setup
|
|
522
|
-
- For VS Code: Check `.github/instructions/` folder structure
|
|
523
|
-
- For Cursor: Check `workflow.cursorrules` and `.cursor/rules/` files
|
|
524
|
-
|
|
525
|
-
**CLI Command Issues:**
|
|
526
|
-
|
|
527
|
-
- Ensure `metacoding` is installed globally: `npm list -g metacoding`
|
|
528
|
-
- Try reinstalling: `npm uninstall -g metacoding && npm install -g metacoding`
|
|
529
|
-
- Check PATH configuration if command not found
|
|
530
|
-
|
|
531
|
-
## Official Resources
|
|
532
|
-
|
|
533
|
-
Learn more about GitHub Copilot custom instructions:
|
|
534
|
-
|
|
535
|
-
- **[VS Code Custom Instructions Guide](https://code.visualstudio.com/blogs/2025/03/26/custom-instructions)** - **Official comprehensive guide** from the VS Code team on custom instructions
|
|
536
|
-
- **[GitHub Copilot Documentation](https://docs.github.com/en/copilot/using-github-copilot/best-practices-for-using-github-copilot)** - Official GitHub Copilot best practices
|
|
537
|
-
- **[VS Code Copilot Customization](https://code.visualstudio.com/docs/copilot/copilot-customization)** - Technical documentation for advanced customization
|
|
538
|
-
|
|
539
|
-
## 🤝 Contributing
|
|
540
|
-
|
|
541
|
-
We welcome contributions to make `metacoding` even better! Whether you have:
|
|
542
|
-
|
|
543
|
-
- Improvements to existing workflows
|
|
544
|
-
- New instruction patterns for specific technologies
|
|
545
|
-
- Documentation enhancements
|
|
546
|
-
- Bug fixes or clarifications
|
|
547
|
-
|
|
548
|
-
Feel free to open an issue or submit a pull request.
|
|
138
|
+
```bash
|
|
139
|
+
npm test
|
|
140
|
+
npm run build
|
|
141
|
+
```
|
|
549
142
|
|
|
550
|
-
##
|
|
143
|
+
## License
|
|
551
144
|
|
|
552
|
-
|
|
145
|
+
MIT
|
|
146
|
+
For Antigravity, the CLI currently installs the documented workspace-scoped variant under `.agents/skills/`. It does not yet install the global variant under `~/.gemini/antigravity/skills/`.
|
package/lib/cli.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAUA,wBAAsB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAUA,wBAAsB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAwF1C"}
|