Getting started

Installation

1. Install Nix

LinuxmacOSWindows (WSL2)Docker

sh <(curl -L https://nixos.org/nix/install) --daemon

curl -L https://raw.githubusercontent.com/NixOS/experimental-nix-installer/main/nix-installer.sh | sh -s install

Experimental installer

We recommend using the above experimental installer. It can handle OS upgrades and has better support for Apple silicon.

If you'd like to stick with the official release installer, use:

sh <(curl -L https://nixos.org/nix/install)

Upgrade Bash

macOS ships with an ancient version of Bash due to licensing reasons.

We recommend installing a newer version from nixpkgs to avoid running into evaluation errors.

Nix env (newcomers)Nix profiles (requires experimental flags)

nix-env --install --attr bashInteractive -f https://github.com/NixOS/nixpkgs/tarball/nixpkgs-unstable

nix profile install nixpkgs#bashInteractive

sh <(curl -L https://nixos.org/nix/install) --no-daemon

docker run -it nixos/nix

2. Install devenv

NewcomersNix profiles (requires experimental flags)NixOS/nix-darwin/home-manager

nix-env --install --attr devenv -f https://github.com/NixOS/nixpkgs/tarball/nixpkgs-unstable

nix profile install nixpkgs#devenv

configuration.nix

environment.systemPackages = [ 
  pkgs.devenv
];

Initial set up

Given a Git repository, create the initial structure:

$ devenv init
• Creating .envrc
• Creating devenv.nix
• Creating devenv.yaml
• Creating .gitignore

Commands

• devenv test builds your developer environment and makes sure that all checks pass. Useful to run in your continuous integration environment.
• devenv shell activates your developer environment.
• devenv search <NAME> searches packages matching NAME in Nixpkgs input.
• devenv update updates and pins inputs from devenv.yaml into devenv.lock.
• devenv gc deletes unused environments to save disk space.
• devenv up starts processes.

Learn more

• About .envrc in Automatic shell activation.
• About devenv.yaml in Inputs and Composing using imports.
• About devenv.nix in the Writing devenv.nix section, starting with the basics.

Updating

Update devenv CLI

Nix env (newcomers)Nix profiles (requires experimental flags)NixOS/nix-darwin/home-manager

nix-env --upgrade --attr devenv -f https://github.com/NixOS/nixpkgs/tarball/nixpkgs-unstable

nix profile upgrade devenv

Update nixpkgs to get the latest version of devenv.

For detailed upgrade instructions specific to your setup, please refer to the documentation for your particular system: NixOS, nix-darwin (for macOS), or home-manager, as applicable.

Update project inputs

Inputs, like nixpkgs and devenv modules, are downloaded and pinned in a devenv.lock lockfile.

These should be periodically updated with:

devenv update

Learn more about Inputs.