Shell scripts - Revision history

DHCP: capitalize sentences

2026-07-19T18:37:35Z

capitalize sentences

← Older revision		Revision as of 18:37, 19 July 2026
Line 1:		Line 1:
	~~the~~ package <code>writeShellScript</code> can be used to add shell scripts to nix expressions		The package <code>writeShellScript</code> can be used to add shell scripts to nix expressions

	<syntaxHighlight lang="nix">		<syntaxHighlight lang="nix">
Line 101:		Line 101:
	=== Command not found ===		=== Command not found ===

	~~for~~ example, the script throws the error <code>svn: command not found</code>, because the dependency <code>subversion</code> is missing.		For example, the script throws the error <code>svn: command not found</code>, because the dependency <code>subversion</code> is missing.

	~~when~~ a command is missing, you can use <code>nix-locate</code> to find the package name. for example, the <code>stat</code> command:		When a command is missing, you can use <code>nix-locate</code> to find the package name. for example, the <code>stat</code> command:

	<syntaxHighlight lang="console">		<syntaxHighlight lang="console">
Line 142:		Line 142:
	== Posix Shell ==		== Posix Shell ==

	~~some~~ environments (like OpenWRT, via <code>busybox</code>) offer only a "limited" shell (<code>sh</code> instead of <code>bash</code>).		Some environments (like OpenWRT, via <code>busybox</code>) offer only a "limited" shell (<code>sh</code> instead of <code>bash</code>).

	~~on nixos~~, posix shells are provided by the packages <code>dash</code> and <code>posh</code>		On NixOS, posix shells are provided by the packages <code>dash</code> and <code>posh</code>.

	== See also ==		== See also ==

DHCP: style fixes

2026-07-19T18:35:54Z

style fixes

← Older revision		Revision as of 18:35, 19 July 2026
Line 2:		Line 2:

	<syntaxHighlight lang="nix">		<syntaxHighlight lang="nix">
	someBuildHelper = { name, sha256 }:		someBuildHelper = { name, sha256 }:
	stdenv.mkDerivation {		stdenv.mkDerivation {
	inherit name;		inherit name;
	outputHashMode = "recursive";		outputHashMode = "recursive";
	outputHashAlgo = "sha256";		outputHashAlgo = "sha256";
	outputHash = sha256;		outputHash = sha256;
	builder = writeShellScript "builder.sh" ''		builder = writeShellScript "builder.sh" ''
	echo "hi, my name is ''${0}" # escape bash variable		echo "hi, my name is ''${0}" # escape bash variable
	echo "hi, my hash is ${sha256}" # use nix variable		echo "hi, my hash is ${sha256}" # use nix variable
	echo "hello world" >output.txt		echo "hello world" >output.txt
	'';		'';
	};		};
	</syntaxHighlight>		</syntaxHighlight>

Line 20:		Line 20:
	Longer bash scripts are usually stored as external script files, and called from Nix:		Longer bash scripts are usually stored as external script files, and called from Nix:

	~~<syntaxHighlight lang="nix">~~		{{file\|default.nix\|nix\|3=
	# default.nix
	{		{
	outputTxtDrv = stdenv.mkDerivation rec {		outputTxtDrv = stdenv.mkDerivation rec {
Line 36:		Line 35:
	};		};
	}		}
	~~</syntaxHighlight>~~		}}

	~~<syntaxHighlight lang="bash">~~		{{file\|builder.sh\|sh\|3=
	# builder.sh
	echo "$someString $(echo "$someJson" \| jq -r '.dst') $someNumber" >$out		echo "$someString $(echo "$someJson" \| jq -r '.dst') $someNumber" >$out
	~~</syntaxHighlight>~~		}}

	See also		See also
Line 52:		Line 50:
	Instead of <code>stdenv.mkDerivation</code>, we can also use <code>runCommand</code> to call an external bash script:		Instead of <code>stdenv.mkDerivation</code>, we can also use <code>runCommand</code> to call an external bash script:

	~~<syntaxHighlight lang="nix">~~		{{file\|default.nix\|nix\|3=
	# default.nix
	{		{
	outputTxtDrv = runCommand "output.txt" {		outputTxtDrv = runCommand "output.txt" {
Line 63:		Line 60:
	} (builtins.readFile ./builder.sh);		} (builtins.readFile ./builder.sh);
	}		}
	~~</syntaxHighlight>~~		}}

	== Packaging ==		== Packaging ==

	~~example~~:		Example:

	<syntaxHighlight lang="nix">		<syntaxHighlight lang="nix">
Line 110:		Line 107:
	<syntaxHighlight lang="console">		<syntaxHighlight lang="console">
	$ nix-locate bin/stat \| grep 'bin/stat$'		$ nix-locate bin/stat \| grep 'bin/stat$'
	coreutils.out 0 s /nix/store/vr96j3cxj75xsczl8pzrgsv1k57hcxyp-coreutils-8.31/bin/stat		coreutils.out 0 s /nix/store/vr96j3cxj75xsczl8pzrgsv1k57hcxyp-coreutils-8.31/bin/stat
	</syntaxHighlight>		</syntaxHighlight>

Line 119:		Line 116:
	To trace commands and line numbers, we can use		To trace commands and line numbers, we can use

	~~<syntaxHighlight lang="nix">~~		{{file\|test-trace.nix\|nix\|3=
	# test-trace.nix
	{ runCommand, coreutils }:		{ runCommand, coreutils }:
	runCommand "output.txt" {		runCommand "output.txt" { nativeBuildInputs = [ coreutils ]; } ''
	nativeBuildInputs = [ coreutils ];		# line 5 in nix file = line 1 in bash script -> offset 4
	} ''		PS4='+ Line $(expr $LINENO + 4): '
	# line 5 in nix file = line 1 in bash script -> offset 4		set -o xtrace # print commands
	PS4='+ Line $(expr $LINENO + 4): '
	set -o xtrace # print commands

	echo hello >$out # line 9 in nix file		echo hello >$out # line 9 in nix file

	set +o xtrace # hide commands		set +o xtrace # hide commands
	''		''
	~~</syntaxHighlight>~~
			}}

	<syntaxHighlight lang="console">		<syntaxHighlight lang="console">

DHCP: /* See also */ add Nix-shell shebang to the list

2026-05-20T18:20:22Z

See also: add Nix-shell shebang to the list

← Older revision		Revision as of 18:20, 20 May 2026
Line 153:		Line 153:
	== See also ==		== See also ==

			* [[Nix-shell shebang]]
	* [https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions Shell functions section in the Nixpkgs manual]		* [https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions Shell functions section in the Nixpkgs manual]
	* [https://gist.github.com/travisbhartwell/f972aab227306edfcfea nix-shell and Shebang Lines]		* [https://gist.github.com/travisbhartwell/f972aab227306edfcfea nix-shell and Shebang Lines]

Roxwize: Roxwize moved page Shell Scripts to Shell scripts: capitalization

2025-12-07T21:58:33Z

Roxwize moved page Shell Scripts to Shell scripts: capitalization

← Older revision		Revision as of 21:58, 7 December 2025
(No difference)

Pigs: Add category development and shell

2025-05-17T16:51:18Z

Add category development and shell

← Older revision		Revision as of 16:51, 17 May 2025
Line 156:		Line 156:
	* [https://gist.github.com/travisbhartwell/f972aab227306edfcfea nix-shell and Shebang Lines]		* [https://gist.github.com/travisbhartwell/f972aab227306edfcfea nix-shell and Shebang Lines]
	* [https://ertt.ca/nix/shell-scripts/ Shell Scripts with Nix]		* [https://ertt.ca/nix/shell-scripts/ Shell Scripts with Nix]

			[[Category:Development]]
			[[Category:Shell]]

Mic92: fix link

2024-06-07T13:52:24Z

fix link

← Older revision		Revision as of 13:52, 7 June 2024
Line 155:		Line 155:
	* [https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions Shell functions section in the Nixpkgs manual]		* [https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions Shell functions section in the Nixpkgs manual]
	* [https://gist.github.com/travisbhartwell/f972aab227306edfcfea nix-shell and Shebang Lines]		* [https://gist.github.com/travisbhartwell/f972aab227306edfcfea nix-shell and Shebang Lines]
	* [https://~~www.~~ertt.ca/nix/shell-scripts/ Shell Scripts with Nix]		* [https://ertt.ca/nix/shell-scripts/ Shell Scripts with Nix]

imported>Milahu: add link: Shell Scripts with Nix

2022-04-02T19:20:38Z

add link: Shell Scripts with Nix

← Older revision		Revision as of 19:20, 2 April 2022
Line 155:		Line 155:
	* [https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions Shell functions section in the Nixpkgs manual]		* [https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions Shell functions section in the Nixpkgs manual]
	* [https://gist.github.com/travisbhartwell/f972aab227306edfcfea nix-shell and Shebang Lines]		* [https://gist.github.com/travisbhartwell/f972aab227306edfcfea nix-shell and Shebang Lines]
			* [https://www.ertt.ca/nix/shell-scripts/ Shell Scripts with Nix]

imported>Milahu: add link: nix-shell and Shebang Lines

2022-01-10T14:50:02Z

add link: nix-shell and Shebang Lines

← Older revision		Revision as of 14:50, 10 January 2022
Line 154:		Line 154:

	* [https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions Shell functions section in the Nixpkgs manual]		* [https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions Shell functions section in the Nixpkgs manual]
			* [https://gist.github.com/travisbhartwell/f972aab227306edfcfea nix-shell and Shebang Lines]

imported>Milahu: fix nix syntax

2021-10-12T16:25:26Z

fix nix syntax

← Older revision		Revision as of 16:25, 12 October 2021
Line 97:		Line 97:
	--prefix PATH : ${lib.makeBinPath [ bash subversion ]}		--prefix PATH : ${lib.makeBinPath [ bash subversion ]}
	'';		'';
	};		}
	</syntaxHighlight>		</syntaxHighlight>

imported>Milahu: + Debugging embedded scripts, rename path to drv

2021-10-10T13:34:57Z

+ Debugging embedded scripts, rename path to drv

@@ Line 23: / Line 23: @@
 # default.nix
+{
-   outputTxtPath = stdenv.mkDerivation rec {
+   outputTxtDrv = stdenv.mkDerivation rec {
      name = "output.txt";
      # disable unpackPhase etc
@@ Line 55: / Line 55: @@
 # default.nix
+{
-   outputTxtPath = runCommand "output.txt" {
+   outputTxtDrv = runCommand "output.txt" {
      nativeBuildInputs = [ coreutils jq ];
      # only strings can be passed to builder
@@ Line 111: / Line 111: @@
 $ nix-locate bin/stat | grep 'bin/stat$'
 coreutils.out                                         0 s /nix/store/vr96j3cxj75xsczl8pzrgsv1k57hcxyp-coreutils-8.31/bin/stat
 </syntaxHighlight>