/nix-dev-home

A `home-manager` template providing useful tools & settings for Nix-based development (macOS & Linux supported)

Primary LanguageNixGNU Affero General Public License v3.0AGPL-3.0

project chat

nix-dev-home

A home-manager template providing useful tools & settings for Nix-based development. See home/default.nix to see what's available.

Getting Started

NOTE: These instructions do not apply if you use NixOS.1

  1. Install Nix.

  2. Initialize2 your home-manager config using this repo as template:

    mkdir ~/nixconfig && cd ~/nixconfig
nix --accept-flake-config run github:juspay/omnix -- init github:juspay/nix-dev-home -o .
    image
    • Optionally, you may edit ./nix/modules/home/*.nix to your liking.

  3. Run nix run3 to activate your configuration.

  4. Restart your terminal.

After steps 1-4, you should expect to see the starship prompt:

image

Anytime you modify your home configuration in ./nix/modules/home/*.nix, re-run nix run to activate the new configuration.

Details

The configuration repo has flake.nix file in the current directory and some ./nix/modules/home/*.nix files containing the home-manager configuration that you can review. It also has a justfile, which provides a set of recipes analogous to Make targets to interact with the nix flake.

You can then execute nix develop, to ensure you are in the development shell with just installed, followed by just run to activate this configuration in your $HOME. On most systems you are likely to experience at least one of the issues mentioned below in Troubleshooting. A more complete sequence might be

nix-dev-env setup 
> nix develop
(nix:nix-dev-home-env) > rm ~/.bashrc ~/.profile && just run && direnv allow
(nix:nix-dev-home-env) > exit
> bash
runner on 12ca6a64c923 work on  feature/branch via ❄️  impure (nix-dev-home-env)
⬢ [Docker] ❯

If you prefer, you can simply execute nix run, but using just will perform some additional validation and ensure you are able to use the other commands in the justfile.

To browse the capabilities of home-manager (and to see what else can go in your ./home/default.nix -- such as shell aliases), consult home-manager options reference. You can also run man home-configuration.nix in the terminal.

Troubleshooting

error: opening lock file ...

Problem: nix run shows an error like: error: opening lock file '/nix/var/nix/profiles/per-user/utkarsh.pandey1/profile.lock': No such file or directory

Solution: This is an instance of nix-community/home-manager#4611. Run sudo mkdir /nix/var/nix/profiles/per-user/$(whoami)/ && sudo chown $(whoami) /nix/var/nix/profiles/per-user/$(whoami) and try again.

Existing file ... is in the way of ...

Problem: Running nix run (home-manager) complains "Existing file ... is in the way of ..."

Solution: Delete those existing dotfiles (take a backup first), and try again. In home-manager, you can configure your shell directly in Nix (for macOS zsh, this is programs.zsh.envExtra) and may also include your existing dotfile verbatim.

Cannot use cache / cachix

Problem: Cannot use cachix: Running nix run nixpkgs#cachix use nammayatri (for example) does not succeed.

Solution: Add yourself to the trusted-users nix config and restart the nix daemon.

mkdir -p ~/.config/nix
echo "trusted-users = root $(whoami)" >> $HOME/.config/nix/nix.conf
sudo pkill nix-daemon

FAQ

But I use NixOS

You can embed this configuration inside your NixOS configuration, and thus share it with non-NixOS systems (like macOS and Ubuntu). See the "both" template of https://github.com/srid/nixos-flake for an example. If you don't want to share the configuration with macOS (ie., you use only Linux for development), see the "linux" template instead.

/nix/store garbage collection

By default garbage collection is run automatically every week. If your projects use nix-direnv, you don't have to worry about having to download the dependencies again while in a remote area with limited internet access (see prominent features of nix-direnv).

Footnotes

  1. If you use NixOS, you can adapt the NixOS template of nixos-flake by using configuration from this repo. ↩

  2. We use omnix. Alternatively, you may wish to initialize manually as follows. But you must set your name and email in git.nix for Git to be able to commit.

    nix flake init -t github:juspay/nix-dev-home
nix run .#sd "runner" "$(whoami)" flake.nix
    ↩

  3. Executing this step will modify the contents of your $HOME directory. You will be warned before overwriting, but not before creating links to newly created configuration files in the nix store. Since home-manager does not currently provide an integrated and automated feature to eliminate the links it creates, be aware that if you would like to reverse this operation, you will need to curate your home directory manually. ↩