This program is experimental and its interface is subject to change.
nix develop - run a bash shell that provides the build environment of a derivation
nix develop [option...] installable
Start a shell with the build environment of the default package of the flake in the current directory:
# nix develop
Typical commands to run inside this shell are:
# configurePhase # buildPhase # installPhase
Alternatively, you can run whatever build tools your project uses directly, e.g. for a typical Unix project:
# ./configure --prefix=$out # make # make install
Run a particular build phase directly:
# nix develop --unpack # nix develop --configure # nix develop --build # nix develop --check # nix develop --install # nix develop --installcheck
Start a shell with the build environment of GNU Hello:
# nix develop nixpkgs#hello
Record a build environment in a profile:
# nix develop --profile /tmp/my-build-env nixpkgs#hello
Use a build environment previously recorded in a profile:
# nix develop /tmp/my-build-env
Replace all occurrences of the store path corresponding to
glibc.devwith a writable directory:
# nix develop --redirect nixpkgs#glibc.dev ~/my-glibc/outputs/dev
Note that this is useful if you're running a
nix developshell for
~/my-glibcand want to compile another package against it.
Run a series of script commands:
# nix develop --command bash -c "mkdir build && cmake .. && make"
nix develop starts a
bash shell that provides an interactive build
environment nearly identical to what Nix would use to build
installable. Inside this shell, environment variables and shell
functions are set up so that you can interactively and incrementally
build your package.
Nix determines the build environment by building a modified version of
the derivation installable that just records the environment
stdenv and exits. This build environment can be
recorded into a profile using
The prompt used by the
bash shell can be customised by setting the
bash-prompt-suffix settings in
nix.conf or in the flake's
If no flake output attribute is given,
nix develop tries the following
flake output attributes:
If a flake output name is given,
nix develop tries the following flake
Instead of starting an interactive shell, start the specified command and arguments.
Clear the entire environment (except those specified with
Keep the environment variable name.
The stdenv phase to run (e.g.
The profile to operate on.
Redirect a store path to a mutable location.
Unset the environment variable name.
Pass the value expr as the argument name to Nix functions.
Pass the string string as the argument name to Nix functions.
Start an interactive environment if evaluation fails.
The URL of the Nix store to use for evaluation, i.e. to store derivations (
.drvfiles) and inputs referenced by them.
Allow access to mutable paths and repositories.
Add path to the Nix search path. The Nix search path is initialized from the colon-separated
NIX_PATHenvironment variable, and is used to look up the location of Nix expressions using paths enclosed in angle brackets (i.e.,
For instance, passing
-I /home/eelco/Dev -I /etc/nixos
will cause Nix to look for paths relative to
/etc/nixos, in that order. This is equivalent to setting the
NIX_PATHenvironment variable to
It is also possible to match paths against a prefix. For example, passing
-I nixpkgs=/home/eelco/Dev/nixpkgs-branch -I /etc/nixos
will cause Nix to search for
If a path in the Nix search path starts with
https://, it is interpreted as the URL of a tarball that will be downloaded and unpacked to a temporary location. The tarball must consist of a single top-level directory. For example, passing
tells Nix to download and use the current contents of the
masterbranch in the
The URLs of the tarballs from the official
nixos.orgchannels (see the manual page for
nix-channel) can be abbreviated as
channel:<channel-name>. For instance, the following two flags are equivalent:
-I nixpkgs=channel:nixos-21.05 -I nixpkgs=https://nixos.org/channels/nixos-21.05/nixexprs.tar.xz
You can also fetch source trees using flake URLs and add them to the search path. For instance,
specifies that the prefix
nixpkgsshall refer to the source tree downloaded from the
nixpkgsentry in the flake registry. Similarly,
<nixpkgs>refer to a particular branch of the
NixOS/nixpkgsrepository on GitHub.
Override the flake registries, redirecting original-ref to resolved-ref.
Commit changes to the flake's lock file.
Use the inputs of the specified flake as registry entries.
Don't allow lookups in the flake registries. This option is deprecated; use
Do not allow any updates to the flake's lock file.
Do not write the flake's newly generated lock file.
Write the given lock file instead of
flake.lockwithin the top-level flake.
Override a specific flake input (e.g.
dwarffs/nixpkgs). This implies
Recreate the flake's lock file from scratch.
Read the given lock file instead of
flake.lockwithin the top-level flake.
Update a specific flake input (ignoring its previous entry in the lock file).
Set the logging verbosity level to 'debug'.
Set the format of log output; one of
Print full build logs on standard error.
Decrease the logging verbosity level.
Increase the logging verbosity level.
Show usage information.
Disable substituters and consider all previously downloaded files up-to-date.
Set the Nix configuration setting name to value (overriding
Consider all previously downloaded files out-of-date.
During evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.
Show version information.
Interpret installables as attribute paths relative to the Nix expression expr.
Interpret installables as attribute paths relative to the Nix expression stored in file. If file is the character -, then a Nix expression will be read from standard input. Implies
man nix.conffor overriding configuration settings with command line flags.