client-handover 1.0.2 → 1.0.3

package/README.md

@@ -1,203 +1,203 @@
-# client-handover
-
-AI-powered handover document generator for frontend developers handing off websites to clients.
-
-Run one command. Get a professional handover document in Markdown, plain text, and HTML — written for both your client and the next developer.
-
-Uses the [Claude API](https://console.anthropic.com) (Anthropic) under the hood.
-
----
-
-## Install
-
-```bash
-npm install -g client-handover
-```
-
-Then set your Anthropic API key as an environment variable:
-
-```bash
-# macOS / Linux
-export ANTHROPIC_API_KEY=your_key_here
-
-# Windows (Command Prompt)
-set ANTHROPIC_API_KEY=your_key_here
-
-# Windows (PowerShell)
-$env:ANTHROPIC_API_KEY="your_key_here"
-```
-
-Get a free API key at [console.anthropic.com](https://console.anthropic.com)
-
----
-
-## Quick start
-
-```bash
-handover handover
-```
-
-This generates a full handover document with placeholder content in an `output/` folder in your current directory.
-
----
-
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| `all` | Every section as separate files in one folder |
-| `handover` | Full handover document (all sections combined) |
-| `setup` | Project setup & dependencies |
-| `deploy` | Deployment & hosting info |
-| `credentials` | Logins & API keys template |
-| `license` | Licensing & attribution |
-
----
-
-## Usage
-
-### With your own project notes
-
-Create a plain text file describing your project:
-
-```
-project-info.txt
-----------------
-Project: Acme Corp website
-Stack: Vue 3, Vite, Netlify
-Repo: https://github.com/you/acme
-Live URL: https://acmecorp.com
-Hosting: Netlify (free tier)
-Domain: Namecheap, auto-renews Jan 2026
-CMS: Netlify CMS
-Analytics: Google Analytics 4
-APIs: Mailchimp (newsletter), Stripe (payments)
-```
-
-Then run any command with that file as input:
-
-```bash
-# Every section as separate files in one folder
-handover all project-info.txt acme-client
-
-# Full combined doc
-handover handover project-info.txt
-
-# Full combined doc with a custom output filename
-handover handover project-info.txt acme-handover
-
-# Individual sections
-handover setup project-info.txt
-handover deploy project-info.txt
-handover credentials project-info.txt
-handover license project-info.txt
-```
-
-The more detail you put in your project-info file, the more accurate and useful the output will be.
-
----
-
-## Output
-
-All commands generate three files per section inside an `output/` folder.
-
-**Single command** (e.g. `handover`):
-```
-output/
-├── handover.md      ← Paste into Notion, GitHub, or a README
-├── handover.txt     ← Clean plain text for email or printing
-└── handover.html    ← Styled HTML ready to send directly to a client
-```
-
-**`all` command** — every section in its own subfolder:
-```
-output/acme-client/
-├── handover.md / .txt / .html
-├── setup.md / .txt / .html
-├── deploy.md / .txt / .html
-├── credentials.md / .txt / .html
-└── license.md / .txt / .html
-```
-
-| Format | Best for |
-|--------|----------|
-| `.md`  | Notion, GitHub, linear docs |
-| `.txt` | Email attachments, printing |
-| `.html`| Sending directly to a client |
-
----
-
-## Use as a library
-
-You can also import the prompt builders and doc generator directly into your own project:
-
-```js
-import { handover, setup, generateDoc } from 'client-handover'
-
-// Build a prompt from your project info string
-const prompt = handover('Vue 3 project hosted on Vercel, domain on Cloudflare...')
-
-// Generate and save the document
-await generateDoc(prompt, 'my-client', './docs')
-```
-
-### Available exports
-
-| Export | Type | Description |
-|--------|------|-------------|
-| `generateDoc(prompt, name, dir)` | async function | Calls Claude API and writes `.md`, `.txt`, `.html` |
-| `handover(projectInfo)` | function | Prompt builder for full handover doc |
-| `setup(projectInfo)` | function | Prompt builder for setup section |
-| `deploy(projectInfo)` | function | Prompt builder for deployment section |
-| `credentials(projectInfo)` | function | Prompt builder for credentials section |
-| `license(projectInfo)` | function | Prompt builder for licensing section |
-
-All prompt builders accept an optional `projectInfo` string. If omitted, Claude generates placeholder content.
-
----
-
-## Requirements
-
-- Node.js 18+
-- An Anthropic API key — [get one free at console.anthropic.com](https://console.anthropic.com)
-
----
-
-## How it works
-
-1. You provide a plain text description of your project (or nothing, for placeholder output)
-2. The CLI builds a structured prompt for Claude
-3. Claude generates a professional, dual-audience document (plain English for clients, technical detail for developers)
-4. The output is saved as `.md`, `.txt`, and `.html`
-
-Each document section is written for **two audiences**:
-- **The client** — plain English, reassuring tone, no jargon
-- **The next developer** — precise technical detail, commands, file paths
-
----
-
-## Project structure
-
-```
-client-handover/
-├── cli.js           # CLI entry point
-├── index.js         # Library exports
-├── generator.js     # Claude API call + file output
-├── handover.js      # Full handover prompt builder
-├── setup.js         # Setup section prompt builder
-├── deploy.js        # Deployment section prompt builder
-├── credentials.js   # Credentials section prompt builder
-└── license.js       # Licensing section prompt builder
-```
-
----
-
-## Contributing
-
-Pull requests are welcome. For major changes, open an issue first.
-
----
-
-## License
-
-MIT
+# claude-client-handover
+
+AI-powered handover document generator for frontend developers handing off websites to clients.
+
+Run one command. Get a professional handover document in Markdown, plain text, and HTML — written for both your client and the next developer.
+
+Uses the [Claude API](https://console.anthropic.com) (Anthropic) under the hood.
+
+---
+
+## Install
+
+```bash
+npm install -g client-handover
+```
+
+Then set your Anthropic API key as an environment variable:
+
+```bash
+# macOS / Linux
+export ANTHROPIC_API_KEY=your_key_here
+
+# Windows (Command Prompt)
+set ANTHROPIC_API_KEY=your_key_here
+
+# Windows (PowerShell)
+$env:ANTHROPIC_API_KEY="your_key_here"
+```
+
+Get a free API key at [console.anthropic.com](https://console.anthropic.com)
+
+---
+
+## Quick start
+
+```bash
+handover handover
+```
+
+This generates a full handover document with placeholder content in an `output/` folder in your current directory.
+
+---
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `all` | Every section as separate files in one folder |
+| `handover` | Full handover document (all sections combined) |
+| `setup` | Project setup & dependencies |
+| `deploy` | Deployment & hosting info |
+| `credentials` | Logins & API keys template |
+| `license` | Licensing & attribution |
+
+---
+
+## Usage
+
+### With your own project notes
+
+Create a plain text file describing your project:
+
+```
+project-info.txt
+----------------
+Project: Acme Corp website
+Stack: Vue 3, Vite, Netlify
+Repo: https://github.com/you/acme
+Live URL: https://acmecorp.com
+Hosting: Netlify (free tier)
+Domain: Namecheap, auto-renews Jan 2026
+CMS: Netlify CMS
+Analytics: Google Analytics 4
+APIs: Mailchimp (newsletter), Stripe (payments)
+```
+
+Then run any command with that file as input:
+
+```bash
+# Every section as separate files in one folder
+handover all project-info.txt acme-client
+
+# Full combined doc
+handover handover project-info.txt
+
+# Full combined doc with a custom output filename
+handover handover project-info.txt acme-handover
+
+# Individual sections
+handover setup project-info.txt
+handover deploy project-info.txt
+handover credentials project-info.txt
+handover license project-info.txt
+```
+
+The more detail you put in your project-info file, the more accurate and useful the output will be.
+
+---
+
+## Output
+
+All commands generate three files per section inside an `output/` folder.
+
+**Single command** (e.g. `handover`):
+```
+output/
+├── handover.md      ← Paste into Notion, GitHub, or a README
+├── handover.txt     ← Clean plain text for email or printing
+└── handover.html    ← Styled HTML ready to send directly to a client
+```
+
+**`all` command** — every section in its own subfolder:
+```
+output/acme-client/
+├── handover.md / .txt / .html
+├── setup.md / .txt / .html
+├── deploy.md / .txt / .html
+├── credentials.md / .txt / .html
+└── license.md / .txt / .html
+```
+
+| Format | Best for |
+|--------|----------|
+| `.md`  | Notion, GitHub, linear docs |
+| `.txt` | Email attachments, printing |
+| `.html`| Sending directly to a client |
+
+---
+
+## Use as a library
+
+You can also import the prompt builders and doc generator directly into your own project:
+
+```js
+import { handover, setup, generateDoc } from 'client-handover'
+
+// Build a prompt from your project info string
+const prompt = handover('Vue 3 project hosted on Vercel, domain on Cloudflare...')
+
+// Generate and save the document
+await generateDoc(prompt, 'my-client', './docs')
+```
+
+### Available exports
+
+| Export | Type | Description |
+|--------|------|-------------|
+| `generateDoc(prompt, name, dir)` | async function | Calls Claude API and writes `.md`, `.txt`, `.html` |
+| `handover(projectInfo)` | function | Prompt builder for full handover doc |
+| `setup(projectInfo)` | function | Prompt builder for setup section |
+| `deploy(projectInfo)` | function | Prompt builder for deployment section |
+| `credentials(projectInfo)` | function | Prompt builder for credentials section |
+| `license(projectInfo)` | function | Prompt builder for licensing section |
+
+All prompt builders accept an optional `projectInfo` string. If omitted, Claude generates placeholder content.
+
+---
+
+## Requirements
+
+- Node.js 18+
+- An Anthropic API key — [get one free at console.anthropic.com](https://console.anthropic.com)
+
+---
+
+## How it works
+
+1. You provide a plain text description of your project (or nothing, for placeholder output)
+2. The CLI builds a structured prompt for Claude
+3. Claude generates a professional, dual-audience document (plain English for clients, technical detail for developers)
+4. The output is saved as `.md`, `.txt`, and `.html`
+
+Each document section is written for **two audiences**:
+- **The client** — plain English, reassuring tone, no jargon
+- **The next developer** — precise technical detail, commands, file paths
+
+---
+
+## Project structure
+
+```
+client-handover/
+├── cli.js           # CLI entry point
+├── index.js         # Library exports
+├── generator.js     # Claude API call + file output
+├── handover.js      # Full handover prompt builder
+├── setup.js         # Setup section prompt builder
+├── deploy.js        # Deployment section prompt builder
+├── credentials.js   # Credentials section prompt builder
+└── license.js       # Licensing section prompt builder
+```
+
+---
+
+## Contributing
+
+Pull requests are welcome. For major changes, open an issue first.
+
+---
+
+## License
+
+MIT

package/cli.js

@@ -1,125 +1,128 @@
-#!/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 } from './generator.js'
-import chalk from 'chalk'
-import fs from 'fs'
-
-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' },
-}
-
-function normalizeCommand(cmd) {
-  return cmd.replace(/^\/+/, '')
-}
-
-function printHelp() {
-  console.log(chalk.bold('\n🚀 handover-cli — Frontend Website Handover - by Scott AK (sabrkei)\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('\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()
-}
-
-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' },
-  ]
-
-  const outputDir = `./output/${folderName}`
-
-  console.log(chalk.bold(`\n📁 Generating all sections into: ${outputDir}\n`))
-
-  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.green.bold(`✅ All sections saved to ${outputDir}\n`))
-}
-
-async function main() {
-  const [,, rawCommand, infoFile, outputName] = process.argv
-
-  if (!rawCommand || rawCommand === '--help' || rawCommand === '-h') {
-    printHelp()
-    process.exit(0)
-  }
-
-  const command = normalizeCommand(rawCommand)
-
-  // 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❌ Invalid API key. Set your ANTHROPIC_API_KEY environment variable.\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`))
-    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')
-  } catch (err) {
-    if (err.status === 401) {
-      console.error(chalk.red('\n❌ Invalid API key. Set your ANTHROPIC_API_KEY environment variable.\n'))
-    } else {
-      console.error(chalk.red(`\n❌ Error: ${err.message}\n`))
-    }
-    process.exit(1)
-  }
-}
-
-main()
+#!/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 } from './generator.js'
+import chalk from 'chalk'
+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' },
+}
+
+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.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('\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()
+}
+
+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' },
+  ]
+
+  const outputDir = `./output/${folderName}`
+
+  console.log(chalk.bold(`\n📁 Generating all sections into: ${outputDir}\n`))
+
+  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.green.bold(`✅ All sections saved to ${outputDir}\n`))
+}
+
+async function main() {
+  const [,, rawCommand, infoFile, outputName] = process.argv
+
+  if (!rawCommand || rawCommand === '--help' || rawCommand === '-h') {
+    printHelp()
+    process.exit(0)
+  }
+
+  const command = normalizeCommand(rawCommand)
+
+  // 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❌ Invalid API key. Set your ANTHROPIC_API_KEY environment variable.\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`))
+    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')
+  } catch (err) {
+    if (err.status === 401) {
+      console.error(chalk.red('\n❌ Invalid API key. Set your ANTHROPIC_API_KEY environment variable.\n'))
+    } else {
+      console.error(chalk.red(`\n❌ Error: ${err.message}\n`))
+    }
+    process.exit(1)
+  }
+}
+
+main()

package/package.json

@@ -1,43 +1,44 @@
-{
-  "name": "client-handover",
-  "version": "1.0.2",
-  "description": "AI-powered handover document generator for frontend developers handing off client websites",
-  "type": "module",
-  "main": "index.js",
-  "bin": {
-    "handover": "cli.js"
-  },
-  "files": [
-    "cli.js",
-    "index.js",
-    "generator.js",
-    "handover.js",
-    "setup.js",
-    "deploy.js",
-    "credentials.js",
-    "license.js",
-    "README.md"
-  ],
-  "scripts": {
-    "test": "node test.js"
-  },
-  "keywords": [
-    "handover",
-    "frontend",
-    "client",
-    "documentation",
-    "developer",
-    "claude",
-    "ai"
-  ],
-  "author": "sabrkei",
-  "license": "MIT",
-  "engines": {
-    "node": ">=18"
-  },
-  "dependencies": {
-    "@anthropic-ai/sdk": "^0.39.0",
-    "chalk": "^5.3.0",
-    "marked": "^12.0.0"
-  }
-}
+{
+  "name": "client-handover",
+  "version": "1.0.3",
+  "description": "AI-powered handover document generator for frontend developers handing off client websites",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "handover": "cli.js"
+  },
+  "files": [
+    "cli.js",
+    "index.js",
+    "generator.js",
+    "handover.js",
+    "setup.js",
+    "deploy.js",
+    "credentials.js",
+    "license.js",
+    "README.md"
+  ],
+  "scripts": {
+    "test": "node test.js"
+  },
+  "keywords": [
+    "handover",
+    "frontend",
+    "client",
+    "documentation",
+    "developer",
+    "claude",
+    "ai"
+  ],
+  "author": "sabrkei",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@anthropic-ai/sdk": "^0.39.0",
+    "chalk": "^5.3.0",
+    "client-handover": "^1.0.2",
+    "marked": "^12.0.0"
+  }
+}