Documentation

How to install and use Handover AI CLI

Installation

Install the CLI tool directly from this server using npm:

npm install -g https://your-domain.com/handover-ai-1.0.0.tgz

1. Get your License Key

Log in to this dashboard. Your License Key (API Key) is displayed on the top page.

Go to Dashboard

2. Activate License

Run the activate command with your key to authenticate the CLI.

handover-ai activate <YOUR_LICENSE_KEY>

3. Generate Documentation

Navigate to your project root and run the generate command.

It will analyze your code and generate handover documents.

handover-ai generate

Options

  • --lang <lang>Output language (ja, en, etc.)
  • -o, --output <dir>Output directory (default: ./handover)
  • --staticSkip AI generation (static analysis only)