Skip to content

shebang scripts: clarify explanation of parameters using formatting #1097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fricklerhandwerk merged 1 commit into from
Jan 19, 2025
Merged

shebang scripts: clarify explanation of parameters using formatting #1097

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions source/tutorials/first-steps/reproducible-scripts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,22 +64,24 @@ curl https://github.com/NixOS/nixpkgs/releases.atom | xml2json | jq .
```

The first line is a standard shebang.
The additional shebang lines are a Nix-specific construct.
The additional shebang lines are a Nix-specific construct:

We specify `bash` as the interpreter for the rest of the file with the `-i` option.
- With the `-i` option, `bash` is specified as the interpreter for the rest of the file.

We enable the `--pure` option to prevent the script from implicitly using programs that may already exist on the system that will run the script.
- In this case, the `--pure` option is enabled to prevent the script from implicitly using programs that may already exist on the system on which the script is run.

With the `-p` option we specify the packages required for the script to run.
The command `xml2json` is provided by the package `python3Packages.xmljson`, while `bash`, `jq`, and `curl` are provided by packages of the same name.
- The `-p` option lists the packages required for the script to run.

The command `xml2json` is provided by the package `python3Packages.xmljson`, while `bash`, `jq`, and `curl` are provided by packages of the same name.
`cacert` must be present for SSL authentication to work.

:::{tip}
Use [search.nixos.org](https://search.nixos.org/packages) to find packages providing the program you need.
:::
:::{tip}
Use [search.nixos.org](https://search.nixos.org/packages) to find packages providing the program you need.
:::

- The parameter of `-I` refers to a specific Git commit of the Nixpkgs repository.

The parameter of `-I` refers to a specific Git commit of the Nixpkgs repository.
This ensures that the script will always run with the exact same packages versions, everywhere.
This ensures that the script will always run with the exact same packages versions, everywhere.

Make the script executable:

Expand Down
Loading