client-handover 1.0.5 → 1.1.0

package/README.md

@@ -200,6 +200,17 @@ client-handover/
 
 ## Changelog
 
+### 1.1.0
+- Complete CLI redesign: all section commands replaced with a single `handover /create` command
+- Now generates two separate documents per run — a technical handover (for the incoming developer) and a non-technical client guide (for the business owner)
+- First-run developer info prompt — saves your name, company, email, and phone to config so every document is personalised
+- CSS colour detection — automatically extracts hex colours and CSS custom properties from `.css`, `.scss`, `.less` files and Tailwind config
+
+### 1.0.6
+- Auto-scans your actual project files on every run — reads package.json, config files, env variable keys, deploy configs, folder structure, and more
+- Generated documents are now tailored to your real project, not generic templates
+- Extra notes file still supported as optional additional context
+
 ### 1.0.5
 - Interactive API key setup prompt on install — no manual config needed
 - Added `handover key <api-key>` command to save key at any time

package/cli.js

@@ -1,72 +1,103 @@
 #!/usr/bin/env node
 
-import { setup } from './setup.js'
-import { deploy } from './deploy.js'
-import { credentials } from './credentials.js'
-import { handover } from './handover.js'
-import { license } from './license.js'
-import { generateDoc, saveApiKey } from './generator.js'
+import { generateDoc, loadDeveloperInfo, saveApiKey } from './generator.js'
+import { technicalHandoverPrompt, nonTechnicalHandoverPrompt } from './prompts.js'
+import { scanProject } from './scanner.js'
 import chalk from 'chalk'
+import readline from 'readline'
 import fs from 'fs'
 import path from 'path'
-
-const COMMANDS = {
-  'setup':       { fn: setup,       label: 'Project Setup & Dependencies' },
-  'deploy':      { fn: deploy,      label: 'Deployment & Hosting' },
-  'credentials': { fn: credentials, label: 'Credentials & Access' },
-  'handover':    { fn: handover,    label: 'Full Handover Document' },
-  'license':     { fn: license,     label: 'Licensing & Attribution' },
-}
+import os from 'os'
 
 function normalizeCommand(cmd) {
-  // Git Bash converts /handover → C:\Program Files\Git\handover before Node sees it
-  // path.basename extracts just the last segment regardless of what form it arrives in
   return path.basename(cmd).replace(/^\/+/, '')
 }
 
 function printHelp() {
-  console.log(chalk.bold('\n🚀 handover-cli — Frontend Website Handover - by Scott AK (sabrkei)\n'))
+  console.log(chalk.bold('\n handover — Website Handover Document Generator\n'))
   console.log(chalk.dim('Usage:'))
-  console.log('  handover <command> [project-info-file] [output-name]\n')
-  console.log(chalk.dim('Commands:'))
-  Object.entries(COMMANDS).forEach(([cmd, { label }]) => {
-    console.log(`  ${chalk.cyan(cmd.padEnd(16))} ${label}`)
-  })
-  console.log(`  ${chalk.cyan('all'.padEnd(16))} All sections in a single folder`)
-  console.log(`  ${chalk.cyan('key <api-key>'.padEnd(16))} Save your Anthropic API key (one-time setup)`)
-  console.log('\n' + chalk.dim('Examples:'))
-  console.log('  handover handover                               # Full doc with placeholders')
-  console.log('  handover setup project-info.txt                # Setup section using your notes')
-  console.log('  handover handover project-info.txt my-client   # Full doc, custom filename')
-  console.log('  handover all project-info.txt acme-client      # Every section in output/acme-client/')
+  console.log('  handover /create       Generate technical & non-technical handover documents')
+  console.log('  handover key <key>     Save your Anthropic API key\n')
+  console.log(chalk.dim('Example:'))
+  console.log('  cd my-client-project')
+  console.log('  handover /create\n')
+}
+
+function ask(rl, question) {
+  return new Promise(resolve => rl.question(question, answer => resolve(answer.trim())))
+}
+
+async function ensureDeveloperInfo() {
+  const configDir = path.join(os.homedir(), '.handover')
+  const configPath = path.join(configDir, 'config.json')
+
+  let config = {}
+  try {
+    if (fs.existsSync(configPath)) config = JSON.parse(fs.readFileSync(configPath, 'utf-8'))
+  } catch {}
+
+  if (config.developerName) {
+    return {
+      name: config.developerName,
+      company: config.developerCompany || '',
+      email: config.developerEmail || '',
+      phone: config.developerPhone || '',
+    }
+  }
+
+  console.log(chalk.bold('\n Your developer details will appear in the handover documents.\n'))
+
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout })
+  const name = await ask(rl, ' Your full name: ')
+  const company = await ask(rl, ' Your company name (or press Enter if not applicable): ')
+  const email = await ask(rl, ' Your email address: ')
+  const phone = await ask(rl, ' Your phone number (optional): ')
+  rl.close()
+
+  if (name) config.developerName = name
+  if (company) config.developerCompany = company
+  if (email) config.developerEmail = email
+  if (phone) config.developerPhone = phone
+
+  if (!fs.existsSync(configDir)) fs.mkdirSync(configDir, { recursive: true })
+  fs.writeFileSync(configPath, JSON.stringify(config, null, 2), 'utf-8')
   console.log()
+
+  return { name: name || '', company: company || '', email: email || '', phone: phone || '' }
 }
 
-async function runAll(projectInfo, folderName) {
-  const sections = [
-    { key: 'handover',     fn: handover,     label: 'Full Handover Document' },
-    { key: 'setup',        fn: setup,        label: 'Project Setup & Dependencies' },
-    { key: 'deploy',       fn: deploy,       label: 'Deployment & Hosting' },
-    { key: 'credentials',  fn: credentials,  label: 'Credentials & Access' },
-    { key: 'license',      fn: license,      label: 'Licensing & Attribution' },
-  ]
+async function runCreate() {
+  const developerInfo = await ensureDeveloperInfo()
 
-  const outputDir = `./output/${folderName}`
+  console.log(chalk.dim(' Scanning project files...'))
+  const projectInfo = scanProject(process.cwd())
 
-  console.log(chalk.bold(`\n📁 Generating all sections into: ${outputDir}\n`))
+  const techDir = './technical-handover'
+  const clientDir = './handover'
 
-  for (const section of sections) {
-    console.log(chalk.bold(`📝 Generating: ${section.label}`))
-    const prompt = section.fn(projectInfo)
-    await generateDoc(prompt, section.key, outputDir)
-    console.log()
-  }
+  console.log(chalk.bold('\n Generating Technical Handover Document...'))
+  const techPrompt = technicalHandoverPrompt(projectInfo, developerInfo)
+  await generateDoc(techPrompt, 'technical-handover', techDir)
+
+  console.log(chalk.bold('\n Generating Client Handover Document...'))
+  const nonTechPrompt = nonTechnicalHandoverPrompt(projectInfo, developerInfo)
+  await generateDoc(nonTechPrompt, 'handover', clientDir)
 
-  console.log(chalk.green.bold(`✅ All sections saved to ${outputDir}\n`))
+  console.log(chalk.green.bold('\n ✅ Handover documents created successfully!\n'))
+  console.log(`   ${chalk.cyan('./technical-handover/')}`)
+  console.log(`     technical-handover.md`)
+  console.log(`     technical-handover.txt`)
+  console.log(`     technical-handover.docx`)
+  console.log()
+  console.log(`   ${chalk.cyan('./handover/')}`)
+  console.log(`     handover.md`)
+  console.log(`     handover.txt`)
+  console.log(`     handover.docx`)
+  console.log()
 }
 
 async function main() {
-  const [,, rawCommand, infoFile, outputName] = process.argv
+  const [,, rawCommand, secondArg] = process.argv
 
   if (!rawCommand || rawCommand === '--help' || rawCommand === '-h') {
     printHelp()
@@ -76,62 +107,28 @@ async function main() {
   const command = normalizeCommand(rawCommand)
 
   if (command === 'key') {
-    const key = infoFile // second arg is the key
-    if (!key) {
-      console.error(chalk.red('\n❌ Usage: handover key <your-api-key>\n'))
+    if (!secondArg) {
+      console.error(chalk.red('\n ❌ Usage: handover key <your-api-key>\n'))
       process.exit(1)
     }
-    saveApiKey(key)
-    console.log(chalk.green('\n✅ API key saved. You\'re all set — run any handover command.\n'))
+    saveApiKey(secondArg)
+    console.log(chalk.green('\n ✅ API key saved. Run "handover /create" to get started.\n'))
     process.exit(0)
   }
 
-  // Read optional project info file
-  let projectInfo = ''
-  if (infoFile) {
-    if (!fs.existsSync(infoFile)) {
-      console.error(chalk.red(`\n❌ File not found: ${infoFile}\n`))
-      process.exit(1)
-    }
-    projectInfo = fs.readFileSync(infoFile, 'utf-8')
-    console.log(chalk.green(`\n📄 Loaded project info from: ${infoFile}`))
-  }
-
-  if (command === 'all') {
-    const folderName = outputName || 'all'
-    try {
-      await runAll(projectInfo, folderName)
-    } catch (err) {
-      if (err.status === 401) {
-        console.error(chalk.red('\n❌ Authentication failed. Set ANTHROPIC_API_KEY or install Claude Code.\n'))
-      } else {
-        console.error(chalk.red(`\n❌ Error: ${err.message}\n`))
-      }
-      process.exit(1)
-    }
-    return
-  }
-
-  const entry = COMMANDS[command]
-  if (!entry) {
-    console.error(chalk.red(`\n❌ Unknown command: ${rawCommand}\n`))
+  if (command !== 'create') {
+    console.error(chalk.red(`\n ❌ Unknown command: ${rawCommand}\n`))
     printHelp()
     process.exit(1)
   }
 
-  const docName = outputName || command
-  const prompt = entry.fn(projectInfo)
-
-  console.log(chalk.bold(`\n📝 Generating: ${entry.label}`))
-  console.log(chalk.dim(`   Output: ./output/${docName}.{md,txt,html}\n`))
-
   try {
-    await generateDoc(prompt, docName, './output')
+    await runCreate()
   } catch (err) {
     if (err.status === 401) {
-      console.error(chalk.red('\n❌ Authentication failed. Set ANTHROPIC_API_KEY or install Claude Code.\n'))
+      console.error(chalk.red('\n ❌ Authentication failed. Run "handover key <your-api-key>" to set your API key.\n'))
     } else {
-      console.error(chalk.red(`\n❌ Error: ${err.message}\n`))
+      console.error(chalk.red(`\n ❌ Error: ${err.message}\n`))
     }
     process.exit(1)
   }