nuclei: 3.3.5 -> 3.3.6 (#358083)
[NixPkgs.git] / doc / build-helpers / special / mkshell.section.md
blobe39bef7468e3b1b3334ca34cc86437d9e63bcdde
1 # pkgs.mkShell {#sec-pkgs-mkShell}
3 `pkgs.mkShell` is a specialized `stdenv.mkDerivation` that removes some
4 repetition when using it with `nix-shell` (or `nix develop`).
6 ## Usage {#sec-pkgs-mkShell-usage}
8 Here is a common usage example:
10 ```nix
11 { pkgs ? import <nixpkgs> {} }:
12 pkgs.mkShell {
13   packages = [ pkgs.gnumake ];
15   inputsFrom = [ pkgs.hello pkgs.gnutar ];
17   shellHook = ''
18     export DEBUG=1
19   '';
21 ```
23 ## Attributes {#sec-pkgs-mkShell-attributes}
25 * `name` (default: `nix-shell`). Set the name of the derivation.
26 * `packages` (default: `[]`). Add executable packages to the `nix-shell` environment.
27 * `inputsFrom` (default: `[]`). Add build dependencies of the listed derivations to the `nix-shell` environment.
28 * `shellHook` (default: `""`). Bash statements that are executed by `nix-shell`.
30 ... all the attributes of `stdenv.mkDerivation`.
32 ## Variants {#sec-pkgs-mkShell-variants}
34 `pkgs.mkShellNoCC` is a variant that uses `stdenvNoCC` instead of `stdenv` as base environment. This is useful if no C compiler is needed in the shell environment.
36 ## Building the shell {#sec-pkgs-mkShell-building}
38 This derivation output will contain a text file that contains a reference to
39 all the build inputs. This is useful in CI where we want to make sure that
40 every derivation, and its dependencies, build properly. Or when creating a GC
41 root so that the build dependencies don't get garbage-collected.