Quick Start

This guide showcases a basic, working NixKraken configuration using Nix Flakes and Home Manager.

1. Create a flake.nix file with the following content, which sets GitKraken username and email

{
  description = "A basic NixKraken setup";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    home-manager.url = "github:nix-community/home-manager";
    home-manager.inputs.nixpkgs.follows = "nixpkgs";
    nixkraken.url = "github:nicolas-goudry/nixkraken";
  };

  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 = [
          # Import the NixKraken module
          nixkraken.homeManagerModules.nixkraken

          # Your configuration
          {
            programs.nixkraken = {
              enable = true;

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

2. Build and activate the configuration by running the command below in the same directory as flake.nix

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

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

For more advanced options and non-Flake installation, see the installation section.