Warning
This program is experimental and its interface is subject to change.

Name

nix flake show - show the outputs provided by a flake

Synopsis

nix flake show [option...] flake-url

Examples

• Show the output attributes provided by the patchelf flake:

  github:NixOS/patchelf/f34751b88bd07d7f44f5cd3200fb4122bf916c7e
  ├───checks
  │   ├───aarch64-linux
  │   │   └───build: derivation 'patchelf-0.12.20201207.f34751b'
  │   ├───i686-linux
  │   │   └───build: derivation 'patchelf-0.12.20201207.f34751b'
  │   └───x86_64-linux
  │       └───build: derivation 'patchelf-0.12.20201207.f34751b'
  ├───packages
  │   ├───aarch64-linux
  │   │   └───default: package 'patchelf-0.12.20201207.f34751b'
  │   ├───i686-linux
  │   │   └───default: package 'patchelf-0.12.20201207.f34751b'
  │   └───x86_64-linux
  │       └───default: package 'patchelf-0.12.20201207.f34751b'
  ├───hydraJobs
  │   ├───build
  │   │   ├───aarch64-linux: derivation 'patchelf-0.12.20201207.f34751b'
  │   │   ├───i686-linux: derivation 'patchelf-0.12.20201207.f34751b'
  │   │   └───x86_64-linux: derivation 'patchelf-0.12.20201207.f34751b'
  │   ├───coverage: derivation 'patchelf-coverage-0.12.20201207.f34751b'
  │   ├───release: derivation 'patchelf-0.12.20201207.f34751b'
  │   └───tarball: derivation 'patchelf-tarball-0.12.20201207.f34751b'
  └───overlay: Nixpkgs overlay
  

Description

This command shows the output attributes provided by the flake specified by flake reference flake-url. These are the top-level attributes in the outputs of the flake, as well as lower-level attributes for some standard outputs (e.g. packages or checks).

With --json, the output is in a JSON representation suitable for automatic processing by other tools.

Options

• --all-systems

  Show the contents of outputs for all systems.

• --json

  Produce output in JSON format, suitable for consumption by another program.

• --legacy

  Show the contents of the legacyPackages output.

Common evaluation options

• --arg name expr

  Pass the value expr as the argument name to Nix functions.

• --arg-from-file name path

  Pass the contents of file path as the argument name to Nix functions.

• --arg-from-stdin name

  Pass the contents of stdin as the argument name to Nix functions.

• --argstr name string

  Pass the string string as the argument name to Nix functions.

• --debugger

  Start an interactive environment if evaluation fails.

• --eval-store store-url

  The URL of the Nix store to use for evaluation, i.e. to store derivations (.drv files) and inputs referenced by them.

• --impure

  Allow access to mutable paths and repositories.

• --include / -I path

  Add path to search path entries used to resolve lookup paths

  This option may be given multiple times.

  Paths added through -I take precedence over the nix-path configuration setting and the NIX_PATH environment variable.

• --override-flake original-ref resolved-ref

  Override the flake registries, redirecting original-ref to resolved-ref.

Common flake-related options

• --commit-lock-file

  Commit changes to the flake's lock file.

• --inputs-from flake-url

  Use the inputs of the specified flake as registry entries.

• --no-registries

  Don't allow lookups in the flake registries.

  DEPRECATED

  Use --no-use-registries instead.

• --no-update-lock-file

  Do not allow any updates to the flake's lock file.

• --no-write-lock-file

  Do not write the flake's newly generated lock file.

• --output-lock-file flake-lock-path

  Write the given lock file instead of flake.lock within the top-level flake.

• --override-input input-path flake-url

  Override a specific flake input (e.g. dwarffs/nixpkgs). This implies --no-write-lock-file.

• --recreate-lock-file

  Recreate the flake's lock file from scratch.

  DEPRECATED

  Use nix flake update instead.

• --reference-lock-file flake-lock-path

  Read the given lock file instead of flake.lock within the top-level flake.

• --update-input input-path

  Update a specific flake input (ignoring its previous entry in the lock file).

  DEPRECATED

  Use nix flake update instead.

Logging-related options

• --debug

  Set the logging verbosity level to 'debug'.

• --log-format format

  Set the format of log output; one of raw, internal-json, bar or bar-with-logs.

• --print-build-logs / -L

  Print full build logs on standard error.

• --quiet

  Decrease the logging verbosity level.

• --verbose / -v

  Increase the logging verbosity level.

Miscellaneous global options

• --help

  Show usage information.

• --offline

  Disable substituters and consider all previously downloaded files up-to-date.

• --option name value

  Set the Nix configuration setting name to value (overriding nix.conf).

• --refresh

  Consider all previously downloaded files out-of-date.

• --repair

  During evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.

• --version

  Show version information.

Note

See man nix.conf for overriding configuration settings with command line flags.