nix/doc/manual/source/protocols/json/schema/derivation-v3.yaml

"$schema": http://json-schema.org/draft-04/schema#
"$id": https://nix.dev/manual/nix/latest/protocols/json/schema/derivation-v3.json
title: Derivation
description: |
  Experimental JSON representation of a Nix derivation (version 3).

  This schema describes the JSON representation of Nix's `Derivation` type.

  > **Warning**
  >
  > This JSON format is currently
  > [**experimental**](@docroot@/development/experimental-features.md#xp-feature-nix-command)
  > and subject to change.

type: object
required:
  - name
  - version
  - outputs
  - inputSrcs
  - inputDrvs
  - system
  - builder
  - args
  - env
properties:
  name:
    type: string
    description: |
      The name of the derivation.
      Used when calculating store paths for the derivation’s outputs.

  version:
    const: 3
    description: |
      Must be `3`.
      This is a guard that allows us to continue evolving this format.
      The choice of `3` is fairly arbitrary, but corresponds to this informal version:

      - Version 0: A-Term format

      - Version 1: Original JSON format, with ugly `"r:sha256"` inherited from A-Term format.

      - Version 2: Separate `method` and `hashAlgo` fields in output specs

      - Version 3: Drop store dir from store paths, just include base name.

      Note that while this format is experimental, the maintenance of versions is best-effort, and not promised to identify every change.

  outputs:
    type: object
    description: |
     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 as described.

      > **Example**
      >
      > ```json
      > "outputs": {
      >   "out": {
      >     "method": "nar",
      >     "hashAlgo": "sha256",
      >     "hash": "6fc80dcc62179dbc12fc0b5881275898f93444833d21b89dfe5f7fbcbb1d0d62"
      >   }
      > }
      > ```
    additionalProperties:
      "$ref": "#/$defs/output"

  inputSrcs:
    type: array
    description: |
      List of store paths on which this derivation depends.

      > **Example**
      >
      > ```json
      > "inputSrcs": [
      >   "47y241wqdhac3jm5l7nv0x4975mb1975-separate-debug-info.sh",
      >   "56d0w71pjj9bdr363ym3wj1zkwyqq97j-fix-pop-var-context-error.patch"
      > ]
      > ```
    items:
      type: string

  inputDrvs:
    type: object
    description: |
      Mapping of derivation paths to lists of output names they provide.

      > **Example**
      >
      > ```json
      > "inputDrvs": {
      >   "6lkh5yi7nlb7l6dr8fljlli5zfd9hq58-curl-7.73.0.drv": ["dev"],
      >   "fn3kgnfzl5dzym26j8g907gq3kbm8bfh-unzip-6.0.drv": ["out"]
      > }
      > ```
      >
      > specifies that this derivation depends on the `dev` output of `curl`, and the `out` output of `unzip`.

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

  builder:
    type: string
    description: |
      Absolute path of the program used to perform the build.
      Typically this is the `bash` shell
      (e.g. `/nix/store/r3j288vpmczbl500w6zz89gyfa4nr0b1-bash-4.4-p23/bin/bash`).

  args:
    type: array
    description: |
      Command-line arguments passed to the `builder`.
    items:
      type: string

  env:
    type: object
    description: |
      Environment variables passed to the `builder`.
    additionalProperties:
      type: string

  structuredAttrs:
    description: |
      [Structured Attributes](@docroot@/store/derivation/index.md#structured-attrs), only defined if the derivation contains them.
      Structured attributes are JSON, and thus embedded as-is.
    type: object
    additionalProperties: true

"$defs":
  output:
    type: object
    properties:
      path:
        type: string
        description: |
          The output path, if known in advance.

      method:
        type: string
        enum: [flat, nar, text, git]
        description: |
          For an output which will be [content addressed](@docroot@/store/derivation/outputs/content-address.md), a string representing the [method](@docroot@/store/store-object/content-address.md) of content addressing that is chosen.

          Valid method strings are:

          - [`flat`](@docroot@/store/store-object/content-address.md#method-flat)
          - [`nar`](@docroot@/store/store-object/content-address.md#method-nix-archive)
          - [`text`](@docroot@/store/store-object/content-address.md#method-text)
          - [`git`](@docroot@/store/store-object/content-address.md#method-git)

      hashAlgo:
        "$ref": "./hash-v1.yaml#/$defs/algorithm"

      hash:
        type: string
        description: |
          For fixed-output derivations, the expected content hash in base-16.