docs/developing.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# Development

### Pre-requisites

-   [Nix (the package manager)](https://nixos.org/download/) with [flakes enabled](https://nixos.wiki/wiki/flakes#Enable_flakes_temporarily)
-   Optional:
    -   [cachix](https://docs.cachix.org/installation#installation)
    -   [lorri](https://github.com/nix-community/lorri)
    -   [direnv](https://direnv.net/)

### Setup

1. Optional: use cachix to avoid building some tools

    ```shell-session
    cachix use pre-commit-hooks
    ```

2. Start a nix shell (this will take some time)

    ```shell-session
    nix develop
    ```

3. Optional: install and set up lorri and use `lorri shell` instead of `nix develop`

4. Optional: install direnv, integrate it with your shell and then run

    ```shell-session
    ln -s .envrc.sample .envrc
    ```

    Now `nix develop` or `lorri shell` will be run for you automatically when you `cd` into this directory.