Direnv - Revision history

Pigs: move nixos content under nixos section

2025-05-30T02:02:57Z

move nixos content under nixos section

← Older revision		Revision as of 02:02, 30 May 2025
Line 28:		Line 28:

	While Direnv has [https://github.com/direnv/direnv/wiki/Nix full support for Nix] development environments, third-party developers have improved upon Direnv's default implementation of the special <code>use_nix</code> keyword, resulting in the development of [https://github.com/nix-community/nix-direnv <code>nix-direnv</code>] and [https://github.com/nix-community/lorri <code>lorri</code>].		While Direnv has [https://github.com/direnv/direnv/wiki/Nix full support for Nix] development environments, third-party developers have improved upon Direnv's default implementation of the special <code>use_nix</code> keyword, resulting in the development of [https://github.com/nix-community/nix-direnv <code>nix-direnv</code>] and [https://github.com/nix-community/lorri <code>lorri</code>].

	~~The NixOS module uses <code>nix-direnv</code> by default when Direnv is enabled, but this can be overriden with the {{nixos:option\|programs.direnv.nix-direnv.package}} option.~~

	== Configuring on NixOS ==		== Configuring on NixOS ==

	There is a [[Overview_of_the_NixOS_Linux_distribution\|NixOS]] Module for Direnv (and <code>nix-direnv</code>) which automatically sets everything up in a given NixOS machine. The following line of code is everything that's necessary for NixOS to automatically install and hook Direnv to the available shells in the system:		There is a [[Overview_of_the_NixOS_Linux_distribution\|NixOS]] Module for Direnv (and <code>nix-direnv</code>) which automatically sets everything up in a given NixOS machine. The following line of code is everything that's necessary for NixOS to automatically install and hook Direnv to the available [[Command Shell\|shells]] in the system:

	{{file\|configuration.nix\|nix\|<nowiki>		{{file\|configuration.nix\|nix\|<nowiki>
Line 40:		Line 38:
	}		}
	</nowiki>}}		</nowiki>}}

	{{Evaluate}}		{{Evaluate}}

			For a full list of Direnv module options, see {{nixos:option\|programs.direnv}}.

			The NixOS module uses <code>nix-direnv</code> by default when Direnv is enabled. This behavior can be overridden by setting the {{nixos:option\|programs.direnv.nix-direnv.enable}} option.

	== Troubleshooting ==		== Troubleshooting ==

SigmaSquadron: Categories

2025-05-17T15:56:38Z

SigmaSquadron: Nix support stuff

2025-05-17T15:46:17Z

Nix support stuff

← Older revision		Revision as of 15:46, 17 May 2025
Line 1:		Line 1:
	'''[https://direnv.net Direnv]''' is an automatic environment setup utility, loading the specified project environment automatically when you enter your project directory, and reporting the loaded variables to you.		'''[https://direnv.net Direnv]''' is an automatic environment setup utility, loading the specified project environment automatically when you enter your project directory, and reporting the loaded variables to you.

	After installing {{nixos:package\|direnv}} from Nixpkgs using your preferred method of installation, you can set up the <code>.envrc</code> file at the root of your directory. Refer to the [https://github.com/direnv/direnv/wiki Direnv Wiki] for some examples.		After installing {{nixos:package\|direnv}} from Nixpkgs using your preferred method of installation, you can set up the <code>.envrc</code> file at the root of your directory. Refer to the [https://github.com/direnv/direnv/wiki Direnv Wiki] for some examples. For Nix projects, you will probably want to use the special <code>use_nix</code> keyword, that automatically loads the <code>shell.nix</code> file for your repository.

	At the root of your repository, Direnv can start by allowing the recently-created <code>.envrc</code> file to execute:		At the root of your repository, Direnv can start by allowing the recently-created <code>.envrc</code> file to execute:
Line 24:		Line 24:

	Keeping that directory means that an <code>.envrc</code> file only needs to be allowed once in order to run automatically.		Keeping that directory means that an <code>.envrc</code> file only needs to be allowed once in order to run automatically.

			== <code>nix-direnv</code> & <code>lorri</code> ==

			While Direnv has [https://github.com/direnv/direnv/wiki/Nix full support for Nix] development environments, third-party developers have improved upon Direnv's default implementation of the special <code>use_nix</code> keyword, resulting in the development of [https://github.com/nix-community/nix-direnv <code>nix-direnv</code>] and [https://github.com/nix-community/lorri <code>lorri</code>].

			The NixOS module uses <code>nix-direnv</code> by default when Direnv is enabled, but this can be overriden with the {{nixos:option\|programs.direnv.nix-direnv.package}} option.

	== Configuring on NixOS ==		== Configuring on NixOS ==

SigmaSquadron: Moved from the nix-shell article. (with significant improvements)

2025-05-17T15:40:08Z

Moved from the nix-shell article. (with significant improvements)

New page

'''[https://direnv.net Direnv]''' is an automatic environment setup utility, loading the specified project environment automatically when you enter your project directory, and reporting the loaded variables to you.

After installing {{nixos:package|direnv}} from Nixpkgs using your preferred method of installation, you can set up the <code>.envrc</code> file at the root of your directory. Refer to the [https://github.com/direnv/direnv/wiki Direnv Wiki] for some examples.

At the root of your repository, Direnv can start by allowing the recently-created <code>.envrc</code> file to execute:
<syntaxHighlight lang=console>
$ direnv allow .
direnv: loading .envrc
direnv: using nix
[...]
+SIZE +SOURCE_DATE_EPOCH +STRINGS +STRIP +TEMP +TEMPDIR +TMP +TMPDIR +_PATH +buildInputs +builder +checkPhase +cmakeFlags +configureFlags +doCheck +enableParallelBuilding +name +nativeBuildInputs +out +postCheck +preCheck +preConfigure +propagatedBuildInputs +propagatedNativeBuildInputs +shell +src +stdenv +system +testInputs +version ~PATH
</syntaxHighlight>
{{Security Warning|Direnv will never run an unknown <code>.envrc</code> file unless explicitly authorised. As these files run arbitrary code in your computer, it is a good idea to review the <code>.envrc</code> files from remote repositories before running <code>direnv allow</code>.|type=secure}}

Once Direnv detects that the current working directory is no longer inside the repository with a <code>.envrc</code> file, it will automatically unload the environment:
<syntaxHighlight lang=console>
$ cd ..
direnv: unloading
</syntaxHighlight>

== State ==

Direnv stores files in <code>$XDG_DATA_HOME/direnv</code>. It contains the information required to persist all allowed and denied <code>.envrc</code> files across the filesystem.

Keeping that directory means that an <code>.envrc</code> file only needs to be allowed once in order to run automatically.

== Configuring on NixOS ==

There is a [[Overview_of_the_NixOS_Linux_distribution|NixOS]] Module for Direnv (and <code>nix-direnv</code>) which automatically sets everything up in a given NixOS machine. The following line of code is everything that's necessary for NixOS to automatically install and hook Direnv to the available shells in the system:

{{file|configuration.nix|nix|<nowiki>
{
programs.direnv.enable = true;
}
</nowiki>}}
{{Evaluate}}

== Troubleshooting ==

=== Hooking Shells ===

Depending on the shell you are using, you need to add a line in your shell configuration file. See the [https://direnv.net/docs/hook.html ''Hook'' section of the Direnv Documentation] for more information.

Setting Direnv up using the NixOS module should do this by default.

== See Also ==

* [https://direnv.net/ direnv.net].
* The [https://github.com/direnv/direnv/wiki/Nix Direnv Wiki].

← Older revision		Revision as of 15:56, 17 May 2025
Line 54:		Line 54:
	* [https://direnv.net/ direnv.net].		* [https://direnv.net/ direnv.net].
	* The [https://github.com/direnv/direnv/wiki/Nix Direnv Wiki].		* The [https://github.com/direnv/direnv/wiki/Nix Direnv Wiki].

			[[Category:Development]]
			[[Category:Applications]]