JSPM

g-client-handover

1.3.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 13
  • Score
    100M100P100Q78299F
  • License MIT

AI-powered handover document generator for frontend developers handing off client websites

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (g-client-handover) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    gemini-client-handover

    Scott AK (sabrkei)

    npm version GitHub MIT license

    AI-powered handover document generator for frontend developers handing off websites to clients.

    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.

    Powered by Gemini CLI — no API key or credits required. Just a free Google account.


    Requirements

    npm install -g @google/gemini-cli
    gemini auth login

    Gemini CLI is free with a Google account — no paid subscription needed.


    Install

    npm install -g g-client-handover

    Or run without installing:

    npx g-client-handover /create

    Quick start

    cd my-client-project
    handover /create

    Or with npx:

    cd my-client-project
    npx g-client-handover /create

    Each run prompts you for your name, company, email, phone, the site address, and hosting company — these appear in the generated documents. Details are entered fresh each time so they're always project-specific.


    Usage

    handover /create

    Choose what to generate:

    • 1 — Technical handover (for the next developer)
    • 2 — Client handover (plain English, for your client)
    • 3 — Both

    The tool scans your project automatically — no config file needed.


    Output

    Documents are saved in your project folder:

    technical-handover/
    ├── technical-handover.md
    ├── technical-handover.txt
    └── technical-handover.docx
    
    client-handover/
    ├── client-handover.md
    ├── client-handover.txt
    └── client-handover.docx
    Format Best for
    .md Notion, GitHub, linear docs
    .txt Email attachments, quick reference
    .docx Sending directly to a client or developer

    What gets generated

    Client handover (client-handover/)

    Written in plain, friendly English for the business owner — no jargon. Includes:

    • Welcome & about your website — what the site does, who it's for, and what makes it special
    • Pages & site structure — every page listed with a plain-English description of its purpose
    • Brand colours & fonts — every detected colour shown with its name, hex code, and where it's used; the .docx version renders each colour as a visual swatch alongside the hex code
    • Images & media — a list of image and media assets found in the project, with guidance on updating them
    • What you own — plain-English summary of everything handed over (website, domain, hosting, code)
    • Logging in & managing your site — step-by-step login instructions, what's safe to change, what isn't
    • How to update content — numbered instructions for common tasks (edit text, swap an image, add a blog post)
    • Accounts & logins — every account the client now owns, where to log in, and a note on password security
    • Keeping the site healthy — renewal dates, what to check, monthly and yearly maintenance checklists
    • Getting help — when to call the developer, how to request changes, recommended next steps
    • Handover sign-off — sign-off checklist for both developer and client

    Technical handover (technical-handover/)

    Written for a developer picking up the project cold. Includes:

    • Full tech stack with versions and roles
    • Project structure and file layout
    • Local development setup with exact terminal commands
    • Build and deployment process
    • Third-party integrations and services
    • Credentials and access table
    • Known issues and technical debt
    • Maintenance guide
    • Developer handover checklist

    How it works

    1. The tool scans your project — package.json, config files, env variable keys, deploy configs, folder structure, CSS colours, image assets
    2. It builds a structured prompt and sends it to Gemini via the Gemini CLI
    3. Gemini generates a professional document tailored to the scanned project data
    4. Output is saved as .md, .txt, and .docx

    The client .docx uses a styled blue/navy colour scheme for headings and renders brand colours as visual swatches — ready to send straight to your client.


    Project structure

    gemini-client-handover/
    ├── cli.js        # CLI entry point and setup flow
    ├── generator.js  # Gemini call, markdown parser, and docx builder
    ├── prompts.js    # Prompt builders for both document types
    └── scanner.js    # Project file scanner (packages, env, CSS colours, images)

    Changelog

    v1.3.0

    • Developer details (name, company, email, phone) are now prompted fresh on every run — no config file caching
    • New prompts for site address and hosting company, which are project-specific and appear in document headers
    • Both documents now state that passwords are sent separately on client request
    • npx g-client-handover /create now works without a global install

    v1.2.0

    • Client handover folder renamed from c-handover to client-handover
    • Client document now includes brand colours with hex codes and where each colour is used
    • Client document now includes an images & media section listing assets found in the project
    • Client document now includes a dedicated pages & site structure section
    • Client .docx uses a styled blue/navy heading palette and renders colour swatches visually
    • Scanner now detects image files in common asset directories
    • Improved prompt wording for clearer, warmer, more client-friendly language

    v1.1.0

    • Initial Gemini CLI integration
    • Technical and non-technical handover documents
    • .md, .txt, and .docx output
    • First-run developer profile setup

    Contributing

    Pull requests welcome. For major changes please open an issue first.

    github.com/sabrkei/gemini-client-handover


    License

    MIT