Mirror of home-manager
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Robin Stumm f71d41ba36
kakoune: fix ui options (#2641)
6 hours ago
.github kakoune: fix ui options (#2641) 6 hours ago
docs kakoune: fix ui options (#2641) 6 hours ago
home-manager Translate using Weblate (Spanish) 5 days ago
lib/bash home-manager: add basic i18n support 1 month ago
modules kakoune: fix ui options (#2641) 6 hours ago
nix-darwin docs: improve description of extraSpecialArgs 2 months ago
nixos kakoune: fix ui options (#2641) 6 hours ago
tests kakoune: fix ui options (#2641) 6 hours ago
.gitignore flake: add flake.nix 1 year ago
.gitlab-ci.yml gitlab-ci: build HTML manual in a simpler way 1 month ago
.release Switch to 22.05 as current development release 2 months ago
LICENSE docs: change stable from 20.03 to 20.09 1 year ago
Makefile Makefile: add test-install target 3 months ago
README.md docs: add link to contributing chapter in readme 12 hours ago
default.nix ci: verify that `meta.maintainers` evaluate 3 weeks ago
flake.nix add flake attribute apps to make it easier to run (#2442) 2 months ago
format irssi: format using nixfmt 3 months ago
overlay.nix Apply `nixfmt` on many files 2 years ago
xgettext home-manager: support i18n of install script 1 month ago


Home Manager using Nix

This project provides a basic system for managing a user environment using the Nix package manager together with the Nix libraries found in Nixpkgs. It allows declarative configuration of user specific (non global) packages and dotfiles.

Before attempting to use Home Manager please read the warning below.

For a more systematic overview of Home Manager and its available options, please see the Home Manager manual.

If you would like to contribute to Home Manager then please have a look at the contributing chapter of the manual.

Words of warning

Unfortunately, it is quite possible to get difficult to understand errors when working with Home Manager, such as infinite loops with no clear source reference. You should therefore be comfortable using the Nix language and the various tools in the Nix ecosystem. Reading through the Nix Pills document is a good way to familiarize yourself with them.

If you are not very familiar with Nix but still want to use Home Manager then you are strongly encouraged to start with a small and very simple configuration and gradually make it more elaborate as you learn.

In some cases Home Manager cannot detect whether it will overwrite a previous manual configuration. For example, the Gnome Terminal module will write to your dconf store and cannot tell whether a configuration that it is about to be overwritten was from a previous Home Manager generation or from manual configuration.

Home Manager targets NixOS unstable and NixOS version 21.11 (the current stable version), it may or may not work on other Linux distributions and NixOS versions.

Also, the home-manager tool does not explicitly support rollbacks at the moment so if your home directory gets messed up you'll have to fix it yourself. See the rollbacks section for instructions on how to manually perform a rollback.

Now when your expectations have been built up and you are eager to try all this out you can go ahead and read the rest of this text.


You can chat with us on IRC in the channel #home-manager on OFTC. There is also a Matrix room, which is bridged to the IRC channel.


Home Manager can be used in three primary ways:

  1. Using the standalone home-manager tool. For platforms other than NixOS and Darwin, this is the only available choice. It is also recommended for people on NixOS or Darwin that want to manage their home directory independently of the system as a whole. See Standalone installation in the manual for instructions on how to perform this installation.

  2. As a module within a NixOS system configuration. This allows the user profiles to be built together with the system when running nixos-rebuild. See [NixOS module installation]manual nixos install in the manual for a description of this setup.

  3. As a module within a nix-darwin system configuration. This allows the user profiles to be built together with the system when running darwin-rebuild. See nix-darwin module installation in the manual for a description of this setup.


Home Manager has basic support for internationalization through gettext. The translations are hosted by Weblate. If you would like to contribute to the translation effort then start by going to the Home Manager Weblate project.

Translation status

Nix Flakes

Home Manager includes a flake.nix file for compatibility with Nix Flakes for those that wish to use it as a module. A bare-minimum flake.nix would be as follows:

  description = "NixOS configuration";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    home-manager.url = "github:nix-community/home-manager";

  outputs = { home-manager, nixpkgs, ... }: {
    nixosConfigurations = {
      hostname = nixpkgs.lib.nixosSystem {
        system = "x86_64-linux";
        modules = [
            home-manager.useGlobalPkgs = true;
            home-manager.useUserPackages = true;
            home-manager.users.jdoe = import ./home.nix;

            # Optionally, use home-manager.extraSpecialArgs to pass
            # arguments to home.nix

If you are not using NixOS you can place the following flake in ~/.config/nixpkgs/flake.nix to load your standard Home Manager configuration:

  description = "A Home Manager flake";

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

  outputs = inputs: {
    homeConfigurations = {
      jdoe = inputs.home-manager.lib.homeManagerConfiguration {
        system = "x86_64-linux";
        homeDirectory = "/home/jdoe";
        username = "jdoe";
        configuration.imports = [ ./home.nix ];

Note, the Home Manager library is exported by the flake under lib.hm.

When using flakes, switch to new configurations as you do for the whole system (e. g. nixos-rebuild switch --flake <path>) instead of using the home-manager command line tool.


Home Manager is developed against nixpkgs-unstable branch, which often causes it to contain tweaks for changes/packages not yet released in stable NixOS. To avoid breaking users' configurations, Home Manager is released in branches corresponding to NixOS releases (e.g. release-21.11). These branches get fixes, but usually not new modules. If you need a module to be backported, then feel free to open an issue.


This project is licensed under the terms of the MIT license.