kloenk/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity
lix/doc/manual/src/command-ref/nix-hash.md

139 lines
4.2 KiB
Markdown
Raw Normal View History

Clean up the manpages
2020-07-24 10:56:19 +00:00
# Name
Convert commands
2020-07-23 10:58:42 +00:00
Clean up the manpages
2020-07-24 10:56:19 +00:00
`nix-hash` - compute the cryptographic hash of a path
Convert commands
2020-07-23 10:58:42 +00:00
Clean up the manpages
2020-07-24 10:56:19 +00:00
# Synopsis
Convert commands
2020-07-23 10:58:42 +00:00
Clean up the manpages
2020-07-24 10:56:19 +00:00
`nix-hash` [`--flat`] [`--base32`] [`--truncate`] [`--type` *hashAlgo*] *path…*
Convert commands
2020-07-23 10:58:42 +00:00
nix-hash: support base-64 and SRI format Add the --base64 and --sri flags for the Base64 and SRI format output. Add the --base16 flag to explicitly specify the hexadecimal format. Add the --to-base64 and --to-sri flag to convert a hash to the above mentioned format.
2023-03-15 16:33:58 +00:00
`nix-hash` [`--to-base16`|`--to-base32`|`--to-base64`|`--to-sri`] [`--type` *hashAlgo*] *hash…*
Convert commands
2020-07-23 10:58:42 +00:00
# Description
The command `nix-hash` computes the cryptographic hash of the contents
<replaceable> -> <emphasis> Pandoc doesn't know <replaceable> so let's force it to be rendered as italics.
2020-07-23 12:28:05 +00:00
of each *path* and prints it on standard output. By default, it computes
Convert commands
2020-07-23 10:58:42 +00:00
an MD5 hash, but other hash algorithms are available as well. The hash
is printed in hexadecimal. To generate the same hash as
`nix-prefetch-url` you have to specify multiple arguments, see below for
an example.
Fix internal links
2020-07-24 13:46:16 +00:00
The hash is computed over a *serialisation* of each path: a dump of
the file system tree rooted at the path. This allows directories and
symlinks to be hashed as well as regular files. The dump is in the
*NAR format* produced by [`nix-store
Split nix-env and nix-store documentation per-subcommand Documentation on "classic" commands with many sub-commands are notoriously hard to discover due to lack of overview and anchor links. Additionally the information on common options and environment variables is not accessible offline in man pages, and therefore often overlooked by readers. With this change, each sub-command of nix-store and nix-env gets its own page in the manual (listed in the table of contents), and each own man page. Also, man pages for each subcommand now (again) list common options and environment variables. While this makes each page quite long and some common parameters don't apply, this should still make it easier to navigate as that additional information was not accessible on the command line at all. It is now possible to run 'nix-store --<subcommand> --help` to display help pages for the given subcommand. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-23 15:27:41 +00:00
--dump`](@docroot@/command-ref/nix-store/dump.md). Thus, `nix-hash path`
Fix internal links
2020-07-24 13:46:16 +00:00
yields the same cryptographic hash as `nix-store --dump path |
md5sum`.
Convert commands
2020-07-23 10:58:42 +00:00
# Options
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `--flat`\
Convert commands
2020-07-23 10:58:42 +00:00
Print the cryptographic hash of the contents of each regular file
<replaceable> -> <emphasis> Pandoc doesn't know <replaceable> so let's force it to be rendered as italics.
2020-07-23 12:28:05 +00:00
*path*. That is, do not compute the hash over the dump of *path*.
The result is identical to that produced by the GNU commands
`md5sum` and `sha1sum`.
Convert commands
2020-07-23 10:58:42 +00:00
nix-hash: support base-64 and SRI format Add the --base64 and --sri flags for the Base64 and SRI format output. Add the --base16 flag to explicitly specify the hexadecimal format. Add the --to-base64 and --to-sri flag to convert a hash to the above mentioned format.
2023-03-15 16:33:58 +00:00
- `--base16`\
Print the hash in a hexadecimal representation (default).
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `--base32`\
Convert commands
2020-07-23 10:58:42 +00:00
Print the hash in a base-32 representation rather than hexadecimal.
This base-32 representation is more compact and can be used in Nix
expressions (such as in calls to `fetchurl`).
nix-hash: support base-64 and SRI format Add the --base64 and --sri flags for the Base64 and SRI format output. Add the --base16 flag to explicitly specify the hexadecimal format. Add the --to-base64 and --to-sri flag to convert a hash to the above mentioned format.
2023-03-15 16:33:58 +00:00
- `--base64`\
Similar to --base32, but print the hash in a base-64 representation,
which is more compact than the base-32 one.
- `--sri`\
Print the hash in SRI format with base-64 encoding.
The type of hash algorithm will be prepended to the hash string,
followed by a hyphen (-) and the base-64 hash body.
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `--truncate`\
Convert commands
2020-07-23 10:58:42 +00:00
Truncate hashes longer than 160 bits (such as SHA-256) to 160 bits.
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `--type` *hashAlgo*\
Convert commands
2020-07-23 10:58:42 +00:00
Use the specified cryptographic hash algorithm, which can be one of
Add sha512 to hashAlgo listings in manpages (#4186)
2020-10-25 22:16:53 +00:00
`md5`, `sha1`, `sha256`, and `sha512`.
Convert commands
2020-07-23 10:58:42 +00:00
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `--to-base16`\
Convert commands
2020-07-23 10:58:42 +00:00
Don’t hash anything, but convert the base-32 hash representation
<replaceable> -> <emphasis> Pandoc doesn't know <replaceable> so let's force it to be rendered as italics.
2020-07-23 12:28:05 +00:00
*hash* to hexadecimal.
Convert commands
2020-07-23 10:58:42 +00:00
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `--to-base32`\
Convert commands
2020-07-23 10:58:42 +00:00
Don’t hash anything, but convert the hexadecimal hash representation
<replaceable> -> <emphasis> Pandoc doesn't know <replaceable> so let's force it to be rendered as italics.
2020-07-23 12:28:05 +00:00
*hash* to base-32.
Convert commands
2020-07-23 10:58:42 +00:00
nix-hash: support base-64 and SRI format Add the --base64 and --sri flags for the Base64 and SRI format output. Add the --base16 flag to explicitly specify the hexadecimal format. Add the --to-base64 and --to-sri flag to convert a hash to the above mentioned format.
2023-03-15 16:33:58 +00:00
- `--to-base64`\
Don’t hash anything, but convert the hexadecimal hash representation
*hash* to base-64.
- `--to-sri`\
Don’t hash anything, but convert the hexadecimal hash representation
*hash* to SRI.
Convert commands
2020-07-23 10:58:42 +00:00
# Examples
Computing the same hash as `nix-prefetch-url`:
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
```console
$ nix-prefetch-url file://<(echo test)
1lkgqb6fclns49861dwk9rzb6xnfkxbpws74mxnx01z9qyv1pjpj
$ nix-hash --type sha256 --flat --base32 <(echo test)
1lkgqb6fclns49861dwk9rzb6xnfkxbpws74mxnx01z9qyv1pjpj
```
Convert commands
2020-07-23 10:58:42 +00:00
Computing hashes:
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
```console
$ mkdir test
$ echo "hello" > test/world
Clean up the manpages
2020-07-24 10:56:19 +00:00
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
$ nix-hash test/ (MD5 hash; default)
8179d3caeff1869b5ba1744e5a245c04
Clean up the manpages
2020-07-24 10:56:19 +00:00
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
$ nix-store --dump test/ | md5sum (for comparison)
8179d3caeff1869b5ba1744e5a245c04 -
Clean up the manpages
2020-07-24 10:56:19 +00:00
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
$ nix-hash --type sha1 test/
e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
Clean up the manpages
2020-07-24 10:56:19 +00:00
nix-hash: support base-64 and SRI format Add the --base64 and --sri flags for the Base64 and SRI format output. Add the --base16 flag to explicitly specify the hexadecimal format. Add the --to-base64 and --to-sri flag to convert a hash to the above mentioned format.
2023-03-15 16:33:58 +00:00
$ nix-hash --type sha1 --base16 test/
e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
$ nix-hash --type sha1 --base32 test/
nvd61k9nalji1zl9rrdfmsmvyyjqpzg4
Clean up the manpages
2020-07-24 10:56:19 +00:00
nix-hash: support base-64 and SRI format Add the --base64 and --sri flags for the Base64 and SRI format output. Add the --base16 flag to explicitly specify the hexadecimal format. Add the --to-base64 and --to-sri flag to convert a hash to the above mentioned format.
2023-03-15 16:33:58 +00:00
$ nix-hash --type sha1 --base64 test/
5P2Lpfe76upazon+ECVVNs1g2rY=
$ nix-hash --type sha1 --sri test/
sha1-5P2Lpfe76upazon+ECVVNs1g2rY=
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
$ nix-hash --type sha256 --flat test/
error: reading file `test/': Is a directory
Clean up the manpages
2020-07-24 10:56:19 +00:00
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
$ nix-hash --type sha256 --flat test/world
5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03
```
Convert commands
2020-07-23 10:58:42 +00:00
nix-hash: support base-64 and SRI format Add the --base64 and --sri flags for the Base64 and SRI format output. Add the --base16 flag to explicitly specify the hexadecimal format. Add the --to-base64 and --to-sri flag to convert a hash to the above mentioned format.
2023-03-15 16:33:58 +00:00
Converting between hexadecimal, base-32, base-64, and SRI:
Convert commands
2020-07-23 10:58:42 +00:00
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
```console
$ nix-hash --type sha1 --to-base32 e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
nvd61k9nalji1zl9rrdfmsmvyyjqpzg4
Clean up the manpages
2020-07-24 10:56:19 +00:00
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
$ nix-hash --type sha1 --to-base16 nvd61k9nalji1zl9rrdfmsmvyyjqpzg4
e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
nix-hash: support base-64 and SRI format Add the --base64 and --sri flags for the Base64 and SRI format output. Add the --base16 flag to explicitly specify the hexadecimal format. Add the --to-base64 and --to-sri flag to convert a hash to the above mentioned format.
2023-03-15 16:33:58 +00:00
$ nix-hash --type sha1 --to-base64 e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
5P2Lpfe76upazon+ECVVNs1g2rY=
$ nix-hash --type sha1 --to-sri nvd61k9nalji1zl9rrdfmsmvyyjqpzg4
sha1-5P2Lpfe76upazon+ECVVNs1g2rY=
$ nix-hash --to-base16 sha1-5P2Lpfe76upazon+ECVVNs1g2rY=
e4fd8ba5f7bbeaea5ace89fe10255536cd60dab6
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
```
Copy permalink