aboutsummaryrefslogtreecommitdiff
path: root/src/nix/derivation-show.md
blob: f644a429d0c31308130446f5127901beb7981fd9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
R""(

**Note:** this command's interface is based heavily around [*installables*](./nix.md#installables), which you may want to read about first (`nix --help`).

# Examples

* Show the [store derivation] that results from evaluating the Hello
  package:

  [store derivation]: ../../glossary.md#gloss-store-derivation

  ```console
  # nix derivation show nixpkgs#hello
  {
    "/nix/store/s6rn4jz1sin56rf4qj5b5v8jxjm32hlk-hello-2.10.drv": {

    }
  }
  ```

* Show the full derivation graph (if available) that produced your
  NixOS system:

  ```console
  # nix derivation show -r /run/current-system
  ```

* Print all files fetched using `fetchurl` by Firefox's dependency
  graph:

  ```console
  # nix derivation show -r nixpkgs#firefox \
    | jq -r '.[] | select(.outputs.out.hash and .env.urls) | .env.urls' \
    | uniq | sort
  ```

  Note that `.outputs.out.hash` selects *fixed-output derivations*
  (derivations that produce output with a specified content hash),
  while `.env.urls` selects derivations with a `urls` attribute.

# Description

This command prints on standard output a JSON representation of the
[store derivation]s to which [*installables*](./nix.md#installables) evaluate.

Store derivations are used internally by Nix. They are store paths with
extension `.drv` that represent the build-time dependency graph to which
a Nix expression evaluates.

By default, this command only shows top-level derivations, but with
`--recursive`, it also shows their dependencies.

The JSON output is a JSON object whose keys are the store paths of the
derivations, and whose values are a JSON object with the following
fields:

* `name`: The name of the derivation. This is used when calculating the
  store paths of the derivation's outputs.

* `outputs`: Information about the output paths of the
  derivation. This is a JSON object with one member per output, where
  the key is the output name and the value is a JSON object with these
  fields:

  * `path`: The output path.
  * `hashAlgo`: For fixed-output derivations, the hashing algorithm
    (e.g. `sha256`), optionally prefixed by `r:` if `hash` denotes a
    NAR hash rather than a flat file hash.
  * `hash`: For fixed-output derivations, the expected content hash in
    base-16.

  Example:

  ```json
  "outputs": {
    "out": {
      "path": "/nix/store/2543j7c6jn75blc3drf4g5vhb1rhdq29-source",
      "hashAlgo": "r:sha256",
      "hash": "6fc80dcc62179dbc12fc0b5881275898f93444833d21b89dfe5f7fbcbb1d0d62"
    }
  }
  ```

* `inputSrcs`: A list of store paths on which this derivation depends.

* `inputDrvs`: A JSON object specifying the derivations on which this
  derivation depends, and what outputs of those derivations. For
  example,

  ```json
  "inputDrvs": {
    "/nix/store/6lkh5yi7nlb7l6dr8fljlli5zfd9hq58-curl-7.73.0.drv": ["dev"],
    "/nix/store/fn3kgnfzl5dzym26j8g907gq3kbm8bfh-unzip-6.0.drv": ["out"]
  }
  ```

  specifies that this derivation depends on the `dev` output of
  `curl`, and the `out` output of `unzip`.

* `system`: The system type on which this derivation is to be built
  (e.g. `x86_64-linux`).

* `builder`: The absolute path of the program to be executed to run
  the build. Typically this is the `bash` shell
  (e.g. `/nix/store/r3j288vpmczbl500w6zz89gyfa4nr0b1-bash-4.4-p23/bin/bash`).

* `args`: The command-line arguments passed to the `builder`.

* `env`: The environment passed to the `builder`.

)""