646b892680
Some checks failed
Periodic Merges (6h) / master → staging-nixos (push) Failing after 12m50s
Periodic Merges (6h) / master → staging-next (push) Failing after 12m54s
Periodic Merges (24h) / merge-base(master,staging) → haskell-updates (push) Failing after 11m54s
Periodic Merges (6h) / staging-next → staging (push) Failing after 12m13s
Periodic Merges (24h) / staging-next-25.05 → staging-25.05 (push) Failing after 13m24s
Periodic Merges (24h) / release-25.05 → staging-next-25.05 (push) Failing after 14m28s
1.4 KiB
1.4 KiB
pkgs.mkShell
pkgs.mkShell is a specialized stdenv.mkDerivation that removes some
repetition when using it with nix-shell (or nix develop).
Usage
Here is a common usage example:
{
pkgs ? import <nixpkgs> { },
}:
pkgs.mkShell {
packages = [ pkgs.gnumake ];
inputsFrom = [
pkgs.hello
pkgs.gnutar
];
shellHook = ''
export DEBUG=1
'';
}
Attributes
name(default:nix-shell). Set the name of the derivation.packages(default:[]). Add executable packages to thenix-shellenvironment.inputsFrom(default:[]). Add build dependencies of the listed derivations to thenix-shellenvironment.shellHook(default:""). Bash statements that are executed bynix-shell.
... all the attributes of stdenv.mkDerivation.
Variants
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.
Building the shell
This derivation output will contain a text file that contains a reference to all the build inputs. This is useful in CI where we want to make sure that every derivation, and its dependencies, build properly. Or when creating a GC root so that the build dependencies don't get garbage-collected.