Quick Start

This guide showcases a basic, working NixKraken configuration using Nix Flakes and Home Manager 25.05 on an x86-64 Linux host.

TIP

Not using Flakes? Follow our non-Flake installation guide instead.

Bootstrap Flake

Use the following content to create a flake.nix file, which sets GitKraken's username and email.

{
  description = "A basic NixKraken setup";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-25.05";

    home-manager = {
      url = "github:nix-community/home-manager/release-25.05";
      inputs.nixpkgs.follows = "nixpkgs";
    };

    nixkraken = {
      url = "github:nicolas-goudry/nixkraken/1.0.0";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs = { self, nixpkgs, home-manager, nixkraken }:
    let
      system = "x86_64-linux";
      pkgs = nixpkgs.legacyPackages.${system};
    in
    {
      homeConfigurations."your-username" = home-manager.lib.homeManagerConfiguration {
        inherit pkgs;

        modules = [
          # 1. Import the NixKraken module
          nixkraken.homeManagerModules.nixkraken

          # 2. Configure NixKraken
          {
            programs.nixkraken = {
              enable = true;

              user = {
                name = "Your Name";
                email = "your.email@example.com";
              };
            };
          }
        ];
      };
    };
}

Build and Activate Configuration

Run the command below in the same directory as flake.nix:

$ home-manager switch --flake '.#your-username'

🎉 That is it! GitKraken will now be configured with the given name and email.

Next Steps

Get to know NixKraken

• Learn by example for a quick overview of common use cases
• Read the reference for a complete picture
• Understand caveats about known issues and limitations
• Check the compatibility notice

Explore advanced configuration

• Setup the binary cache for faster builds
• Manage multiple profiles like a pro
• Make GitKraken your own with themes

Get involved

• Contribute to NixKraken, it is fun!
• Report bugs or request features on GitHub
• Suggest new ideas to improve the project