max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-11 08:46:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
nix-super/src/nix/develop.md
Jonathan Ringer 6ce2e96c88
Docs: Add nix develop --command entry 
Add example of nix develop being used to execuate a series of script
commands. This is common when doing things like CI/CD, and should be
represented in the official documentation.

Also useful for people looking for the 'nix develop' equivalent of
'nix-shell --run'.

Related:
 - https://github.com/NixOS/nix/issues/6908
 - https://github.com/NixOS/nix/issues/6908#issuecomment-1229266853
2022-09-06 08:18:29 -07:00

2.6 KiB
Raw Blame History

R""(

Examples

  • 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.dev with a writable directory:

    # nix develop --redirect nixpkgs#glibc.dev ~/my-glibc/outputs/dev

    Note that this is useful if you're running a nix develop shell for nixpkgs#glibc in ~/my-glibc and want to compile another package against it.

  • Run a series of script commands:

    # nix develop --command bash -c "mkdir build && cmake .. && make"

Description

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 initialised by stdenv and exits. This build environment can be recorded into a profile using --profile.

The prompt used by the bash shell can be customised by setting the bash-prompt, bash-prompt-prefix, and bash-prompt-suffix settings in nix.conf or in the flake's nixConfig attribute.

Flake output attributes

If no flake output attribute is given, nix develop tries the following flake output attributes:

  • devShells.<system>.default

  • packages.<system>.default

If a flake output name is given, nix develop tries the following flake output attributes:

  • devShells.<system>.<name>

  • packages.<system>.<name>

  • legacyPackages.<system>.<name>

)""