Shell scripts - Revision history

Roxwize: Marked this version for translation

2026-07-28T01:28:16Z

Marked this version for translation

← Older revision		Revision as of 01:28, 28 July 2026
Line 2:		Line 2:

	<translate>		<translate>
			<!--T: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.
	</translate>		</translate>
Line 21:		Line 22:

	<translate>		<translate>
	== External builder.sh script ==		== External builder.sh script == <!--T:2-->

			<!--T:3-->
	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:
	</translate>		</translate>
Line 48:		Line 50:

	<translate>		<translate>
			<!--T:4-->
	See also:		See also:

			<!--T:5-->
	* [<tvar name="1">https://github.com/NixOS/nixpkgs/issues/23099</tvar> Make a derivation with no source]		* [<tvar name="1">https://github.com/NixOS/nixpkgs/issues/23099</tvar> Make a derivation with no source]
	* [<tvar name="2">https://nixos.org/guides/nix-pills/working-derivation.html</tvar> Nix Pills: Chapter 7. Working Derivation]		* [<tvar name="2">https://nixos.org/guides/nix-pills/working-derivation.html</tvar> Nix Pills: Chapter 7. Working Derivation]

	=== runCommand + builder.sh ===		=== runCommand + builder.sh === <!--T:6-->

			<!--T:7-->
	Instead of <code>stdenv.mkDerivation</code>, <code>runCommand</code> can also be used to call an external Bash script:		Instead of <code>stdenv.mkDerivation</code>, <code>runCommand</code> can also be used to call an external Bash script:
	</translate>		</translate>
Line 71:		Line 76:

	<translate>		<translate>
	== Packaging ==		== Packaging == <!--T:8-->

			<!--T:9-->
	Example:		Example:
	</translate>		</translate>
Line 108:		Line 114:

	<translate>		<translate>
			<!--T:10-->
	<code>wrapProgram</code> will move the original script to <code>.github-downloader.sh-wrapped</code>.		<code>wrapProgram</code> will move the original script to <code>.github-downloader.sh-wrapped</code>.

	=== Command not found ===		=== Command not found === <!--T:11-->

			<!--T:12-->
	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.

			<!--T:13-->
	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:
	</translate>		</translate>
Line 123:		Line 132:

	<translate>		<translate>
	== Debugging embedded scripts ==		== Debugging embedded scripts == <!--T:14-->

			<!--T:15-->
	When a bash script fails, it prints only an error message, but no code location.		When a bash script fails, it prints only an error message, but no code location.

			<!--T:16-->
	To trace commands and line numbers, one can use		To trace commands and line numbers, one can use
	</translate>		</translate>
Line 155:		Line 166:

	<translate>		<translate>
	== POSIX shell ==		== POSIX shell == <!--T:17-->

			<!--T:18-->
	Some environments (like OpenWRT, via BusyBox) offer only a "limited" shell (<code>sh</code> instead of <code>bash</code>).		Some environments (like OpenWRT, via BusyBox) offer only a "limited" shell (<code>sh</code> instead of <code>bash</code>).

			<!--T:19-->
	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 == <!--T:20-->

			<!--T:21-->
	* [[<tvar name="1">Nix-shell shebang</tvar>\|Nix-shell shebang]]		* [[<tvar name="1">Nix-shell shebang</tvar>\|Nix-shell shebang]]
	* [<tvar name="2">https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions</tvar> Shell functions section in the Nixpkgs manual]		* [<tvar name="2">https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions</tvar> Shell functions section in the Nixpkgs manual]

Roxwize: /* See also */

2026-07-28T01:27:39Z

Roxwize at 01:27, 28 July 2026

2026-07-28T01:27:20Z

← Older revision		Revision as of 01:27, 28 July 2026
Line 169:		Line 169:
	</translate>		</translate>

	[[Category:Development]]		[[Category:Development{{#translation:}}\|Shell scripts]]
	~~[[Category~~:Shell]]		[[Category:Shell{{#translation:}}\|Shell scripts]]
	[[Category:~~NixOS~~{{#translation:}}\|~~Updating NixOS~~]]

Roxwize at 01:26, 28 July 2026

2026-07-28T01:26:53Z

← Older revision		Revision as of 01:26, 28 July 2026
Line 171:		Line 171:
	[[Category:Development]]		[[Category:Development]]
	[[Category:Shell]]		[[Category:Shell]]
			[[Category:NixOS{{#translation:}}\|Updating NixOS]]

Roxwize: prepare for translation

2026-07-28T01:26:27Z

prepare for translation

← Older revision		Revision as of 01:26, 28 July 2026
Line 1:		Line 1:
			<languages/>

			<translate>
	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.
			</translate>

	<syntaxHighlight lang="nix">		<syntaxHighlight lang="nix">
Line 16:		Line 20:
	</syntaxHighlight>		</syntaxHighlight>

			<translate>
	== External builder.sh script ==		== External builder.sh script ==

	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:
			</translate>

	{{file\|default.nix\|nix\|3=		{{file\|default.nix\|nix\|3=
Line 41:		Line 47:
	}}		}}

	See also		<translate>
			See also:

	* [https://github.com/NixOS/nixpkgs/issues/23099 ~~make~~ a derivation with no source]		* [<tvar name="1">https://github.com/NixOS/nixpkgs/issues/23099</tvar> Make a derivation with no source]
	* [https://nixos.org/guides/nix-pills/working-derivation.html Nix Pills: Chapter 7. Working Derivation]		* [<tvar name="2">https://nixos.org/guides/nix-pills/working-derivation.html</tvar> Nix Pills: Chapter 7. Working Derivation]

	=== runCommand + builder.sh ===		=== runCommand + builder.sh ===

	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>, <code>runCommand</code> can also be used to call an external Bash script:
			</translate>

	{{file\|default.nix\|nix\|3=		{{file\|default.nix\|nix\|3=
Line 62:		Line 70:
	}}		}}

			<translate>
	== Packaging ==		== Packaging ==

	Example:		Example:
			</translate>

	<syntaxHighlight lang="nix">		<syntaxHighlight lang="nix">
Line 97:		Line 107:
	</syntaxHighlight>		</syntaxHighlight>

	<code>wrapProgram</code> will move the original script to <code>.github-downloader.sh-wrapped</code>		<translate>
			<code>wrapProgram</code> will move the original script to <code>.github-downloader.sh-wrapped</code>.

	=== Command not found ===		=== Command not found ===
Line 104:		Line 115:

	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:
			</translate>

	<syntaxHighlight lang="console">		<syntaxHighlight lang="console">
Line 110:		Line 122:
	</syntaxHighlight>		</syntaxHighlight>

			<translate>
	== Debugging embedded scripts ==		== Debugging embedded scripts ==

	When a bash script fails, it prints only an error message, but no code location.		When a bash script fails, it prints only an error message, but no code location.

	To trace commands and line numbers, we can use		To trace commands and line numbers, one can use
			</translate>

	{{file\|test-trace.nix\|nix\|3=		{{file\|test-trace.nix\|nix\|3=
Line 140:		Line 154:
	</syntaxHighlight>		</syntaxHighlight>

			<translate>
	== POSIX shell ==		== POSIX shell ==

Line 148:		Line 163:
	== See also ==		== See also ==

	* [[Nix-shell shebang]]		* [[<tvar name="1">Nix-shell shebang</tvar>\|Nix-shell shebang]]
	* [https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions Shell functions section in the Nixpkgs manual]		* [<tvar name="2">https://nixos.org/manual/nixpkgs/stable/#ssec-stdenv-functions</tvar> Shell functions section in the Nixpkgs manual]
	* [https://gist.github.com/travisbhartwell/f972aab227306edfcfea nix-shell and Shebang Lines]		* [<tvar name="3">https://gist.github.com/travisbhartwell/f972aab227306edfcfea</tvar> nix-shell and Shebang Lines]
	* [https://ertt.ca/nix/shell-scripts/ Shell Scripts with Nix]		* [<tvar>https://ertt.ca/nix/shell-scripts/</tvar> Shell Scripts with Nix]
			</translate>

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

Roxwize at 01:14, 28 July 2026

2026-07-28T01:14:47Z

← Older revision		Revision as of 01:14, 28 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 140:		Line 140:
	</syntaxHighlight>		</syntaxHighlight>

	== ~~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 BusyBox) 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: 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)