git

Git settings.

Type: attribute set of (submodule)

Default: { }

git.autoPrune

Automatically remove any remote-tracking references that no longer exist on the remote.

Type: boolean

Default: true

git.defaultBranch

Set the default name when initializing a new repo.

note

When not set, the app defaults to main.

Type: null or string

Default: null

git.deleteOrigAfterMerge

Automatically delete .orig files created by GitKraken client during a merge.

Type: boolean

Default: false

git.detectConflicts

Enable proactive detection of merge conflicts with target branch.

Type: boolean

Default: true

git.fetchInterval

Set the number of minutes between auto-fetches, or 0 to disable them.

note

All visible remotes for the repository will be fetched.

Type: integer between 0 and 60 (both inclusive)

Default: 1

git.package

The git package to use.

note

This is only used if git.useBundledGit is disabled.

Type: package

Default: pkgs.git

git.syncConfig

Automatically update the global Git configuration with the name and email address of the current profile.

note

If the global Git configuration is managed through Nix, this option will not have any effect.

Type: boolean

Default: false

git.updateSubmodules

Automatically keep submodules up to date when performing Git actions.

Type: boolean

Default: true

git.useBundledGit

When this option is enabled, GitKraken will use the bundled NodeGit library.

When this option is disabled, GitKraken will use the git package instead of the NodeGit library for certain Git actions including fetching and committing. This may provide increased performance and compatibility with certain projects and development environments.

If disabled, the git.package option is used to install Git and set it as the selected Git binary used by GitKraken.

Type: boolean

Default: false

git.useGitCredentialManager

Use the Git credential manager to access Git repositories.

Type: boolean

Default: false


This documentation was automatically generated from the NixKraken configuration options.

Generated on: 2025-09-14