Module

build.packages #

(Output) Attribute set of name=pkg. Useful for adding them to a flake’s packages output.

Type: attribute set of package (read only)

Declared by:

build.toplevel #

(Output) Derivation that merges all the wrappers into a single package.

Type: package (read only)

Declared by:

wrappers #

Wrapper configuration. See the suboptions for configuration.

Type: attribute set of (submodule)

Default: { }

Declared by:

wrappers.<name>.appendFlags #

Append a flag to the invocation of the program, after any arguments passed to the wrapped executable.

Type: list of (string or anything convertible to it)

Default: [ ]

Example:

[
  "--config" ./config.sh
  "--ascii" ./ascii
]

Declared by:

wrappers.<name>.basePackage #

Program to be wrapped.

Type: package

Example: pkgs.nix

Declared by:

wrappers.<name>.env #

Structured environment variables.

Type: attribute set of (submodule)

Default: { }

Example:

{
  NIX_CONFIG = {
    value = "allow-import-from-derivation = false";
  };
}

Declared by:

wrappers.<name>.env.<name>.force #

Whether the value should be always set to the specified value. If set to true, the program will not inherit the value of the variable if it’s already present in the environment.

Setting it to false when unsetting a variable (value = null) will make the option have no effect.

Type: boolean

Default: true if value is null, otherwise false

Declared by:

wrappers.<name>.env.<name>.name #

Name of the variable.

Type: string

Default: "‹name›"

Declared by:

wrappers.<name>.env.<name>.value #

Value of the variable to be set. Set to null to unset the variable.

Note that any environment variable will be escaped. For example, value = "$HOME" will be converted to the literal $HOME, with its dollar sign.

Type: null or (string or anything convertible to it)

Declared by:

wrappers.<name>.extraPackages #

Extra packages to also wrap.

Type: list of package

Default: [ ]

Example: [ pkgs.git-extras pkgs.delta ]

Declared by:

wrappers.<name>.extraWrapperFlags #

Raw flags passed to makeWrapper.

See upstream documentation for make-wrapper.sh : https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/setup-hooks/make-wrapper.sh

Type: strings concatenated with " "

Default: ""

Example: "--argv0 foo --set BAR value"

Declared by:

wrappers.<name>.flags #

Alias of prependFlags.

Type: list of (string or anything convertible to it)

Declared by:

wrappers.<name>.overrideAttrs #

Function to override attributes from the final package.

Type: function that evaluates to a(n) (attribute set)

Default: <function>

Example:

''
  old: {
    pname = "''${old.pname}-wrapped";
  }
''

Declared by:

wrappers.<name>.pathAdd #

Packages to append to PATH.

Type: list of package

Default: [ ]

Example: [ pkgs.starship ]

Declared by:

wrappers.<name>.postBuild #

Extra fragment of bash to be run after the main wrapper-manager code.

Type: string

Default: ""

Example:

''
  $out/bin/nvim -l ''${./check.lua}
''

Declared by:

wrappers.<name>.prependFlags #

Prepend a flag to the invocation of the program, before any arguments passed to the wrapped executable.

Type: list of (string or anything convertible to it)

Default: [ ]

Example:

[
  "--config" ./config.sh
  "--ascii" ./ascii
]

Declared by:

wrappers.<name>.renames #

Map of renames FROM = TO. Renames every binary /bin/FROM to /bin/TO, adjusting other necessary files.

Type: attribute set of string

Default: { }

Example:

{
  nvim = "custom-nvim";
}

Declared by:

wrappers.<name>.wrapped #

(Output) Final wrapped package.

Type: package (read only)

Declared by: