client-handover 1.4.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +48 -141
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -6,183 +6,87 @@
6
6
 
7
7
  AI-powered handover document generator for frontend developers handing off websites to clients.
8
8
 
9
- Run one command. Get a professional handover document in Markdown, plain text, and HTML — written for both your client and the next developer.
9
+ Run one command from inside your project. Get professional handover documents in Markdown, plain text, and Word — written for both your client and the next developer.
10
10
 
11
- Uses the [Claude API](https://console.anthropic.com) (Anthropic) under the hood.
11
+ Powered by [Claude Code](https://claude.ai) — no API key or credits required.
12
12
 
13
13
  ---
14
14
 
15
- ## Install
15
+ ## Requirements
16
16
 
17
- ```bash
18
- npm install -g client-handover
19
- ```
17
+ - Node.js 18+
18
+ - [Claude Code](https://claude.ai/download) installed and logged in (`claude login`)
20
19
 
21
- ### API key setup
20
+ Claude Code is free with a Claude Pro subscription.
22
21
 
23
- **If you have Claude Code installed**, no setup needed — `client-handover` will automatically use your existing Claude credentials.
22
+ ---
24
23
 
25
- **Otherwise**, set your Anthropic API key as an environment variable:
24
+ ## Install
26
25
 
27
26
  ```bash
28
- # macOS / Linux
29
- export ANTHROPIC_API_KEY=your_key_here
30
-
31
- # Windows (Command Prompt)
32
- set ANTHROPIC_API_KEY=your_key_here
33
-
34
- # Windows (PowerShell)
35
- $env:ANTHROPIC_API_KEY="your_key_here"
27
+ npm install -g client-handover
36
28
  ```
37
29
 
38
- Get a free API key at [console.anthropic.com](https://console.anthropic.com)
39
-
40
30
  ---
41
31
 
42
32
  ## Quick start
43
33
 
44
34
  ```bash
45
- handover handover
35
+ cd my-client-project
36
+ handover /create
46
37
  ```
47
38
 
48
- This generates a full handover document with placeholder content in an `output/` folder in your current directory.
49
-
50
- ---
51
-
52
- ## Commands
53
-
54
- | Command | Description |
55
- |---------|-------------|
56
- | `all` | Every section as separate files in one folder |
57
- | `handover` | Full handover document (all sections combined) |
58
- | `setup` | Project setup & dependencies |
59
- | `deploy` | Deployment & hosting info |
60
- | `credentials` | Logins & API keys template |
61
- | `license` | Licensing & attribution |
39
+ On first run you'll be asked for your name, company, email, and phone — these appear in every document you generate.
62
40
 
63
41
  ---
64
42
 
65
43
  ## Usage
66
44
 
67
- ### With your own project notes
68
-
69
- Create a plain text file describing your project:
70
-
71
- ```
72
- project-info.txt
73
- ----------------
74
- Project: Acme Corp website
75
- Stack: Vue 3, Vite, Netlify
76
- Repo: https://github.com/you/acme
77
- Live URL: https://acmecorp.com
78
- Hosting: Netlify (free tier)
79
- Domain: Namecheap, auto-renews Jan 2026
80
- CMS: Netlify CMS
81
- Analytics: Google Analytics 4
82
- APIs: Mailchimp (newsletter), Stripe (payments)
83
- ```
84
-
85
- Then run any command with that file as input:
86
-
87
45
  ```bash
88
- # Every section as separate files in one folder
89
- handover all project-info.txt acme-client
90
-
91
- # Full combined doc
92
- handover handover project-info.txt
93
-
94
- # Full combined doc with a custom output filename
95
- handover handover project-info.txt acme-handover
96
-
97
- # Individual sections
98
- handover setup project-info.txt
99
- handover deploy project-info.txt
100
- handover credentials project-info.txt
101
- handover license project-info.txt
46
+ handover /create
102
47
  ```
103
48
 
104
- The more detail you put in your project-info file, the more accurate and useful the output will be.
49
+ Choose from:
50
+ - `1` — Technical handover (for the next developer)
51
+ - `2` — Client handover (plain English, for your client)
52
+ - `3` — Both
53
+
54
+ The tool scans your project automatically — no config file needed.
105
55
 
106
56
  ---
107
57
 
108
58
  ## Output
109
59
 
110
- All commands generate three files per section inside an `output/` folder.
60
+ Documents are saved in your project folder:
111
61
 
112
- **Single command** (e.g. `handover`):
113
- ```
114
- output/
115
- ├── handover.md ← Paste into Notion, GitHub, or a README
116
- ├── handover.txt ← Clean plain text for email or printing
117
- └── handover.html ← Styled HTML ready to send directly to a client
118
62
  ```
63
+ technical-handover/
64
+ ├── technical-handover.md
65
+ ├── technical-handover.txt
66
+ └── technical-handover.docx
119
67
 
120
- **`all` command** — every section in its own subfolder:
121
- ```
122
- output/acme-client/
123
- ├── handover.md / .txt / .html
124
- ├── setup.md / .txt / .html
125
- ├── deploy.md / .txt / .html
126
- ├── credentials.md / .txt / .html
127
- └── license.md / .txt / .html
68
+ client-handover/
69
+ ├── client-handover.md
70
+ ├── client-handover.txt
71
+ └── client-handover.docx
128
72
  ```
129
73
 
130
74
  | Format | Best for |
131
75
  |--------|----------|
132
76
  | `.md` | Notion, GitHub, linear docs |
133
77
  | `.txt` | Email attachments, printing |
134
- | `.html`| Sending directly to a client |
135
-
136
- ---
137
-
138
- ## Use as a library
139
-
140
- You can also import the prompt builders and doc generator directly into your own project:
141
-
142
- ```js
143
- import { handover, setup, generateDoc } from 'client-handover'
144
-
145
- // Build a prompt from your project info string
146
- const prompt = handover('Vue 3 project hosted on Vercel, domain on Cloudflare...')
147
-
148
- // Generate and save the document
149
- await generateDoc(prompt, 'my-client', './docs')
150
- ```
151
-
152
- ### Available exports
153
-
154
- | Export | Type | Description |
155
- |--------|------|-------------|
156
- | `generateDoc(prompt, name, dir)` | async function | Calls Claude API and writes `.md`, `.txt`, `.html` |
157
- | `handover(projectInfo)` | function | Prompt builder for full handover doc |
158
- | `setup(projectInfo)` | function | Prompt builder for setup section |
159
- | `deploy(projectInfo)` | function | Prompt builder for deployment section |
160
- | `credentials(projectInfo)` | function | Prompt builder for credentials section |
161
- | `license(projectInfo)` | function | Prompt builder for licensing section |
162
-
163
- All prompt builders accept an optional `projectInfo` string. If omitted, Claude generates placeholder content.
164
-
165
- ---
166
-
167
- ## Requirements
168
-
169
- - Node.js 18+
170
- - One of the following:
171
- - [Claude Code](https://marketplace.visualstudio.com/items?itemName=anthropic.claude-code) installed (zero config — credentials detected automatically)
172
- - Or an Anthropic API key — [get one free at console.anthropic.com](https://console.anthropic.com)
78
+ | `.docx`| Sending directly to a client |
173
79
 
174
80
  ---
175
81
 
176
82
  ## How it works
177
83
 
178
- 1. You provide a plain text description of your project (or nothing, for placeholder output)
179
- 2. The CLI builds a structured prompt for Claude
180
- 3. Claude generates a professional, dual-audience document (plain English for clients, technical detail for developers)
181
- 4. The output is saved as `.md`, `.txt`, and `.html`
182
-
183
- Each document section is written for **two audiences**:
184
- - **The client** — plain English, reassuring tone, no jargon
185
- - **The next developer** — precise technical detail, commands, file paths
84
+ 1. The tool scans your project — `package.json`, config files, env variable keys, deploy configs, folder structure, CSS colours
85
+ 2. It builds a structured prompt and sends it to Claude via Claude Code
86
+ 3. Claude generates a professional document written for two audiences:
87
+ - **The client** — plain English, reassuring tone, no jargon
88
+ - **The next developer** — precise technical detail, commands, file paths
89
+ 4. Output is saved as `.md`, `.txt`, and `.docx`
186
90
 
187
91
  ---
188
92
 
@@ -190,28 +94,31 @@ Each document section is written for **two audiences**:
190
94
 
191
95
  ```
192
96
  client-handover/
193
- ├── cli.js # CLI entry point
194
- ├── index.js # Library exports
195
- ├── generator.js # Claude API call + file output
196
- ├── handover.js # Full handover prompt builder
197
- ├── setup.js # Setup section prompt builder
198
- ├── deploy.js # Deployment section prompt builder
199
- ├── credentials.js # Credentials section prompt builder
200
- └── license.js # Licensing section prompt builder
97
+ ├── cli.js # CLI entry point
98
+ ├── generator.js # Claude Code SDK call + file output
99
+ ├── prompts.js # Prompt builders
100
+ └── scanner.js # Project file scanner
201
101
  ```
202
102
 
203
103
  ---
204
104
 
205
105
  ## Changelog
206
106
 
107
+ ### 1.4.0
108
+ - Switched from Anthropic API to Claude Code SDK — no API key or credits required
109
+ - Removed `handover key` command and API key setup prompt
110
+ - Claude Code is now installed automatically as a dependency
111
+
112
+ ### 1.3.0
113
+ - Improved setup flow and document type selection
114
+
207
115
  ### 1.0.0
208
116
  - Initial release
209
117
  - Single command: `handover /create`
210
118
  - Generates two documents per run — technical handover (for developers) and client handover (plain English)
211
119
  - Auto-scans project files: package.json, config files, env variable keys, deploy configs, folder structure, CSS colours
212
- - First-run setup prompts for API key, name, company, email, and phone
120
+ - First-run setup prompts for name, company, email, and phone
213
121
  - Outputs `.md`, `.txt`, and `.docx` formats
214
- - Auto-detects Claude Code credentials — no API key setup needed if you have Claude Code installed
215
122
 
216
123
  ---
217
124
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "client-handover",
3
- "version": "1.4.0",
3
+ "version": "1.4.1",
4
4
  "description": "AI-powered handover document generator for frontend developers handing off client websites",
5
5
  "type": "module",
6
6
  "bin": {
@@ -29,7 +29,7 @@
29
29
  "node": ">=18"
30
30
  },
31
31
  "dependencies": {
32
- "@anthropic-ai/claude-code": "latest",
32
+ "@anthropic-ai/claude-code": "*",
33
33
  "chalk": "^5.3.0",
34
34
  "docx": "^8.5.0"
35
35
  }