opencode-onboard 0.3.3 → 0.4.1

package/src/steps/check-platform.js

@@ -1,80 +0,0 @@
-import { execa } from 'execa'
-import { code, commandExists, header, info, success, warn } from '../utils/exec.js'
-
-export async function checkPlatform(platform) {
-  if (platform === 'azure') {
-    await checkAzure()
-  } else {
-    await checkGithub()
-  }
-}
-
-async function checkAzure() {
-  header('Step 5, Checking Azure DevOps CLI')
-
-  // Check az is installed
-  const hasAz = await commandExists('az')
-  if (!hasAz) {
-    warn('Azure CLI (az) not found.')
-    info('Install from: https://learn.microsoft.com/en-us/cli/azure/install-azure-cli')
-    return
-  }
-  success('Azure CLI (az) available')
-
-  // Check az devops extension
-  try {
-    const result = await execa('az', ['extension', 'list', '--query', "[?name=='azure-devops']", '-o', 'tsv'], {
-      reject: false,
-    })
-    const hasExtension = result.stdout && result.stdout.includes('azure-devops')
-
-    if (hasExtension) {
-      success('azure-devops extension installed')
-    } else {
-      warn('azure-devops extension not found. Run:')
-      code([
-        '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>',
-      ])
-    }
-  } catch {
-    warn('Could not check azure-devops extension. Run:')
-    code([
-      '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>',
-    ])
-  }
-}
-
-async function checkGithub() {
-  header('Step 5, Checking GitHub CLI')
-
-  const hasGh = await commandExists('gh')
-
-  if (hasGh) {
-    success('GitHub CLI (gh) available')
-
-    // Check auth status
-    try {
-      const result = await execa('gh', ['auth', 'status'], { reject: false })
-      if (result.exitCode === 0) {
-        success('GitHub CLI authenticated')
-      } else {
-        warn('GitHub CLI not authenticated. Run:')
-        code(['gh auth login'])
-      }
-    } catch {
-      warn('Could not check gh auth status.')
-    }
-  } else {
-    warn('GitHub CLI (gh) not found.')
-    info('Install from: https://cli.github.com')
-    console.log()
-    info('After installing, authenticate with:')
-    code(['gh auth login'])
-  }
-}

package/src/steps/check-rtk.js

@@ -1,38 +0,0 @@
-import { confirm } from '@inquirer/prompts'
-import { code, commandExists, header, info, loading, success, warn } from '../utils/exec.js'
-
-export async function checkRtk(options = {}) {
-  if (!options.skipHeader) header('Checking rtk')
-
-  let shouldCheck = true
-  if (!options.skipPrompt) {
-    info('Recommended: install and verify rtk for safer agent CLI command execution.')
-    shouldCheck = await confirm({
-      message: 'Check rtk now?',
-      default: true,
-    })
-  }
-
-  if (!shouldCheck) {
-    warn('Skipped rtk check (you can install it later)')
-    return { optedIn: false, checked: false, available: false }
-  }
-
-  loading('checking rtk...')
-
-  const available = await commandExists('rtk')
-
-  if (available) {
-    success('rtk is available')
-    return { optedIn: true, checked: true, available: true }
-  }
-
-  warn('rtk not found on PATH.')
-  console.log()
-  info('rtk is required for agents to run CLI commands safely.')
-  info('Install it from: https://github.com/rtk-ai/rtk#pre-built-binaries')
-  console.log()
-  info('After installing, verify with:')
-  code(['rtk --version'])
-  return { optedIn: true, checked: true, available: false }
-}

package/src/steps/choose-models.js

@@ -1,165 +0,0 @@
-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 9, 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 to read issues, write proposals, coordinate the team.')
-  info('This model needs to be strong. Use Claude Sonnet/Opus, GPT-4o, o3, or equivalent.')
-  info('A weak model here will silently skip steps and break the workflow.')
-  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('Needs to be capable for implementation work. Claude Sonnet, GPT-4o, or equivalent.')
-  const buildModel = await pickModel('Build model:', models)
-  console.log()
-
-  // Fast model
-  info('FAST model: used by devops-manager for reading issues and classifying PR comments.')
-  info('Something fast and cheap is fine here, 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 = buildModel
-    await fse.writeJson(opencodeJsonPath, config, { spaces: 2 })
-    success(`default model -> ${buildModel} (written to .opencode/opencode.json)`)
-  }
-
-  // Write build and fast models to ensemble.json
-  const ensembleJsonPath = path.join(process.cwd(), '.opencode', 'ensemble.json')
-  if (await fse.pathExists(ensembleJsonPath)) {
-    const ensemble = await fse.readJson(ensembleJsonPath)
-    delete ensemble.defaultModel
-    ensemble.modelsByAgent = {
-      ...ensemble.modelsByAgent,
-      plan: planModel,
-      build: buildModel,
-      explore: fastModel,
-    }
-    await fse.writeJson(ensembleJsonPath, ensemble, { spaces: 2 })
-    success(`plan model -> ${planModel} (written to .opencode/ensemble.json)`)
-    success(`build model -> ${buildModel} (written to .opencode/ensemble.json)`)
-    success(`fast model -> ${fastModel} (written to .opencode/ensemble.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')
-
-  return {
-    planModel,
-    buildModel,
-    fastModel,
-  }
-}

package/src/steps/choose-platform.js

@@ -1,22 +0,0 @@
-import { select } from '@inquirer/prompts'
-import fse from 'fs-extra'
-import path from 'path'
-import { fileURLToPath } from 'url'
-import { header, success } from '../utils/exec.js'
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url))
-const PLATFORMS_PRESET_PATH = path.resolve(__dirname, '../presets/platforms.json')
-
-const platformsPreset = await fse.readJson(PLATFORMS_PRESET_PATH)
-
-export async function choosePlatform() {
-  header('Step 4, Version control platform')
-
-  const platform = await select({
-    message: 'Which platform are you using?',
-    choices: platformsPreset.map(p => ({ name: p.name, value: p.value })),
-  })
-
-  success(`Platform: ${platform === 'github' ? 'GitHub' : 'Azure DevOps'}`)
-  return platform
-}

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

@@ -1,79 +0,0 @@
-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 CONTENT_SKILLS_DIR = path.resolve(__dirname, '../../content/.agents/skills')
-
-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 8, 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: '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') {
-    return { additionalSkillsProvider: 'none' }
-  }
-
-  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 { additionalSkillsProvider: 'npx-skills' }
-  }
-
-  return { additionalSkillsProvider: selected }
-}

package/src/steps/copy-content.js

@@ -1,89 +0,0 @@
-import fse from 'fs-extra'
-import path from 'path'
-import { fileURLToPath } from 'url'
-import { copyContent } from '../utils/copy.js'
-import { error, header, success } from '../utils/exec.js'
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url))
-const CONTENT_DIR = path.resolve(__dirname, '../../content')
-
-function formatRootsForText(roots = [], cwd = process.cwd()) {
-  if (!roots.length) return ['current folder']
-  return roots.map(r => {
-    const rel = path.relative(cwd, r)
-    if (!rel || rel === '') return 'current folder'
-    if (!rel.startsWith('..')) return rel
-    return rel.replace(/\\/g, '/')
-  })
-}
-
-async function patchSourceScopeFiles(dest, ctx) {
-  const roots = formatRootsForText(ctx.sourceRoots || [dest], dest)
-  const rootsInline = roots.join(', ')
-  const rootsBullets = roots.map(r => `  - ${r}`).join('\n')
-
-  const agentsPath = path.join(dest, 'AGENTS.md')
-  if (await fse.pathExists(agentsPath)) {
-    let content = await fse.readFile(agentsPath, 'utf-8')
-    content = content.replace(
-      'Before scanning, load source roots from `.agents/source-roots.json` when present. Only scan those roots plus this repo\'s docs/config files.',
-      `Source roots selected during onboarding (scan these roots plus this repo docs/config): ${rootsInline}.`
-    )
-    content = content.replace(
-      '4. **Analyze the actual codebase**: use `.agents/source-roots.json` as source roots when present, then read CSS files, Tailwind config, component files, token definitions. Do not rely on prior knowledge, read the files.',
-      `4. **Analyze the actual codebase** using these source roots:\n${rootsBullets}\n\n   Then read CSS files, Tailwind config, component files, token definitions. Do not rely on prior knowledge, read the files.`
-    )
-    content = content.replace(
-      '4. **Analyze the actual codebase**: use `.agents/source-roots.json` as source roots when present, then read folder structure, config files, route definitions, data models, integration points. Do not rely on prior knowledge, read the files.',
-      `4. **Analyze the actual codebase** using these source roots:\n${rootsBullets}\n\n   Then read folder structure, config files, route definitions, data models, integration points. Do not rely on prior knowledge, read the files.`
-    )
-    content = content.replace(
-      '- Read source scope from `.agents/source-roots.json`.',
-      `- Source roots selected during onboarding: ${rootsInline}.`
-    )
-    await fse.writeFile(agentsPath, content, 'utf-8')
-  }
-
-  const designPath = path.join(dest, 'DESIGN.md')
-  if (await fse.pathExists(designPath)) {
-    let content = await fse.readFile(designPath, 'utf-8')
-    const injection = `\nSource roots selected during onboarding:\n${rootsBullets}\n\nWhen analyzing, read UI/design evidence only from these roots.\n\nIn the generated DESIGN.md, add this section near the top:\n\n## Source Roots Used\n${rootsBullets}\n`
-    content = content.replace(
-      'Analyze the design system of this codebase with the goal of creating a DESIGN.md file in the project root and giving the user a file for easy copy & pasting.',
-      'Analyze the design system of this codebase with the goal of creating a DESIGN.md file in the project root and giving the user a file for easy copy & pasting.' + injection
-    )
-    await fse.writeFile(designPath, content, 'utf-8')
-  }
-
-  const architecturePath = path.join(dest, 'ARCHITECTURE.md')
-  if (await fse.pathExists(architecturePath)) {
-    let content = await fse.readFile(architecturePath, 'utf-8')
-    const injection = `\nSource roots selected during onboarding:\n${rootsBullets}\n\nWhen analyzing, read architecture evidence only from these roots.\n\nIn the generated ARCHITECTURE.md, add this section near the top:\n\n## Source Roots Used\n${rootsBullets}\n`
-    content = content.replace(
-      'Analyze the architecture of this codebase with the goal of creating an ARCHITECTURE.md file in the project root and giving the user a file for easy copy & pasting.',
-      'Analyze the architecture of this codebase with the goal of creating an ARCHITECTURE.md file in the project root and giving the user a file for easy copy & pasting.' + injection
-    )
-    await fse.writeFile(architecturePath, content, 'utf-8')
-  }
-}
-
-export async function copyContentStep(platform, ctx = {}) {
-  header('Step 6, Copying opencode-onboard files')
-
-  const dest = process.cwd()
-
-  try {
-    await copyContent(CONTENT_DIR, dest, platform, ctx)
-    const rootsFile = path.join(dest, '.agents', 'source-roots.json')
-    await fse.ensureDir(path.dirname(rootsFile))
-    await fse.writeJson(rootsFile, {
-      mode: ctx.sourceMode || 'current',
-      roots: ctx.sourceRoots || [dest],
-    }, { spaces: 2 })
-    await patchSourceScopeFiles(dest, ctx)
-    success('Files copied to project root')
-  } catch (err) {
-    error(`Failed to copy content: ${err.message}`)
-    process.exit(1)
-  }
-}

package/src/steps/enable-caveman-guidance.js

@@ -1,78 +0,0 @@
-import path from 'node:path'
-import fse from 'fs-extra'
-import { info, success, warn } from '../utils/exec.js'
-
-const MARKER_START = '<!-- CAVEMAN-GUIDANCE-START -->'
-const MARKER_END = '<!-- CAVEMAN-GUIDANCE-END -->'
-
-const AGENTS_BLOCK = `${MARKER_START}
-## Caveman Mode
-
-caveman mode. Active now. Every response. No revert.
-${MARKER_END}`
-
-const OPSX_BLOCK = `${MARKER_START}
-## Caveman Mode
-
-caveman mode. Active now. Every response. No revert.
-${MARKER_END}`
-
-async function appendBlockIfMissing(filePath, block) {
-  if (!await fse.pathExists(filePath)) return { ok: false, reason: 'missing-file' }
-
-  const current = await fse.readFile(filePath, 'utf-8')
-  if (current.includes(MARKER_START)) return { ok: true, changed: false }
-
-  const next = `${current.replace(/\s*$/, '')}\n\n${block}\n`
-  await fse.writeFile(filePath, next, 'utf-8')
-  return { ok: true, changed: true }
-}
-
-export async function enableCavemanGuidance(cavemanResult) {
-  if (!cavemanResult?.installed) {
-    info('Caveman guidance skipped (caveman not installed)')
-    return { enabled: false }
-  }
-
-  const targets = [
-    { rel: 'AGENTS.md', block: AGENTS_BLOCK },
-  ]
-
-  const commandsDir = path.join(process.cwd(), '.opencode', 'commands')
-  if (await fse.pathExists(commandsDir)) {
-    const entries = await fse.readdir(commandsDir)
-    for (const name of entries) {
-      if (!/^opsx-.*\.md$/i.test(name)) continue
-      targets.push({ rel: path.join('.opencode', 'commands', name), block: OPSX_BLOCK })
-    }
-  }
-
-  const skillsDir = path.join(process.cwd(), '.opencode', 'skills')
-  if (await fse.pathExists(skillsDir)) {
-    const skillEntries = await fse.readdir(skillsDir)
-    for (const dirName of skillEntries) {
-      if (!/^openspec-/i.test(dirName)) continue
-      targets.push({ rel: path.join('.opencode', 'skills', dirName, 'SKILL.md'), block: OPSX_BLOCK })
-    }
-  }
-
-  let changedCount = 0
-  for (const target of targets) {
-    const abs = path.join(process.cwd(), target.rel)
-    try {
-      const res = await appendBlockIfMissing(abs, target.block)
-      if (!res.ok) {
-        warn(`Could not apply caveman guidance to ${target.rel} (${res.reason})`)
-      } else if (res.changed) {
-        changedCount++
-      }
-    } catch (err) {
-      warn(`Could not apply caveman guidance to ${target.rel}: ${err.message}`)
-    }
-  }
-
-  if (changedCount > 0) success('Caveman guidance enabled in AGENTS/OpenSpec prompts')
-  else info('Caveman guidance already present')
-
-  return { enabled: true, patchedFiles: changedCount }
-}