but config

Without a subcommand, displays an overview of important settings including user information, target branch, forge configuration, and AI setup.

Examples

View configuration overview:

but config

View/set user configuration:

but config user
but config user set name "John Doe"
but config user set email john@example.com

View/set forge configuration:

but config forge

View/set target branch:

but config target

View/set metrics:

but config metrics

Usage: but config <COMMAND>

Subcommands

but config user

View and configure user information (name, email, editor).

Without arguments, displays current user.name, user.email, and core.editor. Use subcommands to set or unset configuration values.

Examples

View user configuration:

but config user

Set user name (locally):

but config user set name "John Doe"

Set user email globally:

but config user set --global email john@example.com

Unset a local value:

but config user unset name

Usage: but config user

but config forge

View and manage forge configuration.

Shows configured forge accounts (GitHub, GitLab, etc.) and authentication status. Use subcommands to authenticate or forget accounts.

Examples

View configured forge accounts:

but config forge

Authenticate with a forge:

but config forge auth

List authenticated accounts:

but config forge list-users

Forget an account:

but config forge forget username

Usage: but config forge

but config target

View or set the target branch.

Without arguments, displays the current target branch. With a branch name, sets the target branch.

Examples

View current target:

but config target

Set target branch:

but config target origin/main

Usage: but config target [BRANCH]

Arguments:

• <BRANCH> — New target branch to set (e.g., "origin/main")

but config metrics

View or set metrics collection.

GitButler uses metrics to help us know what is useful and improve it. Privacy policy: https://gitbutler.com/privacy

Without arguments, displays the current setting.

Examples

View metrics configuration:

but config metrics

Enable metrics:

but config metrics enable

Disable metrics:

but config metrics disable

Usage: but config metrics [STATUS]

Arguments:

• <STATUS> — Whether metrics are enabled

but config ui

View and configure UI preferences.

Without arguments, displays current UI settings. Use subcommands to set or unset configuration values.

Examples

View UI configuration:

but config ui

Enable TUI mode for diff by default:

but config ui set tui true

Disable TUI mode:

but config ui set tui false

Usage: but config ui

but config ai

View and configure AI provider settings.

Without subcommands, this starts an interactive setup flow. Use provider subcommands for non-interactive configuration.

Examples

Interactive setup:

but config ai

View current AI configuration:

but config ai show

Configure OpenAI non-interactively:

but config ai openai --key-option bring-your-own --api-key-env OPENAI_API_KEY --model gpt-5.4-nano

Configure Ollama locally:

but config ai --local ollama --endpoint localhost:11434 --model llama3.1

Usage: but config ai [OPTIONS]

Options:

• --local — Configure local repository git config instead of global user config
• --global — Configure global user git config