Co-authored-by: Pedro de Mattia <pedromattia@gmail.com> Co-authored-by: Alex Miranda <alexmirandamoraes@gmail.com> Co-authored-by: Felipe Silva <git@felipeqq2.rocks> Co-authored-by: guto <joaoaugustolanjoni@gmail.com> Co-authored-by: Gabriel Grysuk <gabrielgrysuk@gmail.com> Co-authored-by: Oğuz Ersen <oguz@ersen.moe> Co-authored-by: Emre Çebi <emrecebi03@gmail.com> Co-authored-by: Silk <omerntuzun@gmail.com> Co-authored-by: Doğu Us <usdogu@gmail.com> Co-authored-by: Anonymous <noreply@weblate.org> Co-authored-by: Josef Dalibor <josefkruse@googlemail.com> Co-authored-by: programmerlexi <lexi@reyer.name> Co-authored-by: Frederik Engels <frederik.engels92@gmail.com> Co-authored-by: Manu [tennox] <tennox@posteo.de> Co-authored-by: mainrs <github619064@zerotask.net> Co-authored-by: Reiner Gerecke <me@reinergerecke.de> Co-authored-by: halbGefressen <chzi@pm.me> Co-authored-by: JonathanB <ewu.uwent@gmail.com> Co-authored-by: Urocissa Caerulea.Tw <urocissa.tw@proton.me> Co-authored-by: WhiredPlanck <whiredplanck@outlook.com> Co-authored-by: 807 <s10855168@gmail.com> Co-authored-by: Ferenci Ákos <synthetace@gmail.com> Co-authored-by: Balint Barna Kovari <balint@kovari.cc> Co-authored-by: Dan <jonweblin2205@protonmail.com> Co-authored-by: Сергій <sergiy.goncharuk.1@gmail.com> Co-authored-by: Максим Горпиніч <gorpinicmaksim2005ukr@protonmail.com> Co-authored-by: wadsaek <wadsaek@gmail.com> Co-authored-by: Lucas Eduardo <lucas59356@gmail.com> Co-authored-by: ssantos <ssantos@web.de> Co-authored-by: SrGesus <gabriel.fcf04@gmail.com> Co-authored-by: Julius Marozas <marozas.julius@gmail.com> Co-authored-by: Kornelijus Tvarijanavičius <kornelijus@tvaria.com> Co-authored-by: Yogurt <donatas.karta@gmail.com> Co-authored-by: Deleted User <noreply+48943@weblate.org> Co-authored-by: Mario Rodas <rodasmario2@gmail.com> Co-authored-by: Mauricio Scheffer <mauricioscheffer@gmail.com> Co-authored-by: Harrizon Soler <harryalex0281@hotmail.com> Co-authored-by: Brian E <brianellingsgaard9@gmail.com> Co-authored-by: Keivan <keyvan0082@gmail.com> Co-authored-by: Parsa Nobahari <89968726+ParsaNobahari@users.noreply.github.com> Co-authored-by: Marko Milovanov <markomilovanov03@gmail.com> Co-authored-by: Leix b <abone9999@gmail.com> Co-authored-by: Alejandro Masó Bonilla <alejandrobonilla2001@gmail.com> Co-authored-by: Peter Pfeufer <info@ppfeufer.de> Co-authored-by: Viktor Illmer <accounts@viktor.im> Co-authored-by: Sven Keidel <svenkeidel@pm.me> Co-authored-by: Vollow <muffinslog@proton.me> Co-authored-by: Hongtyu Bhe <mfthits@gmail.com> Co-authored-by: Sam Chu <samchu-primary@outlook.com> Co-authored-by: immwind <i@immwind.com> Co-authored-by: nanliu <nan.liu@gmail.com> Co-authored-by: Zexin Yuan <yuan.zx@outlook.com> Co-authored-by: Frankie McEyes <mceyes@protonmail.com> Co-authored-by: Leonardo Randacio <leonardorandacio@gmail.com> Co-authored-by: Fareesh Vijayarangam <fareesh@gmail.com> Co-authored-by: Utkarsh Sharma <utkasharma19@gmail.com> Co-authored-by: Muxutruk <benat.eigurenzu@elorrieta-errekamari.com> Co-authored-by: ShadowTiger Raptor <sh4dowtig3r@gmail.com> Co-authored-by: Peng Guanwen <pg999w@outlook.com> Co-authored-by: Yubo-Cao <Cao2006721@gmail.com> Co-authored-by: ethinx <eth2net@gmail.com> Co-authored-by: Daniel Jacob Butcher <corpo@quokka.wiki> Co-authored-by: Pablo Bollansee <pablo.bollansee@gmail.com> Co-authored-by: Zurga <jim.lemmers@gmail.com> Co-authored-by: Hylke de Vries <hylke94+weblate@gmail.com> Co-authored-by: Erwin Mintiens <erwin.mintiens@protonmail.com> Co-authored-by: Eric Ho <eric913@gmail.com> Co-authored-by: Nara Díaz Viñolas <rdvdev2@gmail.com> Co-authored-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com> Co-authored-by: Tomi Ockier <ockier1@gmail.com> Co-authored-by: Bruno Fragoso <darth_signa@hotmail.com> Co-authored-by: Omar Mohamed <mohamed.omar67492@gmail.com> Co-authored-by: Borislav Rangelov <borislav.y.rangelov@gmail.com> Co-authored-by: Kiril Panayotov <eccyboo@protonmail.com> Co-authored-by: Kiril Mihaylov <kiril195@hotmail.com> Co-authored-by: 박수원 <bboxone@gmail.com> Co-authored-by: Suwon Park <sepiabrown@naver.com> Co-authored-by: honnip <me@honnip.page> Co-authored-by: lentil32 <lentil32@icloud.com> Co-authored-by: Mohammad Abdolirad <m.abdolirad@gmail.com> Co-authored-by: Artin Mobasher <mobasherartin.icm@gmail.com> Co-authored-by: Bjarki Gunnarsson <bjarkihg@gmail.com> Co-authored-by: Anon Ymous <mivon27841@shackvine.com> Co-authored-by: Jakub Janczak <kubek2k@gmail.com> Co-authored-by: Eryk Michalak <gnu.ewm@protonmail.com> Co-authored-by: Mateusz Kubica <mw.kubica@gmail.com> Co-authored-by: Tomasz Czyż <tomasz.czyz@eskapizm.pl> Co-authored-by: Tymoteusz Dolega <tymoteuszdolega@gmail.com> Co-authored-by: TANIGUCHI Kohei <a.d.xvii.kal.mai@gmail.com> Co-authored-by: Takeru Mikenu <mikenu-jp@users.noreply.hosted.weblate.org> Co-authored-by: Heman Gandhi <hemangandhi@gmail.com> Co-authored-by: Turmoil Nailsis <indianrunner@duck.com> Co-authored-by: Narazaki Shuji <shujinarazaki@protonmail.com> Co-authored-by: Markus Amano <markus.a.amano@gmail.com> Co-authored-by: Kento Okamoto <kentokamoto@protonmail.com> Co-authored-by: HeartBlin913861820c094e37 <heartblin@proton.me> Co-authored-by: SMFloris <floris.sm@gmail.com> Co-authored-by: Felix Puscasu <puscasu.felix1@gmail.com> Co-authored-by: David Houdek <sarejnovec@gmail.com> Co-authored-by: max <weblate@p2502.net> Co-authored-by: Dark Templar <dark.templar0007@gmail.com> Co-authored-by: AtomicDude <vasilescutoma4@gmail.com> Co-authored-by: Reza Almanda <rezaalmanda27@gmail.com> Co-authored-by: Wildan Nursyamsi <muhamad11wildan4n@gmail.com> Co-authored-by: Abdul V Vahry <cyberaioff@gmail.com> Co-authored-by: Kamontat Chantrachirathumrong <uein2@users.noreply.hosted.weblate.org> Co-authored-by: Eise Zimmerman <eiscomania@gmail.com> Co-authored-by: Allan Nordhøy <epost@anotheragency.no> Co-authored-by: LilleAila <olai.solsvik@gmail.com> Co-authored-by: Kim A. Ødegaard <kim@dyktig.no> Co-authored-by: Robert Helgesson <robert@rycee.net> Co-authored-by: jarre johansson <jarre@johansson.today> Co-authored-by: Ricky Tigg <ricky.tigg@gmail.com> Co-authored-by: Marcin Kaczorek <hostedweblateorgmk@karek.pl> Co-authored-by: Mateusz P <medan1993@gmail.com> Co-authored-by: Gabriel Fontes <hi@m7.rs> Co-authored-by: bittin1ddc447d824349b2 <bittin@reimu.nl> Co-authored-by: Naïm Camille Favier <n@monade.li> Co-authored-by: Pink Pony <dreammc@protonmail.com> Co-authored-by: Dorian Burgun <docdoomduck@protonmail.com> Co-authored-by: J. Lavoie <j.lavoie@net-c.ca> Co-authored-by: 6KHCPCPO <lxh43qf2b@relay.firefox.com> Co-authored-by: swaps <swapgs@users.noreply.hosted.weblate.org> Co-authored-by: Szabin Hamrik <h.szabin@gmail.com> Co-authored-by: Jay Thomas <jay@gfax.ch> Co-authored-by: adityalal01 <erc202009@gmail.com> Co-authored-by: Karel Kremel <charles@alembiq.net> Co-authored-by: David Chocholatý <chocholaty.david0@gmail.com> Co-authored-by: FireFragment <snaselik.m@gmail.com> Co-authored-by: தமிழ்நேரம் <tamilneram247@gmail.com> Co-authored-by: DeeKahy <Lennart.Diego.Kahn@gmail.com> Co-authored-by: cafkafk <christina@cafkafk.com> Co-authored-by: Matilde <matilde.alb@proton.me> Co-authored-by: Julien H. Gibson <julienhgibson@protonmail.com> Co-authored-by: Guilloux Nicolas <novares.x@gmail.com> Co-authored-by: Alexis Rossfelder <rossfelderalexis@gmail.com> Co-authored-by: Yk Cheese <yakforcom@gmail.com> Co-authored-by: Louis Thevenet <louis.thevenet@proton.me> Co-authored-by: TheBlackBeans <adrien.mathieu.net@gmail.com> Co-authored-by: Luna Jernberg <droidbittin@gmail.com> Co-authored-by: Blezz Rot <markus.jenya04@yandex.ru> Co-authored-by: Mikhail Chekan <chekoopa@mail.ru> Co-authored-by: Nikolay Mokrinsky <me@mokrinsky.ru> Co-authored-by: Petr Portnov | PROgrm_JARvis <mrJARVIScraft@gmail.com> Co-authored-by: Er1ckR1ck0 <eryckov37@gmail.com> Co-authored-by: NikSne <commits@niksne.ru> Co-authored-by: Lorenzo Brzek <lorenzo@brzek.it> Co-authored-by: FedFer98123 <fede.ferrari123@gmail.com> Co-authored-by: Lorenzo Bevilacqua <lorenzobevilacqua02@gmail.com> Co-authored-by: Mustafa Çalışkan <muscaln@protonmail.com> Co-authored-by: goatastronaut0212 <goatastronaut0212@proton.me> Co-authored-by: Nguyen Khanh <nguynkhan479@gmail.com> Co-authored-by: RepentantKnight121 <repentantknight121@outlook.com> Co-authored-by: Deleted User <noreply+69728@weblate.org> Co-authored-by: Rasmus Enevoldsen <rasmus@enev.dk> Co-authored-by: bgo-eiu <huyaqoob+toolforge@gmail.com> Co-authored-by: Petter K <petterkarlsrud@me.com> Co-authored-by: Gavagai53 <masella_portlock@aleeas.com> Co-authored-by: Vladimir <kirillov.vladimir@gmail.com> Co-authored-by: teu5us <paulkreuzmann@gmail.com> |
||
|---|---|---|
| .builds | ||
| .github | ||
| docs | ||
| home-manager | ||
| lib | ||
| modules | ||
| nix-darwin | ||
| nixos | ||
| templates | ||
| tests | ||
| .editorconfig | ||
| .git-blame-ignore-revs | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| all-maintainers.nix | ||
| buildbot-nix.toml | ||
| default.nix | ||
| flake-module.nix | ||
| flake.lock | ||
| flake.nix | ||
| Justfile | ||
| LICENSE | ||
| MAINTAINING.md | ||
| Makefile | ||
| overlay.nix | ||
| README.md | ||
| release.json | ||
| treefmt.toml | ||
| xgettext | ||
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.
Usage
Before attempting to use Home Manager please read the warning below.
For a systematic overview of Home Manager and its available options, please see:
If you would like to contribute to Home Manager, then please have a look at "Contributing" in the manual.
Releases
Home Manager is developed against nixos-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-25.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.
Words of warning
Unfortunately, it is quite possible to get difficult to understand errors when working with Home Manager. You should therefore be comfortable using the Nix language and the various tools in the Nix ecosystem.
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 is about to be overwritten was from a previous Home Manager generation or from manual configuration.
Home Manager targets NixOS unstable and NixOS version 25.11 (the current stable version), it may or may not work on other Linux distributions and NixOS versions.
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.
Contact
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.
Installation
Home Manager can be used in three primary ways:
-
Using the standalone
home-managertool. 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. -
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" in the manual for a description of this setup. -
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" in the manual for a description of this setup.
Home Manager provides both the channel-based setup and the flake-based one. See Nix Flakes for a description of the flake-based setup.
Translations
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.
License
This project is licensed under the terms of the MIT license.