opencode-onboard 0.3.3 → 0.4.1

package/src/index.js

@@ -3,23 +3,15 @@ import chalk from 'chalk'
 import fse from 'fs-extra'
 import { createRequire } from 'node:module'
 import path from 'node:path'
-import { checkEnv } from './steps/check-env.js'
-import { checkPlatform } from './steps/check-platform.js'
-import { checkRtk } from './steps/check-rtk.js'
-import { chooseModels } from './steps/choose-models.js'
-import { choosePlatform } from './steps/choose-platform.js'
-import { chooseSkillsProvider } from './steps/choose-skills-provider.js'
-import { chooseSourceScope } from './steps/choose-source-scope.js'
-import { cleanAiFiles } from './steps/clean-ai-files.js'
-import { copyContentStep } from './steps/copy-content.js'
-import { enableCavemanGuidance } from './steps/enable-caveman-guidance.js'
-import { initOpenspec } from './steps/init-openspec.js'
-import { installBrowser } from './steps/install-browser.js'
-import { installCaveman } from './steps/install-caveman.js'
-import { installQuota } from './steps/install-quota.js'
-import { patchAgentsMd } from './steps/patch-agents-md.js'
-import { tokenOptimizationStep } from './steps/token-optimization.js'
-import { writeOnboardConfig } from './steps/write-onboard-config.js'
+import { installBrowser } from './steps/browser/index.js'
+import { cleanAiFiles } from './steps/clean/index.js'
+import { copyContentStep } from './steps/copy/index.js'
+import { chooseModels } from './steps/models/index.js'
+import { initOpenspec } from './steps/openspec/index.js'
+import { tokenOptimizationStep } from './steps/optimization/index.js'
+import { choosePlatform } from './steps/platform/index.js'
+import { chooseSourceScope } from './steps/source/index.js'
+import { writeOnboardConfig } from './steps/metadata/index.js'
 
 function printHelp(version) {
   console.log(`opencode-onboard v${version}`)
@@ -33,12 +25,8 @@ function printHelp(version) {
   console.log('  platform        Run platform selection step')
   console.log('  copy            Run content copy step')
   console.log('  openspec        Run OpenSpec initialization step')
-  console.log('  skills          Run skills install step')
   console.log('  models          Run models selection step')
   console.log('  optimization    Run token optimization tools step')
-  console.log('  quota           Run opencode-quota installer step')
-  console.log('  rtk             Run rtk check step')
-  console.log('  caveman         Run caveman install + guidance steps')
   console.log('  browser         Run opencode-browser installer step')
   console.log('  metadata        Write onboarding metadata step')
   console.log()
@@ -78,29 +66,15 @@ async function runSingleCommand(command) {
     },
     copy: async () => {
       await copyContentStep(resolvedPlatform, ctx)
-      await patchAgentsMd(ctx)
     },
     openspec: async () => {
       await initOpenspec()
     },
-    skills: async () => {
-      await chooseSkillsProvider()
-    },
     models: async () => {
       await chooseModels()
     },
     optimization: async () => {
-      await tokenOptimizationStep({ skillsProvider: savedWizard?.additionalSkillsProvider })
-    },
-    quota: async () => {
-      await installQuota()
-    },
-    rtk: async () => {
-      await checkRtk()
-    },
-    caveman: async () => {
-      const caveman = await installCaveman({ skillsProvider: savedWizard?.additionalSkillsProvider })
-      await enableCavemanGuidance(caveman)
+      await tokenOptimizationStep({ ctx })
     },
     browser: async () => {
       await installBrowser()
@@ -109,7 +83,7 @@ async function runSingleCommand(command) {
       await writeOnboardConfig({
         ...ctx,
         platform: resolvedPlatform,
-        additionalSkillsProvider: savedWizard?.additionalSkillsProvider ?? 'none',
+        additionalSkillsProvider: 'npx-skills',
         planModel: savedWizard?.models?.plan ?? null,
         buildModel: savedWizard?.models?.build ?? null,
         fastModel: savedWizard?.models?.fast ?? null,
@@ -186,28 +160,20 @@ if (process.stdin.isTTY) {
 }
 
 try {
-  await checkEnv()
-
   const scope = await chooseSourceScope()
 
   const preserve = await cleanAiFiles()
   const ctx = { ...preserve, ...scope }
 
   const platform = await choosePlatform()
-  
-  await checkPlatform(platform)
 
   await copyContentStep(platform, ctx)
 
-  await patchAgentsMd(ctx)
-
   await initOpenspec()
 
-  const skillsSelection = await chooseSkillsProvider()
-  
   const selectedModels = await chooseModels()
 
-  const tokenOpt = await tokenOptimizationStep({ skillsProvider: skillsSelection.additionalSkillsProvider })
+  const tokenOpt = await tokenOptimizationStep({ ctx })
   const { rtk, quota, caveman, cavemanGuidance } = tokenOpt
 
   await installBrowser()
@@ -215,7 +181,7 @@ try {
   await writeOnboardConfig({
     ...ctx,
     platform,
-    ...skillsSelection,
+    additionalSkillsProvider: 'npx-skills',
     ...selectedModels,
     optionalTools: { rtk, quota, caveman },
     cavemanGuidance,

package/src/presets/browser.json

@@ -0,0 +1,18 @@
+{
+  "installer": {
+    "command": "npx",
+    "args": ["@different-ai/opencode-browser", "install"]
+  },
+  "output": {
+    "showAfter": "To load the extension",
+    "hideAfter": "Press Enter when"
+  },
+  "autoAnswers": [
+    { "trigger": "Press Enter when", "response": "" },
+    { "trigger": "Choose config location", "response": "2" },
+    { "trigger": "Add plugin automatically?", "response": "y" },
+    { "trigger": "Create one?", "response": "y" },
+    { "trigger": "Add browser-automation skill", "response": "n" },
+    { "trigger": "Check broker", "response": "n" }
+  ]
+}

package/src/presets/clean.json

@@ -0,0 +1,21 @@
+{
+  "preserve": ["DESIGN.md", "ARCHITECTURE.md", "openspec"],
+  "detectFiles": [
+    "AGENTS.md",
+    "CLAUDE.md",
+    "ARCHITECTURE.md",
+    "DESIGN.md",
+    ".cursorrules",
+    ".clinerules",
+    ".windsurfrules",
+    ".github/copilot-instructions.md",
+    "copilot-instructions.md",
+    ".aider.conf.yml",
+    ".aider",
+    ".opencode",
+    ".agents"
+  ],
+  "directoryTargets": [".opencode", ".agents"],
+  "preserveSubfolders": ["skills"],
+  "selectionMessage": "Select AI config files to remove:"
+}

package/src/presets/models.json

@@ -0,0 +1,33 @@
+{
+  "costTiers": [
+    { "max": 1, "label": "[$]" },
+    { "max": 10, "label": "[$$]" },
+    { "label": "[$$$]" }
+  ],
+  "roles": {
+    "plan": {
+      "prompt": "Plan model:",
+      "info": [
+        "PLAN model: used by the main agent to read issues, write proposals, coordinate the team.",
+        "This model needs to be strong. Use Claude Sonnet/Opus, GPT-4o, o3, or equivalent.",
+        "A weak model here will silently skip steps and break the workflow."
+      ]
+    },
+    "build": {
+      "prompt": "Build model:",
+      "info": [
+        "BUILD model: used by front-engineer, back-engineer, infra-engineer, quality-engineer, security-auditor.",
+        "Needs to be capable for implementation work. Claude Sonnet, GPT-4o, or equivalent."
+      ],
+      "agents": ["front-engineer", "back-engineer", "infra-engineer", "quality-engineer", "security-auditor"]
+    },
+    "fast": {
+      "prompt": "Fast model:",
+      "info": [
+        "FAST model: used by devops-manager for reading issues and classifying PR comments.",
+        "Something fast and cheap is fine here, no heavy reasoning needed."
+      ],
+      "agents": ["devops-manager"]
+    }
+  }
+}

package/src/presets/optimization.json

@@ -0,0 +1,22 @@
+{
+  "message": "Enable tools:",
+  "info": "Choose which optimization tools to enable (recommended: all).",
+  "timeoutMs": 30000,
+  "choices": [
+    {
+      "name": "RTK check (recommended)",
+      "value": "rtk",
+      "checked": true
+    },
+    {
+      "name": "opencode-quota plugin (recommended)",
+      "value": "quota",
+      "checked": true
+    },
+    {
+      "name": "caveman concise mode (recommended)",
+      "value": "caveman",
+      "checked": true
+    }
+  ]
+}

package/src/presets/platforms.json

@@ -1,10 +1,37 @@
 [
   {
     "value": "github",
-    "name": "GitHub"
+    "name": "GitHub",
+    "cli": {
+      "command": "gh",
+      "displayName": "GitHub CLI (gh)",
+      "installUrl": "https://cli.github.com",
+      "authCheck": {
+        "args": ["auth", "status"],
+        "notAuthenticatedMessage": "GitHub CLI not authenticated. Run:",
+        "commands": ["gh auth login"]
+      }
+    }
   },
   {
     "value": "azure",
-    "name": "Azure DevOps"
+    "name": "Azure DevOps",
+    "cli": {
+      "command": "az",
+      "displayName": "Azure CLI (az)",
+      "installUrl": "https://learn.microsoft.com/en-us/cli/azure/install-azure-cli",
+      "extensionCheck": {
+        "args": ["extension", "list", "--query", "[?name=='azure-devops']", "-o", "tsv"],
+        "expectedOutput": "azure-devops",
+        "missingMessage": "azure-devops extension not found. Run:",
+        "errorMessage": "Could not check azure-devops extension. Run:",
+        "commands": [
+          "az extension add --name azure-devops",
+          "az config set extension.dynamic_install_allow_preview=true",
+          "az login",
+          "az devops login --organization https://dev.azure.com/<your-org>"
+        ]
+      }
+    }
   }
 ]

package/src/presets/quota.json

@@ -0,0 +1,14 @@
+{
+  "plugin": "@slkiser/opencode-quota@latest",
+  "prompt": {
+    "message": "Install opencode-quota with recommended defaults?",
+    "default": true,
+    "timeoutMs": 20000
+  },
+  "defaults": {
+    "enabledProviders": "auto",
+    "formatStyle": "singleWindow",
+    "percentDisplayMode": "used",
+    "showSessionTokens": true
+  }
+}

package/src/presets/source.json

@@ -0,0 +1,17 @@
+{
+  "message": "Source code location:",
+  "default": "current",
+  "choices": [
+    {
+      "name": "Current folder (default)",
+      "value": "current",
+      "description": "Use this repository only"
+    },
+    {
+      "name": "Select folders in parent (../)",
+      "value": "parent",
+      "description": "Use when this repo only contains agent config"
+    }
+  ],
+  "parentSelectionMessage": "Select source folders from parent directory:"
+}

package/src/steps/browser/browser.test.js

@@ -0,0 +1,81 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest'
+
+vi.mock('../../utils/exec.js', () => ({
+  header: vi.fn(),
+  info: vi.fn(),
+  success: vi.fn(),
+  warn: vi.fn(),
+  error: vi.fn(),
+}))
+
+vi.mock('fs-extra', () => ({
+  default: {
+    readJson: vi.fn().mockResolvedValue({
+      installer: { command: 'npx', args: ['@different-ai/opencode-browser', 'install'] },
+      output: { showAfter: '===', hideAfter: '===' },
+      autoAnswers: [
+        { trigger: 'Install', response: 'y' },
+      ],
+    }),
+  },
+}))
+
+vi.mock('execa', () => ({
+  execa: vi.fn(),
+}))
+
+import fse from 'fs-extra'
+import { installBrowser } from './index.js'
+
+describe('installBrowser()', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+  })
+
+  it('calls installer command from preset', async () => {
+    const { execa } = await import('execa')
+    const mockChild = {
+      stdout: { on: vi.fn() },
+      stderr: { on: vi.fn() },
+      stdin: { write: vi.fn() },
+      then: (cb) => cb({ exitCode: 0 }),
+    }
+    execa.mockReturnValue(mockChild)
+
+    await installBrowser()
+
+    expect(execa).toHaveBeenCalledWith('npx', expect.arrayContaining('@different-ai/opencode-browser'), expect.any(Object))
+  })
+
+  it('logs success when exit code is 0', async () => {
+    const { execa } = await import('execa')
+    const mockChild = {
+      stdout: { on: vi.fn() },
+      stderr: { on: vi.fn() },
+      stdin: { write: vi.fn() },
+      then: (cb) => cb({ exitCode: 0 }),
+    }
+    execa.mockReturnValue(mockChild)
+    const { success } = await import('../../utils/exec.js')
+
+    await installBrowser()
+
+    expect(success).toHaveBeenCalledWith('opencode-browser installed')
+  })
+
+  it('logs warning when exit code is non-zero', async () => {
+    const { execa } = await import('execa')
+    const mockChild = {
+      stdout: { on: vi.fn() },
+      stderr: { on: vi.fn() },
+      stdin: { write: vi.fn() },
+      then: (cb) => cb({ exitCode: 1 }),
+    }
+    execa.mockReturnValue(mockChild)
+    const { warn } = await import('../../utils/exec.js')
+
+    await installBrowser()
+
+    expect(warn).toHaveBeenCalledWith('opencode-browser install exited with non-zero code')
+  })
+})

package/src/steps/{install-browser.js → browser/index.js}

@@ -1,35 +1,32 @@
 import { execa } from 'execa'
-import { header, info, success, warn, error } from '../utils/exec.js'
+import fse from 'fs-extra'
+import { header, info, success, warn, error } from '../../utils/exec.js'
 import os from 'os'
+import path from 'path'
+import { fileURLToPath } from 'url'
 
-const AUTO_ANSWERS = [
-  { trigger: 'Press Enter when',             response: '' },
-  { trigger: 'Choose config location',       response: '2' },
-  { trigger: 'Add plugin automatically?',    response: 'y' },
-  { trigger: 'Create one?',                  response: 'y' },
-  { trigger: 'Add browser-automation skill', response: 'n' },
-  { trigger: 'Check broker',                 response: 'n' },
-]
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const BROWSER_PRESET_PATH = path.resolve(__dirname, '../../presets/browser.json')
+const browserPreset = await fse.readJson(BROWSER_PRESET_PATH)
 
 export async function installBrowser() {
-  header('Step 11, Installing opencode-browser')
+  header('Step 9, Installing opencode-browser')
 
   try {
-    const child = execa('npx', ['@different-ai/opencode-browser', 'install'], {
+    const child = execa(browserPreset.installer.command, browserPreset.installer.args, {
       cwd: os.homedir(),
       stdio: ['pipe', 'pipe', 'pipe'],
       reject: false,
     })
 
-    const pendingTriggers = [...AUTO_ANSWERS]
+    const pendingTriggers = [...browserPreset.autoAnswers]
     let show = false
 
     child.stdout.on('data', (chunk) => {
       const text = chunk.toString()
 
-      // Show only the load/pin instructions, hide everything else
-      if (text.includes('To load the extension')) show = true
-      if (text.includes('Press Enter when'))      show = false
+      if (text.includes(browserPreset.output.showAfter)) show = true
+      if (text.includes(browserPreset.output.hideAfter)) show = false
 
       if (show) process.stdout.write(chunk)
 

package/src/steps/{__tests__/clean-ai-files.test.js → clean/clean.test.js}

@@ -3,6 +3,10 @@ import fse from 'fs-extra'
 import os from 'os'
 import path from 'path'
 
+vi.mock('@inquirer/prompts', () => ({
+  checkbox: vi.fn(),
+}))
+
 vi.mock('../../utils/exec.js', () => ({
   header: vi.fn(),
   success: vi.fn(),
@@ -11,7 +15,8 @@ vi.mock('../../utils/exec.js', () => ({
   prompt: vi.fn(),
 }))
 
-import { success, warn } from '../../utils/exec.js'
+import { success } from '../../utils/exec.js'
+import { checkbox } from '@inquirer/prompts'
 
 describe('cleanAiFiles()', () => {
   let tmpDir
@@ -31,24 +36,22 @@ describe('cleanAiFiles()', () => {
   })
 
   it('prints success when no AI files are found', async () => {
-    const { cleanAiFiles } = await import('../clean-ai-files.js')
-
-    // Simulate immediate Enter key
-    const stdinPush = () => process.stdin.emit('data', '\n')
-    setTimeout(stdinPush, 10)
+    const { cleanAiFiles } = await import('./index.js')
 
     await cleanAiFiles()
 
     expect(success).toHaveBeenCalledWith('No existing AI config files to remove')
   })
 
-  it('removes found AI files after Enter', async () => {
+  it('removes selected AI files', async () => {
     await fse.writeFile(path.join(tmpDir, 'AGENTS.md'), '# agents')
     await fse.writeFile(path.join(tmpDir, 'CLAUDE.md'), '# claude')
+    checkbox.mockResolvedValue([
+      path.join(tmpDir, 'AGENTS.md'),
+      path.join(tmpDir, 'CLAUDE.md'),
+    ])
 
-    const { cleanAiFiles } = await import('../clean-ai-files.js')
-
-    setTimeout(() => process.stdin.emit('data', '\n'), 10)
+    const { cleanAiFiles } = await import('./index.js')
 
     await cleanAiFiles()
 
@@ -57,16 +60,28 @@ describe('cleanAiFiles()', () => {
     expect(success).toHaveBeenCalledWith('Removed existing AI config files')
   })
 
+  it('keeps unselected AI files', async () => {
+    await fse.writeFile(path.join(tmpDir, 'AGENTS.md'), '# agents')
+    await fse.writeFile(path.join(tmpDir, 'CLAUDE.md'), '# claude')
+    checkbox.mockResolvedValue([path.join(tmpDir, 'AGENTS.md')])
+
+    const { cleanAiFiles } = await import('./index.js')
+
+    await cleanAiFiles()
+
+    expect(await fse.pathExists(path.join(tmpDir, 'AGENTS.md'))).toBe(false)
+    expect(await fse.pathExists(path.join(tmpDir, 'CLAUDE.md'))).toBe(true)
+  })
+
   it('removes .agents sub-entries but preserves .agents/skills', async () => {
     const agentsDir = path.join(tmpDir, '.agents')
     await fse.ensureDir(path.join(agentsDir, 'agents'))
     await fse.ensureDir(path.join(agentsDir, 'skills', 'my-skill'))
     await fse.writeFile(path.join(agentsDir, 'agents', 'front-engineer.md'), 'agent')
     await fse.writeFile(path.join(agentsDir, 'skills', 'my-skill', 'SKILL.md'), 'skill')
+    checkbox.mockResolvedValue([path.join(agentsDir, 'agents')])
 
-    const { cleanAiFiles } = await import('../clean-ai-files.js')
-
-    setTimeout(() => process.stdin.emit('data', '\n'), 10)
+    const { cleanAiFiles } = await import('./index.js')
 
     await cleanAiFiles()
 

package/src/steps/{clean-ai-files.js → clean/index.js}

@@ -1,43 +1,34 @@
+import { checkbox } from '@inquirer/prompts'
 import fse from 'fs-extra'
 import path from 'path'
-import { findAiFiles } from '../utils/copy.js'
-import { header, info, success, warn } from '../utils/exec.js'
+import { fileURLToPath } from 'url'
+import { findAiFiles } from '../../utils/copy.js'
+import { header, info, success, warn } from '../../utils/exec.js'
 
-// Files/dirs that are valuable pre-existing work, never removed
-const PRESERVE = ['DESIGN.md', 'ARCHITECTURE.md', 'openspec']
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const CLEAN_PRESET_PATH = path.resolve(__dirname, '../../presets/clean.json')
+const cleanPreset = await fse.readJson(CLEAN_PRESET_PATH)
 
-/**
- * Enumerate immediate children of a directory.
- * Skips 'skills' to preserve user-installed skills.
- */
-async function childrenExcludingSkills(dir) {
+async function childrenExcludingPreserved(dir) {
   const results = []
   if (!await fse.pathExists(dir)) return results
   const entries = await fse.readdir(dir)
   for (const entry of entries) {
-    if (entry === 'skills') continue
+    if (cleanPreset.preserveSubfolders.includes(entry)) continue
     results.push(path.join(dir, entry))
   }
   return results
 }
 
-/**
- * Returns true if the file exists and has real content (not empty, not a prompt template).
- * Prompt templates contain a specific marker written by the onboard CLI.
- */
 async function isPopulated(filePath) {
   if (!await fse.pathExists(filePath)) return false
   const content = await fse.readFile(filePath, 'utf-8')
   const trimmed = content.trim()
   if (!trimmed) return false
-  // DESIGN.md and ARCHITECTURE.md shipped as prompt templates contain this marker
   if (trimmed.startsWith('<!-- onboard-prompt')) return false
   return true
 }
 
-/**
- * Returns true if openspec/ exists and has at least one change or archive entry.
- */
 async function hasOpenspecHistory(cwd) {
   const changesDir = path.join(cwd, 'openspec', 'changes')
   const archiveDir = path.join(cwd, 'openspec', 'archive')
@@ -53,11 +44,9 @@ async function hasOpenspecHistory(cwd) {
 }
 
 export async function cleanAiFiles() {
-  header('Step 3, Existing AI config files')
+  header('Step 2, Existing AI config files')
 
   const cwd = process.cwd()
-
-  // Detect what should be preserved before touching anything
   const ctx = {
     hasDesign: await isPopulated(path.join(cwd, 'DESIGN.md')),
     hasArchitecture: await isPopulated(path.join(cwd, 'ARCHITECTURE.md')),
@@ -68,22 +57,19 @@ export async function cleanAiFiles() {
   if (ctx.hasArchitecture) info('ARCHITECTURE.md exists and is populated, keeping it')
   if (ctx.hasOpenspec) info('openspec/ history exists, keeping it')
 
-  // Build the list of files to remove
-  const flatFiles = await findAiFiles(cwd)
-  const dirTargets = ['.opencode', '.agents']
+  const flatFiles = await findAiFiles(cwd, cleanPreset.detectFiles)
+  const dirTargets = cleanPreset.directoryTargets
   const dirEntries = []
   for (const dirName of dirTargets) {
     const dirPath = path.join(cwd, dirName)
-    const children = await childrenExcludingSkills(dirPath)
+    const children = await childrenExcludingPreserved(dirPath)
     dirEntries.push(...children)
   }
 
-  // Remove directory targets themselves from flat list (handled via children)
-  // Also remove any preserved entries
   const filteredFlat = flatFiles.filter(f => {
     const rel = path.relative(cwd, f)
     if (dirTargets.includes(rel)) return false
-    if (PRESERVE.some(p => rel === p || rel.startsWith(p + path.sep))) return false
+    if (cleanPreset.preserve.some(p => rel === p || rel.startsWith(p + path.sep))) return false
     return true
   })
 
@@ -94,8 +80,24 @@ export async function cleanAiFiles() {
     return ctx
   }
 
-  warn('Removing existing AI config files:')
-  for (const f of allToRemove) {
+  const choices = allToRemove.map(f => ({
+    name: path.relative(cwd, f).replace(/\\/g, '/'),
+    value: f,
+    checked: true,
+  }))
+
+  const selected = await checkbox({
+    message: cleanPreset.selectionMessage,
+    choices,
+  })
+
+  if (!selected || selected.length === 0) {
+    success('No AI config files selected for removal')
+    return ctx
+  }
+
+  warn('Removing selected AI config files:')
+  for (const f of selected) {
     info('  ' + f.replace(cwd + path.sep, ''))
     await fse.remove(f)
   }