client-handover 1.0.0 → 1.0.1

package/README.md

@@ -1,9 +1,11 @@
-# handover-cli
+# 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
@@ -12,21 +14,39 @@ Run one command. Get a professional handover document in Markdown, plain text, a
 npm install -g client-handover
 ```
 
-Set your Anthropic API key:
+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 |
 |---------|-------------|
-| `/handover` | Full handover document (all sections) |
+| `/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 |
@@ -36,13 +56,9 @@ Get a free API key at [console.anthropic.com](https://console.anthropic.com)
 
 ## Usage
 
-### Quick start (placeholder content)
-```bash
-handover /handover
-```
+### With your own project notes
 
-### With your project notes
-Create a plain text file with your project details:
+Create a plain text file describing your project:
 
 ```
 project-info.txt
@@ -58,54 +74,127 @@ Analytics: Google Analytics 4
 APIs: Mailchimp (newsletter), Stripe (payments)
 ```
 
-Then run:
+Then run any command with that file as input:
+
 ```bash
-handover /handover project-info.txt acme-handover
-```
+# Every section as separate files in one folder
+handover /all project-info.txt acme-client
 
-This generates:
-```
-output/
-├── acme-handover.md
-├── acme-handover.txt
-└── acme-handover.html
-```
+# Full combined doc
+handover /handover project-info.txt
 
-### Individual sections
-```bash
+# 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 formats
+## Output
 
-All commands produce three files:
+All commands generate three files per section inside an `output/` folder.
 
-- **`.md`** — Markdown, ready to paste into Notion, GitHub, or a README
-- **`.txt`** — Plain text, clean for email or printing
-- **`.html`** — Styled HTML, ready to send directly to a client
+**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'
 
-const prompt = handover('Vue 3 project hosted on Vercel...')
+// 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](https://console.anthropic.com) (free tier available)
+- 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.
 
 ---
 

package/cli.js

@@ -18,20 +18,45 @@ const COMMANDS = {
 }
 
 function printHelp() {
-  console.log(chalk.bold('\n🚀 handover-cli — Frontend Website Handover Document Generator\n'))
+  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 /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 [,, command, infoFile, outputName] = process.argv
 
@@ -40,13 +65,6 @@ async function main() {
     process.exit(0)
   }
 
-  const entry = COMMANDS[command]
-  if (!entry) {
-    console.error(chalk.red(`\n❌ Unknown command: ${command}\n`))
-    printHelp()
-    process.exit(1)
-  }
-
   // Read optional project info file
   let projectInfo = ''
   if (infoFile) {
@@ -58,6 +76,28 @@ async function main() {
     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: ${command}\n`))
+    printHelp()
+    process.exit(1)
+  }
+
   const docName = outputName || command.replace('/', '')
   const prompt = entry.fn(projectInfo)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "client-handover",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "AI-powered handover document generator for frontend developers handing off client websites",
   "type": "module",
   "main": "index.js",