Development environment with nix-shell - Revision history

Mightyiam: Link to relevant Nixcademy article

2025-11-30T09:56:33Z

Link to relevant Nixcademy article

← Older revision		Revision as of 09:56, 30 November 2025
Line 213:		Line 213:
	* [[Direnv]]		* [[Direnv]]
	* [[Command Shell#Using a different shell in nix-shell and nix develop]]		* [[Command Shell#Using a different shell in nix-shell and nix develop]]
			* [https://nixcademy.com/posts/cpp-with-nix-in-2023-part-1-shell/ C++ with Nix in 2023, Part 1: Developer Shells, Nixcademy]

	[[Category:Development]]		[[Category:Development]]
	[[Category:nix]]		[[Category:nix]]

Cdro: Correct a typo

2025-08-13T06:27:10Z

Correct a typo

← Older revision		Revision as of 06:27, 13 August 2025
Line 22:		Line 22:
	hello		hello
	];		];
	# compilers & linkers & ~~dependecy~~ finding programs		# compilers & linkers & dependency finding programs
	nativeBuildInputs = [		nativeBuildInputs = [
	rustc		rustc

Pigs: /* nix develop */ mention its because it is cached

2025-05-31T18:08:28Z

nix develop: mention its because it is cached

← Older revision		Revision as of 18:08, 31 May 2025
Line 82:		Line 82:
	we replace <code>nix-shell</code> with <code>nix develop</code>		we replace <code>nix-shell</code> with <code>nix develop</code>

	Example: Building Nix in a development shell, to get [[Incremental builds]] = faster recompiles		Example: Building Nix in a development shell, to get [[Incremental builds]] = faster recompiles. This is because Nix evaluations are cached.

	<pre>		<pre>

Pigs: /* See Also */ Add link to changing shell in nix-shell

2025-05-17T16:21:52Z

See Also: Add link to changing shell in nix-shell

← Older revision		Revision as of 16:21, 17 May 2025
Line 212:		Line 212:
	== See Also ==		== See Also ==
	* [[Direnv]]		* [[Direnv]]
			* [[Command Shell#Using a different shell in nix-shell and nix develop]]

	[[Category:Development]]		[[Category:Development]]
	[[Category:nix]]		[[Category:nix]]

SigmaSquadron: Direnv forwardlink

2025-05-17T15:22:47Z

Direnv forwardlink

← Older revision		Revision as of 15:22, 17 May 2025
Line 209:		Line 209:
	Similar to the Gsettings issue, icons can be added with XDG_DATA_DIRS:		Similar to the Gsettings issue, icons can be added with XDG_DATA_DIRS:
	<pre> XDG_DATA_DIRS=...:${hicolor-icon-theme}/share:${gnome3.adwaita-icon-theme}/share</pre>		<pre> XDG_DATA_DIRS=...:${hicolor-icon-theme}/share:${gnome3.adwaita-icon-theme}/share</pre>

			== See Also ==
			* [[Direnv]]

	[[Category:Development]]		[[Category:Development]]
	[[Category:nix]]		[[Category:nix]]

SigmaSquadron: /* direnv */ Move elsewhere.

2025-05-17T15:21:09Z

direnv: Move elsewhere.

@@ Line 175: / Line 175: @@
 </syntaxHighlight>
 and <code>nativeBuildInputs</code> would be for the native platform, while <code>buildInputs</code> would be for the foreign platform. That's a much more practical distinction: any tool that's miscategorized one won't be able to run, and any library that's miscategorized one won't be able to link!
 == Troubleshooting ==

Barsikus007: ruby typo fix

2025-04-15T14:25:55Z

ruby typo fix

← Older revision		Revision as of 14:25, 15 April 2025
Line 42:		Line 42:
	{{Commands\|$ nix-shell shell.nix}}		{{Commands\|$ nix-shell shell.nix}}

	Now you have ~~ruby 3.2~~ available in your shell:		Now you have rustc available in your shell:
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	$ rustc --version		$ rustc --version

Artturin: Typo

2024-10-29T18:54:08Z

Typo

← Older revision		Revision as of 18:54, 29 October 2024
Line 56:		Line 56:
	overlays = [		overlays = [
	(final: prev: {		(final: prev: {
	my-~~packages~~ = prev.callPackage ./my-package.nix { };		my-package = prev.callPackage ./my-package.nix { };
	})		})
	];		];

Artturin at 18:52, 29 October 2024

2024-10-29T18:52:13Z

← Older revision		Revision as of 18:52, 29 October 2024
Line 3:		Line 3:
	If you already have a nix package definition of your project it's easy: Just use <code>nix-shell</code> instead of <code>nix-build</code> and you will end up in a bash shell that reproduce the build-environment of your package. You can also override[https://nixos.org/nixpkgs/manual/#sec-pkg-override] your package in a <code>shell.nix</code> file to add test and coverage dependencies, that are not necessary for the actual build of the package, but that you want for your development environment.		If you already have a nix package definition of your project it's easy: Just use <code>nix-shell</code> instead of <code>nix-build</code> and you will end up in a bash shell that reproduce the build-environment of your package. You can also override[https://nixos.org/nixpkgs/manual/#sec-pkg-override] your package in a <code>shell.nix</code> file to add test and coverage dependencies, that are not necessary for the actual build of the package, but that you want for your development environment.

	But, if you don't (or you don't want to) have a package definition you can still use a nix-shell to provide a reproducible development environment. To do so, you have to create a <code>shell.nix</code> file at the root of your repository. For example, if you want to have ~~Ruby 3.2~~ and ~~not one provided by your system~~ you can write:		But, if you don't (or you don't want to) have a package definition you can still use a nix-shell to provide a reproducible development environment. To do so, you have to create a <code>shell.nix</code> file at the root of your repository. For example, if you want to have rustc with libraries and hello you can write:
	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	{ pkgs ? import <nixpkgs> {} }:		{
	pkgs.mkShell {		pkgs ? import <nixpkgs> { },
	# nativeBuildInputs ~~is usually what you want~~ -~~- tools you need to run~~		}:
	~~nativeBuildInputs~~ = ~~with pkgs.buildPackages;~~ [ ~~ruby_3_2~~ ];		pkgs.callPackage (
	}		{
			mkShell,
			hello,
			rustc,
			pkg-config,
			openssl,
			}:
			mkShell {
			strictDeps = true;
			# host/target agnostic programs
			depsBuildBuild = [
			hello
			];
			# compilers & linkers & dependecy finding programs
			nativeBuildInputs = [
			rustc
			pkg-config
			];
			# libraries
			buildInputs = [
			openssl
			];
			}
			) { }

	</syntaxhighlight>		</syntaxhighlight>

Line 19:		Line 43:

	Now you have ruby 3.2 available in your shell:		Now you have ruby 3.2 available in your shell:
	<~~syntaxHighlight~~ lang=bash>		<syntaxhighlight lang="bash">
	$ ~~ruby~~ --version		$ rustc --version
	~~ruby 3~~.2.2 (~~2023~~-03-~~30 revision e51014f9c0~~) ~~[x86_64-linux]~~		rustc 1.80.1 (3f5fd8dd4 2024-08-06) (built from a source tarball)
	</~~syntaxHighlight~~>		</syntaxhighlight>

	To be sure that the tools installed on your system will not interfere with the dependencies that you've defined in the shell you can use the <code>--pure</code> option.		To be sure that the tools installed on your system will not interfere with the dependencies that you've defined in the shell you can use the <code>--pure</code> option.

	If you'd like to load a local nix expression into a shell you can do it by modifying the earlier example a little bit:		If you'd like to load a local nix expression into a shell you can do it by modifying the earlier example a little bit, see comments in the earlier example for where to put your package:
	<~~syntaxHighlight~~ lang=nix>		<syntaxhighlight lang="nix">
	{ pkgs ? import <nixpkgs> {} }:		{
	pkgs.~~mkShell~~ {		pkgs ? import <nixpkgs> {
	~~# buildInputs is for dependencies you'd need "at run time"~~,		overlays = [
	~~# were you to to use nix-build not nix-shell and build whatever you were working on~~		(final: prev: {
	buildInputs = [		my-packages = prev.callPackage ./my-package.nix { };
	~~(import ./~~my-~~expression.nix { inherit pkgs~~; })		})
	];		];
	}		},
	</~~syntaxHighlight~~>		}:
			pkgs.callPackage (
			{
			mkShell,
			my-package
			}:
			mkShell {
			strictDeps = true;
			buildInputs = [
			my-package
			];
			}
			) { }
			</syntaxhighlight>

	If you want to see how to manually run the various phases of a given derivation from a nix-shell (useful to debug), see [[Nixpkgs/Create_and_debug_packages#Using_nix-shell_for_package_development]].		If you want to see how to manually run the various phases of a given derivation from a nix-shell (useful to debug), see [[Nixpkgs/Create_and_debug_packages#Using_nix-shell_for_package_development]].
Line 96:		Line 133:
	Let's assume you have a <code>default.nix</code> file		Let's assume you have a <code>default.nix</code> file

	<~~syntaxHighlight~~ lang=nix>		<syntaxhighlight lang="nix">
	{ stdenv, python }:		{ stdenv, python }:
	stdenv.mkDerivation {		stdenv.mkDerivation {
	~~buildInputs = [ python ];~~		pname = "some-package";
	~~name~~ = "some-package";		strictDeps = true;
			nativeBuildInputs = [ python ];
	version = "0.0.1";		version = "0.0.1";
	src = /home/yourname/path/to/project; # can be a local path, or fetchFromGitHub, fetchgit, ...		src = /home/yourname/path/to/project; # can be a local path, or fetchFromGitHub, fetchgit, ...
	}		}
	</~~syntaxHighlight~~>		</syntaxhighlight>

	Then you can start a development shell with		Then you can start a development shell with
Line 198:		Line 236:
	mkShell {		mkShell {
	...		...
			strictDeps = true;
	buildInputs = [ gtk3 ];		buildInputs = [ gtk3 ];
	shellHook = ''		shellHook = ''

Anna Aurora: Fixed indentation in code block.

2024-09-29T12:53:21Z

Fixed indentation in code block.

← Older revision		Revision as of 12:53, 29 September 2024
Line 4:		Line 4:

	But, if you don't (or you don't want to) have a package definition you can still use a nix-shell to provide a reproducible development environment. To do so, you have to create a <code>shell.nix</code> file at the root of your repository. For example, if you want to have Ruby 3.2 and not one provided by your system you can write:		But, if you don't (or you don't want to) have a package definition you can still use a nix-shell to provide a reproducible development environment. To do so, you have to create a <code>shell.nix</code> file at the root of your repository. For example, if you want to have Ruby 3.2 and not one provided by your system you can write:
	<~~syntaxHighlight~~ lang=nix>		<syntaxhighlight lang="nix">
	{ pkgs ? import <nixpkgs> {} }:		{ pkgs ? import <nixpkgs> {} }:
	pkgs.mkShell {		pkgs.mkShell {
	# nativeBuildInputs is usually what you want -- tools you need to run		# nativeBuildInputs is usually what you want -- tools you need to run
	nativeBuildInputs = with pkgs.buildPackages; [ ruby_3_2 ];		nativeBuildInputs = with pkgs.buildPackages; [ ruby_3_2 ];
	}		}
	</~~syntaxHighlight~~>		</syntaxhighlight>

	Then just run:		Then just run: