Skip to main content
GitWhisper provides several commands to manage your configuration and preferences.

​
save-key

Save API keys for different AI models to avoid entering them repeatedly.

​
Usage

gitwhisper save-key
# or use the shorthand
gw save-key

​
Options

​
--model
string
AI model to save the key for.Allowed values:
  • claude - Anthropic Claude
  • openai - OpenAI GPT models
  • gemini - Google Gemini
  • grok - xAI Grok
  • llama - Meta Llama
  • deepseek - DeepSeek, Inc.
  • github - GitHub Models
  • ollama - Ollama
Note: free model doesn’t require an API keyShorthand: -m
​
--key
string
The API key to save. If not provided, you’ll be prompted to enter it securely (hidden input).Shorthand: -k

​
Examples

gw save-key
# Prompts:
# 1. Select the AI model
# 2. Enter API key (hidden)

​
Terminal Output

$ gw save-key --model claude
Enter the API key for claude: ********
API key for claude saved successfully.

​
set-defaults

Configure default settings for commits, including model selection, confirmation preferences, and behavior options.

​
Usage

gw set-defaults

​
Options

​
--model
string
Set the default AI model for all commits.Allowed values: claude, openai, gemini, grok, llama, deepseek, github, ollama, freeShorthand: -m
​
--model-variant
string
Set the default model variant.Examples: gpt-4o, claude-sonnet-4-20250514, gemini-2.0-flashShorthand: -v
​
--base-url
string
default:"http://localhost:11434"
Base URL for Ollama server (Ollama only).Shorthand: -u
​
--confirm-commits
boolean
default:"false"
Always confirm commit messages before applying. Enables interactive review workflow.
​
--no-confirm-commits
boolean
default:"false"
Never confirm commit messages (auto-commit mode).Note: Cannot be used with --confirm-commits
​
--allow-emojis
boolean
default:"true"
Include emojis in commit messages.Set to --no-allow-emojis to disable.
​
--max-diff-size
number
default:"50000"
Maximum diff size (in characters) before switching to file-by-file processing.
​
--max-file-size
number
default:"10"
Maximum file size (in MB) before warning about large files.

​
Examples

gw set-defaults
# Prompts for model, variant, and preferences

​
Terminal Output

$ gw set-defaults --model claude --confirm-commits
claude -> claude-sonnet-4-20250514 has been set as the default model for commits.
Commit confirmation enabled. All commits will require confirmation.

​
show-defaults

Display your current default settings.

​
Usage

gw show-defaults

​
Terminal Output

$ gw show-defaults
Current defaults:
  Model: claude
  Variant: claude-sonnet-4-20250514
  Confirm commits: enabled
  Allow emojis: enabled
  Always add: disabled

​
clear-defaults

Remove all saved default settings.

​
Usage

gw clear-defaults

​
Terminal Output

$ gw clear-defaults
All set defaults have been cleared 🍻

​
show-config

Display your complete GitWhisper configuration file.

​
Usage

gw show-config

​
Terminal Output

$ gw show-config
Gitwhisper Configs:

Api Keys:
  Claude:
    sk-ant-***
  Openai:
    sk-***

Defaults:
  Model:
    claude
  Variant:
    claude-sonnet-4-20250514

Settings:
  Confirm Commits:
    true
  Allow Emojis:
    true
  Always Add:
    false
  Max Diff Size:
    50000
  Max File Size:
    10485760

​
always-add

Configure whether GitWhisper should automatically stage changes when no staged files are found.

​
Usage

gw always-add <true|false>

​
Examples

gw always-add true

​
Terminal Output

$ gw always-add true
If there are no staged changes GitWhisper will now try to stage first before making a commit!

$ gw always-add false
If there are no staged changes, GitWhisper will abort mission!

​
Behavior

When enabled (true):
  • If no files are staged, GitWhisper automatically runs git add .
  • Proceeds directly to commit generation
  • No prompts or confirmations
When disabled (false):
  • If no files are staged, GitWhisper prompts you to stage them
  • You can choose to stage or cancel
  • More control over what gets committed

​
Configuration File Location

GitWhisper stores configuration in:
  • Linux/macOS: ~/.gitwhisper/config.yaml
  • Windows: %USERPROFILE%\.gitwhisper\config.yaml
API keys are stored securely in this file.

​
Best Practices

  1. Save API Keys Once 
    gw save-key --model openai
    Avoid passing --key flag on every command.
  2. Set Sensible Defaults 
    gw set-defaults --model claude --confirm-commits
    Configure your preferred model and enable confirmation for safety.
  3. Use Environment Variables for CI/CD 
    export OPENAI_API_KEY="sk-..."
    Don’t commit API keys to repositories.
  4. Enable always-add for Solo Projects 
    gw always-add true
    Streamlines workflow when you trust your changes.
  5. Review Configuration Periodically 
    gw show-config
    Ensure settings match your current workflow.

Build docs developers (and LLMs) love

Get started for freeTalk to us