Module Options

All NixKraken options are available under the programs.nixkraken attribute.

This documentation provides a complete reference for every available option. For practical, real-world examples, refer to the configuration examples.

Groups

Options are organized into logical groups exposed as children attributes to programs.nixkraken.

For example, options from the graph group are available at programs.nixkraken.graph.

Scopes

Most options in GitKraken applies to a given profile, but some of them are global to the application and will therefore apply to all profiles.

For a better discovery of options scope, we document them using the following badges:

• Global options apply globally
• Profile options apply to a specific profile

TIP

Profile options outside the profiles group apply to the default profile and additional profiles, unless overridden.

Refer to the profiles guide for further details on profile inheritance.

Root options

acceptEULA

Accept the End User License Agreement.

Scope: Global

Type: boolean

Default: false

defaultProfile.icon

Icon avatar for the default profile.

Scope: Profile

Type: constrained string

Valid values:

• Albert Keifstein
• AquaKeif
• Architect Keif
• Brainy Keif
• Butler Keif
• Captain FalKeif
• Detective Keifachu
• Developer Keif 1
• Developer Keif 2
• Dia de los Muertos
• Dr. Keif Stanz
• Flash Keif
• Git Mage
• Gitty Up
• Gourmet Sh*t
• Gravatar
• Headphones Keif
• Kaken Claus
• Kefie the Riveter
• Keif Snow
• Keif the Kraken
• Keifa Lovelace
• Keifer Simpson
• Keiferella
• Keiflo Ren
• Keiflock Holmes
• Keifuto
• Kraken Hook
• Kraknos
• Leprekraken
• LinKeif
• LumberKeif
• Martian Kraken
• Mother of Krakens
• Neo Keif
• OG
• Power Gitter
• Princess Keifia
• Pro Keif
• Rasta Keif
• Rise of SkyKraken
• Sir Keif
• Snowkraken
• Space Rocket Keif
• Stranger Krakens
• The Kraken Who Lived
• Thunder Kraken
• Top Git
• Uma Kraken
• Vanilla Keif
• Velma Keif
• Wonder Kraken
• Yoda Keif

Default: Gravatar

defaultProfile.name

Name of the default profile.

Scope: Profile

Type: string

Default: Default Profile

enable

Whether to enable NixKraken.

Scope: Global

Type: boolean

Default: false

logLevel

Set log level in activity log.

Scope: Global

Type: constrained string

Valid values:

• standard
• extended
• silly

Default: standard

package

The GitKraken package to use.

WARNING

This option:

• requires to allow unfree packages
• is mutually exclusive with version

We advise users to use the version option instead of this one, since we cannot guarantee compatibility when it is used.

Also be aware that the binary cache might not apply.

Scope: Global

Type: null or package

Default: null

Example: pkgs.unstable.gitkraken

skipTutorial

Skip the introduction tutorial.

Scope: Global

Type: boolean

Default: false

version

The GitKraken version to use.

WARNING

When using this option, the GitKraken package will automatically be fetched from a commit of nixpkgs known to be available in the cache. To benefit from the cache, users should first configure it.

This option is mutually exclusive with package.

Scope: Global

Type: null or constrained string

Valid values:

• 11.1.0
• 11.1.1
• 11.2.0
• 11.2.1
• 11.3.0
• 11.4.0
• 11.5.0

Default: 11.5.0