@nerviq/cli 1.20.0 → 1.21.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.
Files changed (185) hide show
  1. package/LICENSE +23 -23
  2. package/README.md +2 -2
  3. package/bin/cli.js +1 -0
  4. package/package.json +2 -1
  5. package/src/activity.js +1039 -1039
  6. package/src/adoption-advisor.js +299 -299
  7. package/src/aider/config-parser.js +166 -166
  8. package/src/aider/context.js +6 -2
  9. package/src/aider/deep-review.js +316 -316
  10. package/src/aider/domain-packs.js +303 -303
  11. package/src/aider/freshness.js +93 -93
  12. package/src/aider/governance.js +253 -253
  13. package/src/aider/interactive.js +334 -334
  14. package/src/aider/mcp-packs.js +329 -329
  15. package/src/aider/patch.js +214 -214
  16. package/src/aider/plans.js +186 -186
  17. package/src/aider/premium.js +360 -360
  18. package/src/aider/setup.js +404 -404
  19. package/src/aider/techniques.js +312 -67
  20. package/src/analyze.js +951 -951
  21. package/src/anti-patterns.js +485 -485
  22. package/src/audit/instruction-files.js +180 -180
  23. package/src/audit/recommendations.js +577 -577
  24. package/src/auto-suggest.js +154 -154
  25. package/src/badge.js +13 -13
  26. package/src/behavioral-drift.js +801 -801
  27. package/src/benchmark.js +67 -67
  28. package/src/catalog.js +103 -103
  29. package/src/certification.js +128 -128
  30. package/src/codex/config-parser.js +183 -183
  31. package/src/codex/context.js +223 -223
  32. package/src/codex/deep-review.js +493 -493
  33. package/src/codex/domain-packs.js +394 -394
  34. package/src/codex/freshness.js +84 -84
  35. package/src/codex/governance.js +192 -192
  36. package/src/codex/interactive.js +618 -618
  37. package/src/codex/mcp-packs.js +914 -914
  38. package/src/codex/patch.js +209 -209
  39. package/src/codex/plans.js +251 -251
  40. package/src/codex/premium.js +614 -614
  41. package/src/codex/setup.js +591 -591
  42. package/src/context.js +10 -4
  43. package/src/continuous-ops.js +681 -681
  44. package/src/copilot/activity.js +309 -309
  45. package/src/copilot/deep-review.js +346 -346
  46. package/src/copilot/domain-packs.js +372 -372
  47. package/src/copilot/freshness.js +57 -57
  48. package/src/copilot/governance.js +222 -222
  49. package/src/copilot/interactive.js +406 -406
  50. package/src/copilot/mcp-packs.js +826 -826
  51. package/src/copilot/plans.js +253 -253
  52. package/src/copilot/premium.js +451 -451
  53. package/src/copilot/setup.js +488 -488
  54. package/src/cost-tracking.js +61 -61
  55. package/src/cursor/activity.js +301 -301
  56. package/src/cursor/config-parser.js +265 -265
  57. package/src/cursor/context.js +256 -256
  58. package/src/cursor/deep-review.js +334 -334
  59. package/src/cursor/domain-packs.js +368 -368
  60. package/src/cursor/freshness.js +65 -65
  61. package/src/cursor/governance.js +229 -229
  62. package/src/cursor/interactive.js +391 -391
  63. package/src/cursor/mcp-packs.js +828 -828
  64. package/src/cursor/plans.js +254 -254
  65. package/src/cursor/premium.js +469 -469
  66. package/src/cursor/setup.js +488 -488
  67. package/src/dashboard.js +493 -493
  68. package/src/deep-review.js +428 -428
  69. package/src/deprecation.js +98 -98
  70. package/src/diff-only.js +280 -280
  71. package/src/doctor.js +119 -119
  72. package/src/domain-pack-expansion.js +1033 -1033
  73. package/src/domain-packs.js +387 -387
  74. package/src/feedback.js +178 -178
  75. package/src/fix-engine.js +783 -783
  76. package/src/fix-prompts.js +122 -122
  77. package/src/formatters/sarif.js +115 -115
  78. package/src/freshness.js +74 -74
  79. package/src/gemini/config-parser.js +275 -275
  80. package/src/gemini/deep-review.js +559 -559
  81. package/src/gemini/domain-packs.js +393 -393
  82. package/src/gemini/freshness.js +66 -66
  83. package/src/gemini/governance.js +201 -201
  84. package/src/gemini/interactive.js +860 -860
  85. package/src/gemini/mcp-packs.js +915 -915
  86. package/src/gemini/plans.js +269 -269
  87. package/src/gemini/premium.js +760 -760
  88. package/src/gemini/setup.js +692 -692
  89. package/src/governance.js +72 -72
  90. package/src/harmony/add.js +68 -68
  91. package/src/harmony/advisor.js +333 -333
  92. package/src/harmony/canon.js +565 -565
  93. package/src/harmony/cli.js +591 -591
  94. package/src/harmony/drift.js +401 -401
  95. package/src/harmony/governance.js +313 -313
  96. package/src/harmony/memory.js +239 -239
  97. package/src/harmony/sync.js +475 -475
  98. package/src/harmony/watch.js +370 -370
  99. package/src/hook-validation.js +342 -342
  100. package/src/index.js +271 -271
  101. package/src/init.js +184 -184
  102. package/src/instruction-surfaces.js +185 -185
  103. package/src/integrations.js +144 -144
  104. package/src/interactive.js +118 -118
  105. package/src/locales/en.json +1 -1
  106. package/src/locales/es.json +1 -1
  107. package/src/mcp-packs.js +830 -830
  108. package/src/mcp-server.js +726 -726
  109. package/src/mcp-validation.js +337 -337
  110. package/src/nerviq-sync.json +7 -7
  111. package/src/opencode/config-parser.js +109 -109
  112. package/src/opencode/context.js +247 -247
  113. package/src/opencode/deep-review.js +313 -313
  114. package/src/opencode/domain-packs.js +262 -262
  115. package/src/opencode/freshness.js +66 -66
  116. package/src/opencode/governance.js +159 -159
  117. package/src/opencode/interactive.js +392 -392
  118. package/src/opencode/mcp-packs.js +705 -705
  119. package/src/opencode/patch.js +184 -184
  120. package/src/opencode/plans.js +231 -231
  121. package/src/opencode/premium.js +413 -413
  122. package/src/opencode/setup.js +449 -449
  123. package/src/opencode/techniques.js +27 -27
  124. package/src/operating-profile.js +574 -574
  125. package/src/org.js +152 -152
  126. package/src/permission-rules.js +218 -218
  127. package/src/plans.js +839 -839
  128. package/src/platform-change-manifest.js +86 -86
  129. package/src/plugins.js +110 -110
  130. package/src/policy-layers.js +210 -210
  131. package/src/profiles.js +124 -124
  132. package/src/prompt-injection.js +74 -74
  133. package/src/public-api.js +173 -173
  134. package/src/recommendation-rules.js +84 -84
  135. package/src/repo-archetype.js +386 -386
  136. package/src/secret-patterns.js +39 -39
  137. package/src/server.js +527 -527
  138. package/src/setup/analysis.js +607 -607
  139. package/src/setup/runtime.js +172 -172
  140. package/src/setup.js +677 -677
  141. package/src/shared/capabilities.js +194 -194
  142. package/src/source-urls.js +132 -132
  143. package/src/stack-checks.js +565 -565
  144. package/src/supplemental-checks.js +13 -13
  145. package/src/synergy/adaptive.js +261 -261
  146. package/src/synergy/compensation.js +137 -137
  147. package/src/synergy/evidence.js +193 -193
  148. package/src/synergy/learning.js +199 -199
  149. package/src/synergy/patterns.js +227 -227
  150. package/src/synergy/ranking.js +83 -83
  151. package/src/synergy/report.js +165 -165
  152. package/src/synergy/routing.js +146 -146
  153. package/src/techniques/api.js +407 -407
  154. package/src/techniques/automation.js +316 -316
  155. package/src/techniques/compliance.js +257 -257
  156. package/src/techniques/hygiene.js +294 -294
  157. package/src/techniques/instructions.js +243 -243
  158. package/src/techniques/observability.js +226 -226
  159. package/src/techniques/optimization.js +142 -142
  160. package/src/techniques/quality.js +318 -318
  161. package/src/techniques/security.js +237 -237
  162. package/src/techniques/shared.js +443 -443
  163. package/src/techniques/stacks.js +2294 -2294
  164. package/src/techniques/tools.js +106 -106
  165. package/src/techniques/workflow.js +413 -413
  166. package/src/techniques.js +81 -81
  167. package/src/terminology.js +73 -73
  168. package/src/token-estimate.js +35 -35
  169. package/src/usage-patterns.js +99 -99
  170. package/src/verification-metadata.js +145 -145
  171. package/src/watch.js +247 -247
  172. package/src/windsurf/activity.js +302 -302
  173. package/src/windsurf/config-parser.js +267 -267
  174. package/src/windsurf/context.js +120 -10
  175. package/src/windsurf/deep-review.js +337 -337
  176. package/src/windsurf/domain-packs.js +370 -370
  177. package/src/windsurf/freshness.js +36 -36
  178. package/src/windsurf/governance.js +231 -231
  179. package/src/windsurf/interactive.js +388 -388
  180. package/src/windsurf/mcp-packs.js +792 -792
  181. package/src/windsurf/plans.js +247 -247
  182. package/src/windsurf/premium.js +468 -468
  183. package/src/windsurf/setup.js +471 -471
  184. package/src/windsurf/techniques.js +155 -33
  185. package/src/workspace.js +375 -375
@@ -1,449 +1,449 @@
1
- /**
2
- * OpenCode Setup — generates opencode.json, AGENTS.md, permissions, plugins scaffolds
3
- *
4
- * Families: opencode.json, AGENTS.md, permissions, plugins
5
- */
6
-
7
- const fs = require('fs');
8
- const path = require('path');
9
- const os = require('os');
10
- const { version } = require('../../package.json');
11
- const { STACKS } = require('../techniques');
12
- const { writeActivityArtifact, writeRollbackArtifact } = require('../activity');
13
- const { OpenCodeProjectContext } = require('./context');
14
- const { recommendOpenCodeMcpPacks, packsToJsonc } = require('./mcp-packs');
15
-
16
- function detectScripts(ctx) {
17
- const pkg = ctx.jsonFile('package.json');
18
- if (!pkg || !pkg.scripts) return {};
19
- return pkg.scripts;
20
- }
21
-
22
- function detectProjectName(ctx) {
23
- const pkg = ctx.jsonFile('package.json');
24
- if (pkg && pkg.name) return pkg.name;
25
- return path.basename(ctx.dir);
26
- }
27
-
28
- function hasStack(stacks, key) {
29
- return stacks.some((item) => item.key === key);
30
- }
31
-
32
- function buildMermaid(stacks) {
33
- if (hasStack(stacks, 'nextjs')) {
34
- return ['```mermaid', 'graph TD', ' UI[App Router / Pages] --> Logic[Server Actions or API Routes]', ' Logic --> Data[Data Layer]', ' Data --> External[External Services / DB]', '```'].join('\n');
35
- }
36
- if (hasStack(stacks, 'fastapi') || hasStack(stacks, 'django') || hasStack(stacks, 'python')) {
37
- return ['```mermaid', 'graph TD', ' API[API / CLI Entry] --> Services[Service Layer]', ' Services --> Models[Models / Schemas]', ' Models --> Data[Database or External APIs]', '```'].join('\n');
38
- }
39
- if (hasStack(stacks, 'go')) {
40
- return ['```mermaid', 'graph TD', ' Cmd[cmd/ or main package] --> Internal[internal/ packages]', ' Internal --> Data[Storage / APIs]', '```'].join('\n');
41
- }
42
- if (hasStack(stacks, 'rust')) {
43
- return ['```mermaid', 'graph TD', ' Bin[src/main.rs] --> Core[src/lib.rs]', ' Core --> Modules[domain / adapters / services]', '```'].join('\n');
44
- }
45
- return ['```mermaid', 'graph TD', ' Entry[Entry Point] --> Core[Core Logic]', ' Core --> Data[Data / External Services]', '```'].join('\n');
46
- }
47
-
48
- function buildVerificationCommands(ctx) {
49
- const scripts = detectScripts(ctx);
50
- const commands = [];
51
- if (scripts.test) commands.push('- Test: `npm test`');
52
- if (scripts.lint) commands.push('- Lint: `npm run lint`');
53
- if (scripts.build) commands.push('- Build: `npm run build`');
54
- if (commands.length === 0 && ctx.fileContent('pyproject.toml')) commands.push('- Test: `python -m pytest`');
55
- if (commands.length === 0 && ctx.fileContent('go.mod')) { commands.push('- Test: `go test ./...`'); commands.push('- Build: `go build ./...`'); }
56
- if (commands.length === 0 && ctx.fileContent('Cargo.toml')) { commands.push('- Test: `cargo test`'); commands.push('- Build: `cargo build`'); }
57
- if (commands.length === 0) { commands.push('- Test: add the repo test command'); commands.push('- Lint: add the repo lint command'); commands.push('- Build: add the repo build command'); }
58
- return commands;
59
- }
60
-
61
- function buildCodingConventions(stacks) {
62
- const lines = [];
63
- if (hasStack(stacks, 'typescript')) lines.push('- Keep TypeScript strict and prefer typed boundaries over implicit `any`.');
64
- if (hasStack(stacks, 'react') || hasStack(stacks, 'nextjs')) lines.push('- Prefer small, reviewable component changes and document risky UI state assumptions.');
65
- if (hasStack(stacks, 'python') || hasStack(stacks, 'fastapi') || hasStack(stacks, 'django')) lines.push('- Prefer explicit validation, typed schemas, and focused service functions.');
66
- if (hasStack(stacks, 'go')) lines.push('- Keep packages small, avoid cross-package cycles, and prefer table-driven tests.');
67
- if (hasStack(stacks, 'rust')) lines.push('- Prefer explicit ownership-safe refactors and small module-scoped changes.');
68
- if (hasStack(stacks, 'terraform') || hasStack(stacks, 'kubernetes')) lines.push('- Treat infrastructure changes as high-risk: prefer diffs that are easy to plan, review, and roll back.');
69
- if (lines.length === 0) lines.push('- Prefer small, reviewable diffs and explicit reasoning over broad rewrites.');
70
- return lines;
71
- }
72
-
73
- function buildSecurityNotes(stacks) {
74
- const lines = [
75
- '- Never commit secrets, tokens, or `.env` values into tracked files.',
76
- '- Prefer the repo verification commands before handoff.',
77
- ];
78
- if (hasStack(stacks, 'python') || hasStack(stacks, 'fastapi') || hasStack(stacks, 'django')) {
79
- lines.push('- Validate auth, permissions, and data-handling changes carefully.');
80
- }
81
- if (hasStack(stacks, 'terraform') || hasStack(stacks, 'kubernetes')) {
82
- lines.push('- Review blast radius before changing infra, deployment, or cluster configuration.');
83
- }
84
- return lines;
85
- }
86
-
87
- function buildAgentsMd(ctx, stacks) {
88
- const stackLabels = stacks.map((item) => item.label).join(', ') || 'General repo';
89
- const verificationCommands = buildVerificationCommands(ctx);
90
- const codingConventions = buildCodingConventions(stacks);
91
- const securityNotes = buildSecurityNotes(stacks);
92
-
93
- return [
94
- `# ${detectProjectName(ctx)}`,
95
- '',
96
- '## Scope',
97
- '- Primary platform: OpenCode CLI',
98
- `- Detected stack: ${stackLabels}`,
99
- '- Keep this file focused on OpenCode-specific guidance. If the repo also uses Claude, keep Claude instructions in CLAUDE.md.',
100
- '',
101
- '## Architecture',
102
- buildMermaid(stacks),
103
- '- Replace the default diagram with the real entry points, boundaries, and high-risk subsystems.',
104
- '',
105
- '## Verification',
106
- ...verificationCommands,
107
- '',
108
- '## Coding Conventions',
109
- ...codingConventions,
110
- '',
111
- '## Review Workflow',
112
- '- Run verification commands before handoff on risky diffs or broad refactors.',
113
- '- Explain which verification commands ran successfully and which were skipped.',
114
- '',
115
- '## Security',
116
- ...securityNotes,
117
- '',
118
- '## Permissions',
119
- '- Review opencode.json permissions before enabling full automation.',
120
- '- Use "ask" (not "allow") for bash, task, and external_directory by default.',
121
- '',
122
- '## Cost & Automation',
123
- '- Reserve heavy reasoning or long automation chains for tasks that actually need them.',
124
- '- Set OPENCODE_DISABLE_AUTOUPDATE=1 in CI environments.',
125
- '',
126
- '## Notes',
127
- '- If this repo also uses Claude, keep Claude-specific instructions in `CLAUDE.md` and use AGENTS.md for OpenCode.',
128
- '- AGENTS.md takes precedence over CLAUDE.md when both exist in the same directory.',
129
- '- Plugins run in-process — review and pin versions before deploying.',
130
- '',
131
- `_Generated by nerviq v${version} for OpenCode. Customize this file before relying on it in production._`,
132
- '',
133
- ].join('\n');
134
- }
135
-
136
- function buildConfigJson() {
137
- return JSON.stringify({
138
- $schema: 'https://opencode.ai/config.json',
139
- model: 'anthropic/claude-sonnet-4-6',
140
- small_model: 'anthropic/claude-haiku-4',
141
- permissions: {
142
- tools: {
143
- read: 'allow',
144
- edit: 'ask',
145
- glob: 'allow',
146
- grep: 'allow',
147
- list: 'allow',
148
- bash: 'ask',
149
- task: 'ask',
150
- skill: 'allow',
151
- lsp: 'allow',
152
- question: 'allow',
153
- webfetch: 'ask',
154
- websearch: 'ask',
155
- codesearch: 'allow',
156
- external_directory: 'ask',
157
- doom_loop: 'ask',
158
- },
159
- },
160
- }, null, 2) + '\n';
161
- }
162
-
163
- function buildOpenCodeSetupFiles(options = {}) {
164
- const ctx = new OpenCodeProjectContext(options.dir);
165
- const stacks = ctx.detectStacks(STACKS);
166
- const files = [];
167
-
168
- const agentsPath = path.join(options.dir, 'AGENTS.md');
169
- if (!fs.existsSync(agentsPath)) {
170
- files.push({
171
- path: 'AGENTS.md',
172
- action: 'create',
173
- content: buildAgentsMd(ctx, stacks),
174
- currentState: 'AGENTS.md is missing',
175
- proposedState: 'create an OpenCode-native AGENTS.md baseline with verification, architecture, review, and permission guidance',
176
- });
177
- }
178
-
179
- const configPath = path.join(options.dir, 'opencode.json');
180
- const configcPath = path.join(options.dir, 'opencode.jsonc');
181
- if (!fs.existsSync(configPath) && !fs.existsSync(configcPath)) {
182
- files.push({
183
- path: 'opencode.json',
184
- action: 'create',
185
- content: buildConfigJson(),
186
- currentState: 'opencode.json is missing',
187
- proposedState: 'create a safe OpenCode baseline config with explicit model, permissions, and tool settings',
188
- });
189
- }
190
-
191
- const modules = options.modules || 'all';
192
- const wantModule = (name) => modules === 'all' || (Array.isArray(modules) && modules.includes(name));
193
-
194
- // Plugins starter
195
- if (wantModule('plugins')) {
196
- const pluginsDir = path.join(options.dir, '.opencode', 'plugins');
197
- const pluginsReadme = path.join(pluginsDir, 'README.md');
198
- if (!fs.existsSync(pluginsReadme) && !fs.existsSync(pluginsDir)) {
199
- files.push({
200
- path: '.opencode/plugins/README.md',
201
- action: 'create',
202
- family: 'opencode-plugins',
203
- content: buildPluginsStarter(),
204
- currentState: '.opencode/plugins/ directory is missing',
205
- proposedState: 'create an OpenCode plugins starter with security guidance',
206
- });
207
- }
208
- }
209
-
210
- // Commands/skills starter
211
- if (wantModule('skills')) {
212
- const commandsDir = path.join(options.dir, '.opencode', 'commands');
213
- const commandsReadme = path.join(commandsDir, 'README.md');
214
- if (!fs.existsSync(commandsReadme) && !fs.existsSync(commandsDir)) {
215
- files.push({
216
- path: '.opencode/commands/README.md',
217
- action: 'create',
218
- family: 'opencode-skills',
219
- content: buildCommandsStarter(),
220
- currentState: '.opencode/commands/ directory is missing',
221
- proposedState: 'create an OpenCode commands/skills starter with naming and frontmatter guidance',
222
- });
223
- }
224
- }
225
-
226
- // MCP starter
227
- if (wantModule('mcp')) {
228
- const configContent = ctx.configContent ? ctx.configContent() : '';
229
- const hasMcpSection = configContent && /"mcp"\s*:/i.test(configContent);
230
- if (!hasMcpSection) {
231
- const domainPacks = options.domainPacks || [];
232
- const mcpRecs = recommendOpenCodeMcpPacks(stacks, domainPacks, { ctx });
233
- if (mcpRecs.length > 0) {
234
- const mcpJsonc = packsToJsonc(mcpRecs.map(p => p.key));
235
- files.push({
236
- path: 'opencode.json (MCP append)',
237
- action: 'append',
238
- family: 'opencode-mcp',
239
- content: mcpJsonc,
240
- currentState: 'No MCP servers configured in opencode.json',
241
- proposedState: `add ${mcpRecs.length} recommended MCP packs: ${mcpRecs.map(p => p.label).join(', ')}`,
242
- });
243
- }
244
- }
245
- }
246
-
247
- // CI workflow starter
248
- if (wantModule('ci')) {
249
- const workflowDir = path.join(options.dir, '.github', 'workflows');
250
- const opencodeWorkflow = path.join(workflowDir, 'opencode-review.yml');
251
- if (!fs.existsSync(opencodeWorkflow)) {
252
- files.push({
253
- path: '.github/workflows/opencode-review.yml',
254
- action: 'create',
255
- family: 'opencode-ci',
256
- content: buildCiReviewStarter(),
257
- currentState: 'No OpenCode CI review workflow exists',
258
- proposedState: 'create a GitHub Actions workflow for OpenCode-based PR review',
259
- });
260
- }
261
- }
262
-
263
- return { ctx, stacks, files };
264
- }
265
-
266
- function buildPluginsStarter() {
267
- return [
268
- '# OpenCode Plugins',
269
- '',
270
- 'Place plugin files (.js, .ts, .mjs) in this directory.',
271
- '',
272
- '## Security Warning',
273
- '',
274
- 'Plugins run **in-process** with the OpenCode agent. They can:',
275
- '- Intercept tool calls and responses',
276
- '- Modify agent behavior',
277
- '- Access the local filesystem',
278
- '',
279
- '## Plugin format',
280
- '',
281
- '```typescript',
282
- 'import { definePlugin } from "@opencode-ai/plugin";',
283
- '',
284
- 'export default definePlugin({',
285
- ' name: "my-plugin",',
286
- ' setup(api) {',
287
- ' api.on("tool.execute.before", (event) => {',
288
- ' // Pre-flight validation',
289
- ' });',
290
- ' },',
291
- '});',
292
- '```',
293
- '',
294
- '## Best practices',
295
- '',
296
- '- Pin npm plugin versions (never use @latest)',
297
- '- Document what each plugin does in AGENTS.md',
298
- '- Note: tool.execute.before does not intercept subagent/MCP calls (#5894, #2319)',
299
- '',
300
- `_Generated by nerviq v${version}_`,
301
- '',
302
- ].join('\n');
303
- }
304
-
305
- function buildCommandsStarter() {
306
- return [
307
- '# OpenCode Commands & Skills',
308
- '',
309
- 'Place command/skill directories here. Each needs a SKILL.md file.',
310
- '',
311
- '## Directory structure',
312
- '',
313
- '```',
314
- '.opencode/commands/',
315
- ' my-skill/',
316
- ' SKILL.md # Required: name, description, instructions',
317
- ' helpers.js # Optional: supporting files',
318
- '```',
319
- '',
320
- '## SKILL.md format',
321
- '',
322
- '```markdown',
323
- '---',
324
- 'name: my-skill',
325
- 'description: Short description for implicit invocation',
326
- '---',
327
- '',
328
- '# My Skill',
329
- '',
330
- 'Instructions for OpenCode when this skill is invoked.',
331
- '```',
332
- '',
333
- '## Critical naming rules',
334
- '',
335
- '- Use **kebab-case** for skill directory names (e.g., `code-review`, not `CodeReview`)',
336
- '- PascalCase names have 0% implicit invocation success rate',
337
- '- Keep descriptions short for bounded context cost',
338
- '',
339
- `_Generated by nerviq v${version}_`,
340
- '',
341
- ].join('\n');
342
- }
343
-
344
- function buildCiReviewStarter() {
345
- return [
346
- 'name: OpenCode Review',
347
- '',
348
- 'on:',
349
- ' pull_request:',
350
- ' types: [opened, synchronize]',
351
- '',
352
- 'permissions:',
353
- ' contents: read',
354
- ' pull-requests: write',
355
- '',
356
- 'env:',
357
- ' OPENCODE_DISABLE_AUTOUPDATE: "1"',
358
- '',
359
- 'jobs:',
360
- ' opencode-review:',
361
- ' runs-on: ubuntu-latest',
362
- ' steps:',
363
- ' - uses: actions/checkout@v4',
364
- ' - name: Install OpenCode',
365
- ' run: npm install -g opencode',
366
- ' - name: OpenCode Review',
367
- ' run: opencode run --format json "Review this PR diff"',
368
- ' env:',
369
- ' ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}',
370
- ].join('\n') + '\n';
371
- }
372
-
373
- async function setupOpenCode(options) {
374
- const silent = options.silent === true;
375
- const { ctx, stacks, files } = buildOpenCodeSetupFiles(options);
376
- const writtenFiles = [];
377
- const preservedFiles = [];
378
-
379
- function log(message = '') {
380
- if (!silent) console.log(message);
381
- }
382
-
383
- log('');
384
- log('\x1b[1m nerviq opencode setup\x1b[0m');
385
- log('\x1b[2m ═══════════════════════════════════════\x1b[0m');
386
- if (stacks.length > 0) {
387
- log(`\x1b[36m Detected: ${stacks.map((s) => s.label).join(', ')}\x1b[0m`);
388
- }
389
- log('');
390
-
391
- for (const file of files) {
392
- const fullPath = path.join(options.dir, file.path);
393
- if (fs.existsSync(fullPath)) {
394
- preservedFiles.push(file.path);
395
- log(` \x1b[2m Skipped ${file.path} (already exists)\x1b[0m`);
396
- continue;
397
- }
398
- fs.mkdirSync(path.dirname(fullPath), { recursive: true });
399
- fs.writeFileSync(fullPath, file.content, 'utf8');
400
- writtenFiles.push(file.path);
401
- log(` \x1b[32m Created ${file.path}\x1b[0m`);
402
- }
403
-
404
- let rollbackArtifact = null;
405
- let activityArtifact = null;
406
- if (writtenFiles.length > 0) {
407
- rollbackArtifact = writeRollbackArtifact(options.dir, {
408
- sourcePlan: 'opencode-setup',
409
- createdFiles: writtenFiles,
410
- patchedFiles: [],
411
- rollbackInstructions: writtenFiles.map((file) => `Delete ${file}`),
412
- });
413
- activityArtifact = writeActivityArtifact(options.dir, 'opencode-setup', {
414
- platform: 'opencode',
415
- createdFiles: writtenFiles,
416
- preservedFiles,
417
- stackLabels: stacks.map((item) => item.label),
418
- rollbackArtifact: rollbackArtifact.relativePath,
419
- });
420
- }
421
-
422
- log('');
423
- log(` \x1b[1m${writtenFiles.length} files created.\x1b[0m`);
424
- if (preservedFiles.length > 0) {
425
- log(` \x1b[2m${preservedFiles.length} existing files preserved.\x1b[0m`);
426
- }
427
- if (rollbackArtifact) log(` Rollback: \x1b[1m${rollbackArtifact.relativePath}\x1b[0m`);
428
- if (activityArtifact) log(` Activity log: \x1b[1m${activityArtifact.relativePath}\x1b[0m`);
429
- log('');
430
- log(' Run \x1b[1mnpx nerviq --platform opencode\x1b[0m to audit your OpenCode setup.');
431
- log('');
432
-
433
- return {
434
- created: writtenFiles.length,
435
- skipped: preservedFiles.length,
436
- writtenFiles,
437
- preservedFiles,
438
- stacks,
439
- rollbackArtifact: rollbackArtifact ? rollbackArtifact.relativePath : null,
440
- activityArtifact: activityArtifact ? activityArtifact.relativePath : null,
441
- };
442
- }
443
-
444
- module.exports = {
445
- buildAgentsMd,
446
- buildConfigJson,
447
- buildOpenCodeSetupFiles,
448
- setupOpenCode,
449
- };
1
+ /**
2
+ * OpenCode Setup — generates opencode.json, AGENTS.md, permissions, plugins scaffolds
3
+ *
4
+ * Families: opencode.json, AGENTS.md, permissions, plugins
5
+ */
6
+
7
+ const fs = require('fs');
8
+ const path = require('path');
9
+ const os = require('os');
10
+ const { version } = require('../../package.json');
11
+ const { STACKS } = require('../techniques');
12
+ const { writeActivityArtifact, writeRollbackArtifact } = require('../activity');
13
+ const { OpenCodeProjectContext } = require('./context');
14
+ const { recommendOpenCodeMcpPacks, packsToJsonc } = require('./mcp-packs');
15
+
16
+ function detectScripts(ctx) {
17
+ const pkg = ctx.jsonFile('package.json');
18
+ if (!pkg || !pkg.scripts) return {};
19
+ return pkg.scripts;
20
+ }
21
+
22
+ function detectProjectName(ctx) {
23
+ const pkg = ctx.jsonFile('package.json');
24
+ if (pkg && pkg.name) return pkg.name;
25
+ return path.basename(ctx.dir);
26
+ }
27
+
28
+ function hasStack(stacks, key) {
29
+ return stacks.some((item) => item.key === key);
30
+ }
31
+
32
+ function buildMermaid(stacks) {
33
+ if (hasStack(stacks, 'nextjs')) {
34
+ return ['```mermaid', 'graph TD', ' UI[App Router / Pages] --> Logic[Server Actions or API Routes]', ' Logic --> Data[Data Layer]', ' Data --> External[External Services / DB]', '```'].join('\n');
35
+ }
36
+ if (hasStack(stacks, 'fastapi') || hasStack(stacks, 'django') || hasStack(stacks, 'python')) {
37
+ return ['```mermaid', 'graph TD', ' API[API / CLI Entry] --> Services[Service Layer]', ' Services --> Models[Models / Schemas]', ' Models --> Data[Database or External APIs]', '```'].join('\n');
38
+ }
39
+ if (hasStack(stacks, 'go')) {
40
+ return ['```mermaid', 'graph TD', ' Cmd[cmd/ or main package] --> Internal[internal/ packages]', ' Internal --> Data[Storage / APIs]', '```'].join('\n');
41
+ }
42
+ if (hasStack(stacks, 'rust')) {
43
+ return ['```mermaid', 'graph TD', ' Bin[src/main.rs] --> Core[src/lib.rs]', ' Core --> Modules[domain / adapters / services]', '```'].join('\n');
44
+ }
45
+ return ['```mermaid', 'graph TD', ' Entry[Entry Point] --> Core[Core Logic]', ' Core --> Data[Data / External Services]', '```'].join('\n');
46
+ }
47
+
48
+ function buildVerificationCommands(ctx) {
49
+ const scripts = detectScripts(ctx);
50
+ const commands = [];
51
+ if (scripts.test) commands.push('- Test: `npm test`');
52
+ if (scripts.lint) commands.push('- Lint: `npm run lint`');
53
+ if (scripts.build) commands.push('- Build: `npm run build`');
54
+ if (commands.length === 0 && ctx.fileContent('pyproject.toml')) commands.push('- Test: `python -m pytest`');
55
+ if (commands.length === 0 && ctx.fileContent('go.mod')) { commands.push('- Test: `go test ./...`'); commands.push('- Build: `go build ./...`'); }
56
+ if (commands.length === 0 && ctx.fileContent('Cargo.toml')) { commands.push('- Test: `cargo test`'); commands.push('- Build: `cargo build`'); }
57
+ if (commands.length === 0) { commands.push('- Test: add the repo test command'); commands.push('- Lint: add the repo lint command'); commands.push('- Build: add the repo build command'); }
58
+ return commands;
59
+ }
60
+
61
+ function buildCodingConventions(stacks) {
62
+ const lines = [];
63
+ if (hasStack(stacks, 'typescript')) lines.push('- Keep TypeScript strict and prefer typed boundaries over implicit `any`.');
64
+ if (hasStack(stacks, 'react') || hasStack(stacks, 'nextjs')) lines.push('- Prefer small, reviewable component changes and document risky UI state assumptions.');
65
+ if (hasStack(stacks, 'python') || hasStack(stacks, 'fastapi') || hasStack(stacks, 'django')) lines.push('- Prefer explicit validation, typed schemas, and focused service functions.');
66
+ if (hasStack(stacks, 'go')) lines.push('- Keep packages small, avoid cross-package cycles, and prefer table-driven tests.');
67
+ if (hasStack(stacks, 'rust')) lines.push('- Prefer explicit ownership-safe refactors and small module-scoped changes.');
68
+ if (hasStack(stacks, 'terraform') || hasStack(stacks, 'kubernetes')) lines.push('- Treat infrastructure changes as high-risk: prefer diffs that are easy to plan, review, and roll back.');
69
+ if (lines.length === 0) lines.push('- Prefer small, reviewable diffs and explicit reasoning over broad rewrites.');
70
+ return lines;
71
+ }
72
+
73
+ function buildSecurityNotes(stacks) {
74
+ const lines = [
75
+ '- Never commit secrets, tokens, or `.env` values into tracked files.',
76
+ '- Prefer the repo verification commands before handoff.',
77
+ ];
78
+ if (hasStack(stacks, 'python') || hasStack(stacks, 'fastapi') || hasStack(stacks, 'django')) {
79
+ lines.push('- Validate auth, permissions, and data-handling changes carefully.');
80
+ }
81
+ if (hasStack(stacks, 'terraform') || hasStack(stacks, 'kubernetes')) {
82
+ lines.push('- Review blast radius before changing infra, deployment, or cluster configuration.');
83
+ }
84
+ return lines;
85
+ }
86
+
87
+ function buildAgentsMd(ctx, stacks) {
88
+ const stackLabels = stacks.map((item) => item.label).join(', ') || 'General repo';
89
+ const verificationCommands = buildVerificationCommands(ctx);
90
+ const codingConventions = buildCodingConventions(stacks);
91
+ const securityNotes = buildSecurityNotes(stacks);
92
+
93
+ return [
94
+ `# ${detectProjectName(ctx)}`,
95
+ '',
96
+ '## Scope',
97
+ '- Primary platform: OpenCode CLI',
98
+ `- Detected stack: ${stackLabels}`,
99
+ '- Keep this file focused on OpenCode-specific guidance. If the repo also uses Claude, keep Claude instructions in CLAUDE.md.',
100
+ '',
101
+ '## Architecture',
102
+ buildMermaid(stacks),
103
+ '- Replace the default diagram with the real entry points, boundaries, and high-risk subsystems.',
104
+ '',
105
+ '## Verification',
106
+ ...verificationCommands,
107
+ '',
108
+ '## Coding Conventions',
109
+ ...codingConventions,
110
+ '',
111
+ '## Review Workflow',
112
+ '- Run verification commands before handoff on risky diffs or broad refactors.',
113
+ '- Explain which verification commands ran successfully and which were skipped.',
114
+ '',
115
+ '## Security',
116
+ ...securityNotes,
117
+ '',
118
+ '## Permissions',
119
+ '- Review opencode.json permissions before enabling full automation.',
120
+ '- Use "ask" (not "allow") for bash, task, and external_directory by default.',
121
+ '',
122
+ '## Cost & Automation',
123
+ '- Reserve heavy reasoning or long automation chains for tasks that actually need them.',
124
+ '- Set OPENCODE_DISABLE_AUTOUPDATE=1 in CI environments.',
125
+ '',
126
+ '## Notes',
127
+ '- If this repo also uses Claude, keep Claude-specific instructions in `CLAUDE.md` and use AGENTS.md for OpenCode.',
128
+ '- AGENTS.md takes precedence over CLAUDE.md when both exist in the same directory.',
129
+ '- Plugins run in-process — review and pin versions before deploying.',
130
+ '',
131
+ `_Generated by nerviq v${version} for OpenCode. Customize this file before relying on it in production._`,
132
+ '',
133
+ ].join('\n');
134
+ }
135
+
136
+ function buildConfigJson() {
137
+ return JSON.stringify({
138
+ $schema: 'https://opencode.ai/config.json',
139
+ model: 'anthropic/claude-sonnet-4-6',
140
+ small_model: 'anthropic/claude-haiku-4',
141
+ permissions: {
142
+ tools: {
143
+ read: 'allow',
144
+ edit: 'ask',
145
+ glob: 'allow',
146
+ grep: 'allow',
147
+ list: 'allow',
148
+ bash: 'ask',
149
+ task: 'ask',
150
+ skill: 'allow',
151
+ lsp: 'allow',
152
+ question: 'allow',
153
+ webfetch: 'ask',
154
+ websearch: 'ask',
155
+ codesearch: 'allow',
156
+ external_directory: 'ask',
157
+ doom_loop: 'ask',
158
+ },
159
+ },
160
+ }, null, 2) + '\n';
161
+ }
162
+
163
+ function buildOpenCodeSetupFiles(options = {}) {
164
+ const ctx = new OpenCodeProjectContext(options.dir);
165
+ const stacks = ctx.detectStacks(STACKS);
166
+ const files = [];
167
+
168
+ const agentsPath = path.join(options.dir, 'AGENTS.md');
169
+ if (!fs.existsSync(agentsPath)) {
170
+ files.push({
171
+ path: 'AGENTS.md',
172
+ action: 'create',
173
+ content: buildAgentsMd(ctx, stacks),
174
+ currentState: 'AGENTS.md is missing',
175
+ proposedState: 'create an OpenCode-native AGENTS.md baseline with verification, architecture, review, and permission guidance',
176
+ });
177
+ }
178
+
179
+ const configPath = path.join(options.dir, 'opencode.json');
180
+ const configcPath = path.join(options.dir, 'opencode.jsonc');
181
+ if (!fs.existsSync(configPath) && !fs.existsSync(configcPath)) {
182
+ files.push({
183
+ path: 'opencode.json',
184
+ action: 'create',
185
+ content: buildConfigJson(),
186
+ currentState: 'opencode.json is missing',
187
+ proposedState: 'create a safe OpenCode baseline config with explicit model, permissions, and tool settings',
188
+ });
189
+ }
190
+
191
+ const modules = options.modules || 'all';
192
+ const wantModule = (name) => modules === 'all' || (Array.isArray(modules) && modules.includes(name));
193
+
194
+ // Plugins starter
195
+ if (wantModule('plugins')) {
196
+ const pluginsDir = path.join(options.dir, '.opencode', 'plugins');
197
+ const pluginsReadme = path.join(pluginsDir, 'README.md');
198
+ if (!fs.existsSync(pluginsReadme) && !fs.existsSync(pluginsDir)) {
199
+ files.push({
200
+ path: '.opencode/plugins/README.md',
201
+ action: 'create',
202
+ family: 'opencode-plugins',
203
+ content: buildPluginsStarter(),
204
+ currentState: '.opencode/plugins/ directory is missing',
205
+ proposedState: 'create an OpenCode plugins starter with security guidance',
206
+ });
207
+ }
208
+ }
209
+
210
+ // Commands/skills starter
211
+ if (wantModule('skills')) {
212
+ const commandsDir = path.join(options.dir, '.opencode', 'commands');
213
+ const commandsReadme = path.join(commandsDir, 'README.md');
214
+ if (!fs.existsSync(commandsReadme) && !fs.existsSync(commandsDir)) {
215
+ files.push({
216
+ path: '.opencode/commands/README.md',
217
+ action: 'create',
218
+ family: 'opencode-skills',
219
+ content: buildCommandsStarter(),
220
+ currentState: '.opencode/commands/ directory is missing',
221
+ proposedState: 'create an OpenCode commands/skills starter with naming and frontmatter guidance',
222
+ });
223
+ }
224
+ }
225
+
226
+ // MCP starter
227
+ if (wantModule('mcp')) {
228
+ const configContent = ctx.configContent ? ctx.configContent() : '';
229
+ const hasMcpSection = configContent && /"mcp"\s*:/i.test(configContent);
230
+ if (!hasMcpSection) {
231
+ const domainPacks = options.domainPacks || [];
232
+ const mcpRecs = recommendOpenCodeMcpPacks(stacks, domainPacks, { ctx });
233
+ if (mcpRecs.length > 0) {
234
+ const mcpJsonc = packsToJsonc(mcpRecs.map(p => p.key));
235
+ files.push({
236
+ path: 'opencode.json (MCP append)',
237
+ action: 'append',
238
+ family: 'opencode-mcp',
239
+ content: mcpJsonc,
240
+ currentState: 'No MCP servers configured in opencode.json',
241
+ proposedState: `add ${mcpRecs.length} recommended MCP packs: ${mcpRecs.map(p => p.label).join(', ')}`,
242
+ });
243
+ }
244
+ }
245
+ }
246
+
247
+ // CI workflow starter
248
+ if (wantModule('ci')) {
249
+ const workflowDir = path.join(options.dir, '.github', 'workflows');
250
+ const opencodeWorkflow = path.join(workflowDir, 'opencode-review.yml');
251
+ if (!fs.existsSync(opencodeWorkflow)) {
252
+ files.push({
253
+ path: '.github/workflows/opencode-review.yml',
254
+ action: 'create',
255
+ family: 'opencode-ci',
256
+ content: buildCiReviewStarter(),
257
+ currentState: 'No OpenCode CI review workflow exists',
258
+ proposedState: 'create a GitHub Actions workflow for OpenCode-based PR review',
259
+ });
260
+ }
261
+ }
262
+
263
+ return { ctx, stacks, files };
264
+ }
265
+
266
+ function buildPluginsStarter() {
267
+ return [
268
+ '# OpenCode Plugins',
269
+ '',
270
+ 'Place plugin files (.js, .ts, .mjs) in this directory.',
271
+ '',
272
+ '## Security Warning',
273
+ '',
274
+ 'Plugins run **in-process** with the OpenCode agent. They can:',
275
+ '- Intercept tool calls and responses',
276
+ '- Modify agent behavior',
277
+ '- Access the local filesystem',
278
+ '',
279
+ '## Plugin format',
280
+ '',
281
+ '```typescript',
282
+ 'import { definePlugin } from "@opencode-ai/plugin";',
283
+ '',
284
+ 'export default definePlugin({',
285
+ ' name: "my-plugin",',
286
+ ' setup(api) {',
287
+ ' api.on("tool.execute.before", (event) => {',
288
+ ' // Pre-flight validation',
289
+ ' });',
290
+ ' },',
291
+ '});',
292
+ '```',
293
+ '',
294
+ '## Best practices',
295
+ '',
296
+ '- Pin npm plugin versions (never use @latest)',
297
+ '- Document what each plugin does in AGENTS.md',
298
+ '- Note: tool.execute.before does not intercept subagent/MCP calls (#5894, #2319)',
299
+ '',
300
+ `_Generated by nerviq v${version}_`,
301
+ '',
302
+ ].join('\n');
303
+ }
304
+
305
+ function buildCommandsStarter() {
306
+ return [
307
+ '# OpenCode Commands & Skills',
308
+ '',
309
+ 'Place command/skill directories here. Each needs a SKILL.md file.',
310
+ '',
311
+ '## Directory structure',
312
+ '',
313
+ '```',
314
+ '.opencode/commands/',
315
+ ' my-skill/',
316
+ ' SKILL.md # Required: name, description, instructions',
317
+ ' helpers.js # Optional: supporting files',
318
+ '```',
319
+ '',
320
+ '## SKILL.md format',
321
+ '',
322
+ '```markdown',
323
+ '---',
324
+ 'name: my-skill',
325
+ 'description: Short description for implicit invocation',
326
+ '---',
327
+ '',
328
+ '# My Skill',
329
+ '',
330
+ 'Instructions for OpenCode when this skill is invoked.',
331
+ '```',
332
+ '',
333
+ '## Critical naming rules',
334
+ '',
335
+ '- Use **kebab-case** for skill directory names (e.g., `code-review`, not `CodeReview`)',
336
+ '- PascalCase names have 0% implicit invocation success rate',
337
+ '- Keep descriptions short for bounded context cost',
338
+ '',
339
+ `_Generated by nerviq v${version}_`,
340
+ '',
341
+ ].join('\n');
342
+ }
343
+
344
+ function buildCiReviewStarter() {
345
+ return [
346
+ 'name: OpenCode Review',
347
+ '',
348
+ 'on:',
349
+ ' pull_request:',
350
+ ' types: [opened, synchronize]',
351
+ '',
352
+ 'permissions:',
353
+ ' contents: read',
354
+ ' pull-requests: write',
355
+ '',
356
+ 'env:',
357
+ ' OPENCODE_DISABLE_AUTOUPDATE: "1"',
358
+ '',
359
+ 'jobs:',
360
+ ' opencode-review:',
361
+ ' runs-on: ubuntu-latest',
362
+ ' steps:',
363
+ ' - uses: actions/checkout@v4',
364
+ ' - name: Install OpenCode',
365
+ ' run: npm install -g opencode',
366
+ ' - name: OpenCode Review',
367
+ ' run: opencode run --format json "Review this PR diff"',
368
+ ' env:',
369
+ ' ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}',
370
+ ].join('\n') + '\n';
371
+ }
372
+
373
+ async function setupOpenCode(options) {
374
+ const silent = options.silent === true;
375
+ const { ctx, stacks, files } = buildOpenCodeSetupFiles(options);
376
+ const writtenFiles = [];
377
+ const preservedFiles = [];
378
+
379
+ function log(message = '') {
380
+ if (!silent) console.log(message);
381
+ }
382
+
383
+ log('');
384
+ log('\x1b[1m nerviq opencode setup\x1b[0m');
385
+ log('\x1b[2m ═══════════════════════════════════════\x1b[0m');
386
+ if (stacks.length > 0) {
387
+ log(`\x1b[36m Detected: ${stacks.map((s) => s.label).join(', ')}\x1b[0m`);
388
+ }
389
+ log('');
390
+
391
+ for (const file of files) {
392
+ const fullPath = path.join(options.dir, file.path);
393
+ if (fs.existsSync(fullPath)) {
394
+ preservedFiles.push(file.path);
395
+ log(` \x1b[2m Skipped ${file.path} (already exists)\x1b[0m`);
396
+ continue;
397
+ }
398
+ fs.mkdirSync(path.dirname(fullPath), { recursive: true });
399
+ fs.writeFileSync(fullPath, file.content, 'utf8');
400
+ writtenFiles.push(file.path);
401
+ log(` \x1b[32m Created ${file.path}\x1b[0m`);
402
+ }
403
+
404
+ let rollbackArtifact = null;
405
+ let activityArtifact = null;
406
+ if (writtenFiles.length > 0) {
407
+ rollbackArtifact = writeRollbackArtifact(options.dir, {
408
+ sourcePlan: 'opencode-setup',
409
+ createdFiles: writtenFiles,
410
+ patchedFiles: [],
411
+ rollbackInstructions: writtenFiles.map((file) => `Delete ${file}`),
412
+ });
413
+ activityArtifact = writeActivityArtifact(options.dir, 'opencode-setup', {
414
+ platform: 'opencode',
415
+ createdFiles: writtenFiles,
416
+ preservedFiles,
417
+ stackLabels: stacks.map((item) => item.label),
418
+ rollbackArtifact: rollbackArtifact.relativePath,
419
+ });
420
+ }
421
+
422
+ log('');
423
+ log(` \x1b[1m${writtenFiles.length} files created.\x1b[0m`);
424
+ if (preservedFiles.length > 0) {
425
+ log(` \x1b[2m${preservedFiles.length} existing files preserved.\x1b[0m`);
426
+ }
427
+ if (rollbackArtifact) log(` Rollback: \x1b[1m${rollbackArtifact.relativePath}\x1b[0m`);
428
+ if (activityArtifact) log(` Activity log: \x1b[1m${activityArtifact.relativePath}\x1b[0m`);
429
+ log('');
430
+ log(' Run \x1b[1mnpx nerviq --platform opencode\x1b[0m to audit your OpenCode setup.');
431
+ log('');
432
+
433
+ return {
434
+ created: writtenFiles.length,
435
+ skipped: preservedFiles.length,
436
+ writtenFiles,
437
+ preservedFiles,
438
+ stacks,
439
+ rollbackArtifact: rollbackArtifact ? rollbackArtifact.relativePath : null,
440
+ activityArtifact: activityArtifact ? activityArtifact.relativePath : null,
441
+ };
442
+ }
443
+
444
+ module.exports = {
445
+ buildAgentsMd,
446
+ buildConfigJson,
447
+ buildOpenCodeSetupFiles,
448
+ setupOpenCode,
449
+ };