opencode-onboard 0.0.5 → 0.1.1

package/src/index.js

@@ -1,68 +1,106 @@
-#!/usr/bin/env node
-import chalk from 'chalk'
-import { checkEnv } from './steps/check-env.js'
-import { cleanAiFiles } from './steps/clean-ai-files.js'
-import { choosePlatform } from './steps/choose-platform.js'
-import { copyContentStep } from './steps/copy-content.js'
-import { chooseSkillsProvider } from './steps/choose-skills-provider.js'
-import { initOpenspec } from './steps/init-openspec.js'
-import { installBrowser } from './steps/install-browser.js'
-import { checkRtk } from './steps/check-rtk.js'
-import { checkPlatform } from './steps/check-platform.js'
-
-console.log()
-console.log(chalk.bold('┌─────────────────────────────────────┐'))
-console.log(chalk.bold('│        opencode-onboard             │'))
-console.log(chalk.bold('│  Prepare your codebase for AI agents│'))
-console.log(chalk.bold('└─────────────────────────────────────┘'))
-console.log()
-
-try {
-  // 1. Check Node + npm/pnpm
-  await checkEnv()
-
-  // 2. Clean existing AI config files
-  await cleanAiFiles()
-
-  // 3. Choose platform
-  const platform = await choosePlatform()
-
-  // 4. Copy content filtered by platform
-  await copyContentStep(platform)
-
-  // 5. Choose skills provider
-  await chooseSkillsProvider()
-
-  // 6. Init OpenSpec
-  await initOpenspec()
-
-  // 7. Install opencode-browser
-  await installBrowser()
-
-  // 8. Check rtk
-  await checkRtk()
-
-  // 9. Check platform CLI (az or gh)
-  await checkPlatform(platform)
-
-  // Done
-  console.log()
-  console.log(chalk.bold.green('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'))
-  console.log(chalk.bold.green('  Onboarding complete!'))
-  console.log(chalk.bold.green('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'))
-  console.log()
-  console.log('  Next step:')
-  console.log(chalk.cyan('  Open OpenCode in this project and type: ') + chalk.bold('"init"'))
-  console.log()
-  console.log('  OpenCode will generate ARCHITECTURE.md and DESIGN.md')
-  console.log('  from your actual codebase, then activate the agent team.')
-  console.log()
-} catch (err) {
-  if (err.name === 'ExitPromptError') {
-    console.log()
-    console.log(chalk.yellow('Cancelled.'))
-  } else {
-    console.error(chalk.red('\nUnexpected error:'), err.message)
-    process.exit(1)
-  }
+#!/usr/bin/env node
+import chalk from 'chalk'
+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 { cleanAiFiles } from './steps/clean-ai-files.js'
+import { copyContentStep } from './steps/copy-content.js'
+import { initOpenspec } from './steps/init-openspec.js'
+import { installBrowser } from './steps/install-browser.js'
+
+if (process.stdout.isTTY) console.clear()
+console.log()
+const logo = chalk.hex('#fe3d57')
+const bannerLines = [
+  logo('        ▒▒▒▒▒▒▒          '),
+  logo('        ▒▒▒▒▒▒▒▒▒▒▒▒▒        '),
+  logo('        ▒▒▓       ▓▒▓        '),
+  logo('   ▒▒▒▒▒▒▓▒▒▒▒▒▒▒▒▒▓▓▒▒▒▒▒   '),
+  logo('  ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓  '),
+  logo(' ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓▓ '),
+  logo(' ▓▒▒▒▒▒░░▒▒▒▒▒▒▒▒▒▒▒░░▒▒▒▒▓▓ '),
+  logo('  ▓▓▓▓▒▒▒▓▓▓▓▓▓▓▓▓▓▓▒▒▒▓▓▓▓  '),
+  logo('  ▓▒▒▒▒▒▒▒░▒▒▒▒▒▒▒░▒▒▒▒▒▒▓▓  '),
+  logo('  ▓▒▒▒▒▒▒░▓▒▒▓▒▓▒▒▒▒▒▒▒▒▒▓▓  '),
+  logo('  ▓▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▓   '),
+  logo('   ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ '),
+  '',
+  chalk.bold('        🧰 opencode-onboard'),
+  chalk.dim('        Prepare your codebase for AI agents'),
+]
+
+for (const line of bannerLines) console.log(line)
+console.log()
+console.log('  This tool will set up your project with a team of AI agents,')
+console.log('  install skills, select models, and configure OpenCode.')
+console.log()
+
+// Only wait for Enter in a real interactive TTY
+if (process.stdin.isTTY) {
+  console.log(chalk.bold('  Press Enter to begin...'))
+  console.log()
+  await new Promise(resolve => {
+    process.stdin.resume()
+    process.stdin.once('data', () => {
+      process.stdin.pause()
+      resolve()
+    })
+  })
 }
+})
+
+try {
+  // 1. Check Node + pnpm
+  await checkEnv()
+
+  // 2. Clean existing AI config files
+  await cleanAiFiles()
+
+  // 3. Choose platform
+  const platform = await choosePlatform()
+
+  // 4. Check platform CLI (az or gh)
+  await checkPlatform(platform)
+
+  // 5. Copy content
+  await copyContentStep(platform)
+
+  // 6. Init OpenSpec
+  await initOpenspec()
+
+  // 7. Install skills
+  await chooseSkillsProvider()
+
+  // 8. Choose models
+  await chooseModels()
+
+  // 9. Check RTK
+  await checkRtk()
+
+  // 10. Install opencode-browser
+  await installBrowser()
+
+  // Done
+  console.log()
+  console.log(chalk.bold.green('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'))
+  console.log(chalk.bold.green('  Onboarding complete!'))
+  console.log(chalk.bold.green('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'))
+  console.log()
+  console.log('  Next step:')
+  console.log(chalk.hex('#fe3d57')('  Open OpenCode in this project and type: ') + chalk.bold('"init"'))
+  console.log()
+  console.log('  OpenCode will generate ARCHITECTURE.md and DESIGN.md')
+  console.log('  from your actual codebase, then activate the agent team.')
+  console.log()
+} catch (err) {
+  if (err.name === 'ExitPromptError') {
+    console.log()
+    console.log(chalk.yellow('Cancelled.'))
+  } else {
+    console.error(chalk.red('\nUnexpected error:'), err.message)
+    process.exit(1)
+  }
+}

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

@@ -1,62 +1,76 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest'
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
+import fse from 'fs-extra'
+import os from 'os'
+import path from 'path'
 
 vi.mock('../../utils/exec.js', () => ({
   header: vi.fn(),
   success: vi.fn(),
   warn: vi.fn(),
   info: vi.fn(),
+  prompt: vi.fn(),
 }))
 
-vi.mock('../../utils/copy.js', () => ({
-  findAiFiles: vi.fn(),
-}))
-
-vi.mock('fs-extra', () => ({
-  default: { remove: vi.fn() },
-}))
-
-vi.mock('@inquirer/prompts', () => ({
-  confirm: vi.fn(),
-}))
-
-import { findAiFiles } from '../../utils/copy.js'
 import { success, warn } from '../../utils/exec.js'
-import fse from 'fs-extra'
-import { confirm } from '@inquirer/prompts'
-import { cleanAiFiles } from '../clean-ai-files.js'
 
 describe('cleanAiFiles()', () => {
-  beforeEach(() => {
+  let tmpDir
+  let originalCwd
+
+  beforeEach(async () => {
+    tmpDir = await fse.mkdtemp(path.join(os.tmpdir(), 'ob-clean-test-'))
+    originalCwd = process.cwd()
+    process.chdir(tmpDir)
     vi.clearAllMocks()
+    vi.resetModules()
+  })
+
+  afterEach(async () => {
+    process.chdir(originalCwd)
+    await fse.remove(tmpDir)
   })
 
   it('prints success when no AI files are found', async () => {
-    findAiFiles.mockResolvedValue([])
+    const { cleanAiFiles } = await import('../clean-ai-files.js')
+
+    // Simulate immediate Enter key
+    const stdinPush = () => process.stdin.emit('data', '\n')
+    setTimeout(stdinPush, 10)
 
     await cleanAiFiles()
 
     expect(success).toHaveBeenCalledWith('No existing AI config files found')
-    expect(confirm).not.toHaveBeenCalled()
   })
 
-  it('deletes files when user confirms', async () => {
-    findAiFiles.mockResolvedValue(['/proj/AGENTS.md', '/proj/CLAUDE.md'])
-    confirm.mockResolvedValue(true)
+  it('removes found AI files after Enter', async () => {
+    await fse.writeFile(path.join(tmpDir, 'AGENTS.md'), '# agents')
+    await fse.writeFile(path.join(tmpDir, 'CLAUDE.md'), '# claude')
+
+    const { cleanAiFiles } = await import('../clean-ai-files.js')
+
+    setTimeout(() => process.stdin.emit('data', '\n'), 10)
 
     await cleanAiFiles()
 
-    expect(fse.remove).toHaveBeenCalledWith('/proj/AGENTS.md')
-    expect(fse.remove).toHaveBeenCalledWith('/proj/CLAUDE.md')
+    expect(await fse.pathExists(path.join(tmpDir, 'AGENTS.md'))).toBe(false)
+    expect(await fse.pathExists(path.join(tmpDir, 'CLAUDE.md'))).toBe(false)
     expect(success).toHaveBeenCalledWith('Removed existing AI config files')
   })
 
-  it('skips deletion when user declines', async () => {
-    findAiFiles.mockResolvedValue(['/proj/AGENTS.md'])
-    confirm.mockResolvedValue(false)
+  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')
+
+    const { cleanAiFiles } = await import('../clean-ai-files.js')
+
+    setTimeout(() => process.stdin.emit('data', '\n'), 10)
 
     await cleanAiFiles()
 
-    expect(fse.remove).not.toHaveBeenCalled()
-    expect(warn).toHaveBeenCalledWith(expect.stringContaining('Skipped'))
+    expect(await fse.pathExists(path.join(agentsDir, 'agents'))).toBe(false)
+    expect(await fse.pathExists(path.join(agentsDir, 'skills', 'my-skill', 'SKILL.md'))).toBe(true)
   })
 })

package/src/steps/check-platform.js

@@ -10,7 +10,7 @@ export async function checkPlatform(platform) {
 }
 
 async function checkAzure() {
-  header('Step 9, Checking Azure DevOps CLI')
+  header('Step 4, Checking Azure DevOps CLI')
 
   // Check az is installed
   const hasAz = await commandExists('az')
@@ -51,7 +51,7 @@ async function checkAzure() {
 }
 
 async function checkGithub() {
-  header('Step 9, Checking GitHub CLI')
+  header('Step 4, Checking GitHub CLI')
 
   const hasGh = await commandExists('gh')
 

package/src/steps/check-rtk.js

@@ -1,7 +1,7 @@
 import { code, commandExists, header, info, success, warn } from '../utils/exec.js'
 
 export async function checkRtk() {
-  header('Step 8, Checking rtk')
+  header('Step 9, Checking rtk')
 
   const available = await commandExists('rtk')
 

package/src/steps/choose-models.js

@@ -0,0 +1,141 @@
+import { search } from '@inquirer/prompts'
+import fse from 'fs-extra'
+import path from 'path'
+import { header, info, success, warn } from '../utils/exec.js'
+import { fetchModels } from '../utils/models-cache.js'
+
+const COST_TIER = (input) => {
+  if (input === undefined || input === null) return ''
+  if (input < 1) return ' [$]'
+  if (input <= 10) return ' [$$]'
+  return ' [$$$]'
+}
+
+// Use canonical cost for the tier badge so all providers of the same model
+// show the same tier (e.g. github-copilot $0 subscription shows [$$] not [$])
+const COST_TIER_DISPLAY = (cost, canonicalCost) =>
+  COST_TIER(canonicalCost !== undefined ? canonicalCost : cost)
+
+function formatPrice(price) {
+  if (price === undefined || price === null) return '?'
+  if (price === 0) return '$0 (subscription)'
+  return `$${price}/M`
+}
+
+function buildDisplayModels(rawModels) {
+  return rawModels.map(m => {
+    const priceStr = formatPrice(m.cost)
+    const canonicalNote = m.canonicalCost !== undefined
+      ? ` · official price: ${formatPrice(m.canonicalCost)}/M`
+      : ''
+    return {
+      ...m,
+      label: `${m.name}${COST_TIER_DISPLAY(m.cost, m.canonicalCost)}, ${m.id}`,
+      description: `${priceStr}${canonicalNote} · context: ${m.context ? (m.context / 1000) + 'k' : '?'}`,
+    }
+  })
+}
+
+async function pickModel(message, models) {
+  return await search({
+    message,
+    source: (input) => {
+      const q = (input || '').toLowerCase()
+      const filtered = q
+        ? models.filter(m =>
+            m.label.toLowerCase().includes(q) ||
+            m.id.toLowerCase().includes(q)
+          )
+        : models
+      return filtered.slice(0, 50).map(m => ({
+        name: m.label,
+        value: m.id,
+        description: m.description,
+      }))
+    },
+  })
+}
+
+async function writeModelToAgent(agentFile, modelId) {
+  const content = await fse.readFile(agentFile, 'utf-8')
+  const updated = content.replace(
+    /^(---\n[\s\S]*?)\n---/m,
+    `$1\nmodel: ${modelId}\n---`
+  )
+  await fse.writeFile(agentFile, updated, 'utf-8')
+}
+
+export async function chooseModels() {
+  header('Step 8, Choose models')
+
+  info('Fetching available models from models.dev...')
+  const { models: rawModels, source } = await fetchModels()
+
+  if (!rawModels) {
+    warn('Could not fetch models (offline and no cache). Skipping model selection.')
+    warn('Set models later in .agents/agents/<name>.md and .opencode/opencode.json')
+    return
+  }
+
+  if (source === 'stale-cache') {
+    warn('Network unavailable, using cached model list (may be outdated).')
+  } else if (source === 'cache') {
+    info('Using cached model list (refreshes weekly).')
+  }
+
+  const models = buildDisplayModels(rawModels)
+  success(`${models.length} models available`)
+  console.log()
+  info('Cost indicators: [$] cheap  [$$] mid  [$$$] expensive')
+  info('Type to search. Change selections later in .agents/agents/ and .opencode/opencode.json')
+  console.log()
+
+  // Plan model
+  info('PLAN model, used by the main agent for proposals, specs, architecture decisions.')
+  info('Pick something capable with strong reasoning.')
+  const planModel = await pickModel('Plan model:', models)
+  console.log()
+
+  // Build model
+  info('BUILD model, used by front-engineer, back-engineer, infra-engineer, quality-engineer, security-auditor.')
+  info('Pick something capable for implementation work.')
+  const buildModel = await pickModel('Build model:', models)
+  console.log()
+
+  // Fast model
+  info('FAST model, used by devops-manager for reading issues, classifying PR comments.')
+  info('Pick something fast and cheap, no heavy reasoning needed.')
+  const fastModel = await pickModel('Fast model:', models)
+  console.log()
+
+  // Write build model to builder agents
+  const buildAgents = ['front-engineer', 'back-engineer', 'infra-engineer', 'quality-engineer', 'security-auditor']
+  const agentsDir = path.join(process.cwd(), '.agents', 'agents')
+  for (const name of buildAgents) {
+    const file = path.join(agentsDir, `${name}.md`)
+    if (await fse.pathExists(file)) {
+      await writeModelToAgent(file, buildModel)
+      success(`${name} → ${buildModel}`)
+    }
+  }
+
+  // Write fast model to devops-manager
+  const devopsFile = path.join(agentsDir, 'devops-manager.md')
+  if (await fse.pathExists(devopsFile)) {
+    await writeModelToAgent(devopsFile, fastModel)
+    success(`devops-manager → ${fastModel}`)
+  }
+
+  // Write plan model to opencode.json
+  const opencodeJsonPath = path.join(process.cwd(), '.opencode', 'opencode.json')
+  if (await fse.pathExists(opencodeJsonPath)) {
+    const config = await fse.readJson(opencodeJsonPath)
+    config.model = planModel
+    await fse.writeJson(opencodeJsonPath, config, { spaces: 2 })
+    success(`plan model → ${planModel} (written to .opencode/opencode.json)`)
+  }
+
+  console.log()
+  warn('Make sure you have API access to the selected models.')
+  warn('Change them anytime in .agents/agents/<name>.md and .opencode/opencode.json')
+}

package/src/steps/choose-skills-provider.js

@@ -1,56 +1,75 @@
 import { select } from '@inquirer/prompts'
+import { execa } from 'execa'
 import fse from 'fs-extra'
 import path from 'path'
 import { fileURLToPath } from 'url'
 import { header, info, success, warn } from '../utils/exec.js'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
-const SKILLS_PROVIDERS_PATH = path.resolve(__dirname, '../presets/skills-providers.json')
-const CONTENT_SKILLS_DIR = path.resolve(__dirname, '../../content/.opencode/skills')
+const CONTENT_SKILLS_DIR = path.resolve(__dirname, '../../content/.agents/skills')
 
-const providers = await fse.readJson(SKILLS_PROVIDERS_PATH)
+async function installObSkills() {
+  const destSkillsDir = path.join(process.cwd(), '.agents', 'skills')
+  await fse.ensureDir(destSkillsDir)
+
+  const skills = await fse.readdir(CONTENT_SKILLS_DIR)
+  for (const skill of skills) {
+    const src = path.join(CONTENT_SKILLS_DIR, skill)
+    const dest = path.join(destSkillsDir, skill)
+    const stat = await fse.stat(src)
+    if (!stat.isDirectory()) continue
+    if (await fse.pathExists(dest)) {
+      info(`${skill} already exists, skipping`)
+      continue
+    }
+    await fse.copy(src, dest)
+    success(`Installed skill: ${skill}`)
+  }
+}
 
 export async function chooseSkillsProvider() {
-  header('Step 5, Choose your skills provider')
+  header('Step 7, Installing skills')
+
+  // ob-skills are always installed, mandatory
+  info('Installing built-in ob-skills...')
+  await installObSkills()
+  console.log()
 
   info('Skills provide platform and tech-specific knowledge to your agents.')
   info('Agents detect and load skills automatically, you never need to specify them.')
+  info('You can add more skills on top of the built-in ones.')
   console.log()
 
   const selected = await select({
-    message: 'Install skills from:',
-    choices: providers.map(p => ({
-      name: `${p.label}${p.description ? `\n    ${p.description}` : ''}`,
-      value: p.value,
-    })),
+    message: 'Add additional skills from:',
+    choices: [
+      {
+        name: 'npx skills (vercel-labs/skills)',
+        value: 'npx-skills',
+        description: 'Install skills from the vercel-labs community skills registry',
+      },
+      {
+        name: 'None, built-in skills are enough',
+        value: 'none',
+      },
+    ],
   })
 
   if (selected === 'none') {
-    warn('No skills installed. Add skills to .opencode/skills/ manually.')
-    return null
+    return
   }
 
-  if (selected === 'ob-skills') {
-    const destSkillsDir = path.join(process.cwd(), '.opencode', 'skills')
-    await fse.ensureDir(destSkillsDir)
-
-    const skills = await fse.readdir(CONTENT_SKILLS_DIR)
-    for (const skill of skills) {
-      const src = path.join(CONTENT_SKILLS_DIR, skill)
-      const dest = path.join(destSkillsDir, skill)
-      const stat = await fse.stat(src)
-      if (!stat.isDirectory()) continue
-      if (await fse.pathExists(dest)) {
-        info(`${skill} already exists, skipping`)
-        continue
-      }
-      await fse.copy(src, dest)
-      success(`Installed skill: ${skill}`)
+  if (selected === 'npx-skills') {
+    info('Running npx skills...')
+    console.log()
+    try {
+      await execa('npx', ['skills'], {
+        cwd: process.cwd(),
+        stdio: 'inherit',
+        reject: false,
+      })
+    } catch (err) {
+      warn(`npx skills failed: ${err.message}`)
     }
-    return selected
   }
-
-  // Custom provider, future: support npx <package> or git URL
-  warn(`Custom provider "${selected}" not yet supported. Add skills to .opencode/skills/ manually.`)
-  return null
 }

package/src/steps/clean-ai-files.js

@@ -1,7 +1,7 @@
 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 { header, info, prompt, success, warn } from '../utils/exec.js'
 
 export async function cleanAiFiles() {
   header('Step 2, Existing AI config files')
@@ -9,19 +9,19 @@ export async function cleanAiFiles() {
   const cwd = process.cwd()
   const found = await findAiFiles(cwd)
 
-  // Also find .opencode contents except skills/ (preserve user skills)
-  const opencodeDir = path.join(cwd, '.opencode')
-  const opencodeEntries = []
-  if (await fse.pathExists(opencodeDir)) {
-    const entries = await fse.readdir(opencodeDir)
+  // Also find .agents contents except skills/ (preserve user skills)
+  const agentsDir = path.join(cwd, '.agents')
+  const agentsEntries = []
+  if (await fse.pathExists(agentsDir)) {
+    const entries = await fse.readdir(agentsDir)
     for (const entry of entries) {
       if (entry !== 'skills') {
-        opencodeEntries.push(path.join(opencodeDir, entry))
+        agentsEntries.push(path.join(agentsDir, entry))
       }
     }
   }
 
-  const allFiles = [...found, ...opencodeEntries]
+  const allFiles = [...found, ...agentsEntries]
 
   if (allFiles.length === 0) {
     success('No existing AI config files found')
@@ -33,7 +33,7 @@ export async function cleanAiFiles() {
     info(f.replace(cwd, '.'))
   }
   console.log()
-  info('Press Enter to remove them all (your .opencode/skills/ will be kept)')
+  prompt('Press Enter to remove them all (your .agents/skills/ will be kept)')
   console.log()
 
   await new Promise(resolve => {

package/src/steps/copy-content.js

@@ -7,7 +7,7 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url))
 const CONTENT_DIR = path.resolve(__dirname, '../../content')
 
 export async function copyContentStep(platform) {
-  header('Step 4, Copying opencode-onboard files')
+  header('Step 5, Copying opencode-onboard files')
 
   const dest = process.cwd()