nix-community/nix-direnv
1
0
Fork 0
mirror of https://github.com/nix-community/nix-direnv.git synced 2025-11-08 19:46:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md for home-manager

Browse source 
The home-manager options have been changed (namely, nix-direnv is an option inside of programs.direnv). Also included the option for enabling Bash integration and left a note for how to enable integration for other shells through HM options... I also removed the section on keep-outputs and keep-derivations since, based on the Nix Manual, outputs/derivations that are registered as GC roots will be kept regardless of these settings (and as I understand it, nix-direnv does indeed register shells as GC roots). So telling users to enable these options would just keep behind extra garbage for them (in my opinion, one of the reasons to use nix-direnv is so that you DON'T have to enable these options and can keep garbage collecting everything else per usual.
This commit is contained in:
carschandler 2023-07-26 15:10:33 -05:00 • committed by GitHub
parent a7510c9073
commit 9a9c5c4e5b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -46,37 +46,20 @@ In `$HOME/.config/nixpkgs/home.nix` add
# ...other config, other config...
programs = {
direnv.enable = true;
direnv = {
enable = true;
enableBashIntegration = true; # see note on other shells below
nix-direnv.enable = true;
};
programs.bash.enable = true;
# OR
programs.zsh.enable = true;
# Or any other shell you're using.
}
```
**Optional**: To protect your nix-shell against garbage collection
you also need to add these options to your Nix configuration.
If you are on NixOS also add the following lines to your `/etc/nixos/configuration.nix`:
```Nix
{
nix.settings = {
keep-outputs = true;
keep-derivations = true;
bash.enable = true; # see note on other shells below
};
}
```
On other systems with Nix add the following configuration to your `/etc/nix/nix.conf`:
```Nix
keep-derivations = true
keep-outputs = true
```
Check the current [Home Manager Options](https://mipmip.github.io/home-manager-option-search/?query=direnv)
for integration with shells other than Bash. Be sure to also allow `home-manager` to
manage your shell with `programs.<your_shell>.enable = true`.
</details>
<details>