Getting Started

Requirements

• Node.js ≥ 18.0.0
• Git installed and available in your PATH
• An API key for at least one supported provider

Installation

Install whispercom globally from npm:

npm install -g whispercom

Verify the install:

whis --help

First-Time Setup

Run the interactive configuration wizard to choose your AI provider and model:

whis configure

The wizard will show all supported providers. Select your provider, then select a model. It will also ask for your API Key (which is safely saved locally so you don't have to keep setting environment variables).

All your choices are saved to ~/.config/whispercom/config.json.

Environment Variables

You can also use environment variables if you prefer not to store keys in the config file (great for CI/CD). Environment variables always override stored keys:

# Bash / Zsh
export ANTHROPIC_API_KEY=sk-ant-...

# PowerShell
$env:ANTHROPIC_API_KEY = "sk-ant-..."

See Providers & API Keys for all supported keys.

Your First Commit

# Stage your changes as usual
git add -p

# Let whispercom generate commit messages from the diff
whis

whispercom analyzes your staged diff, calls the AI, and presents a commit picker TUI. Navigate with arrow keys (or j/k), press Enter to commit.

Next Steps

• Providers & API Keys →
• All Commands →
• TUI Controls →