We recommend using the[Nix](https://nix.dev/) package manager as it makes any pain related to maintaining dependency versions[just disappear](https://twitter.com/mitchellh/status/1491102567296040961). Once nix[has been installed](https://nixos.org/download.html) the development environment can be_manually instantiated_ through the`nix-shell` command:

cd~/code/coder

nix-shell

...

copying path'/nix/store/3ms6cs5210n8vfb5a7jkdvzrzdagqzbp-iana-etc-20210225' from'https://cache.nixos.org'...

If[direnv](https://direnv.net/) is installed and the[hooks are configured](https://direnv.net/docs/hook.html) then the development environment can be_automatically instantiated_ by creating the following`.envrc`, thus removing the need to run`nix-shell` by hand!

cd~/code/coder

echo"use nix">.envrc

direnv allow

Now, whenever you enter the project folder,`direnv` will prepare the environment for you:

Now, whenever you enter the project folder,[`direnv`](https://direnv.net/docs/hook.html) will prepare the environment for you:

cd~/code/coder

direnv: loading~/code/coder/.envrc

direnv: using nix

direnv:export +AR +AS +CC +CONFIG_SHELL +CXX +HOST_PATH +IN_NIX_SHELL +LD +NIX_BINTOOLS +NIX_BINTOOLS_WRAPPER_TARGET_HOST_x86_64_unknown_linux_gnu +NIX_BUILD_CORES +NIX_BUILD_TOP +NIX_CC +NIX_CC_WRAPPER_TARGET_HOST_x86_64_unknown_linux_gnu +NIX_CFLAGS_COMPILE +NIX_ENFORCE_NO_NATIVE +NIX_HARDENING_ENABLE +NIX_INDENT_MAKE +NIX_LDFLAGS +NIX_STORE +NM +NODE_PATH +OBJCOPY +OBJDUMP +RANLIB +READELF +SIZE +SOURCE_DATE_EPOCH +STRINGS +STRIP +TEMP +TEMPDIR +TMP +TMPDIR +XDG_DATA_DIRS +buildInputs +buildPhase +builder +cmakeFlags +configureFlags +depsBuildBuild +depsBuildBuildPropagated +depsBuildTarget +depsBuildTargetPropagated +depsHostHost +depsHostHostPropagated +depsTargetTarget +depsTargetTargetPropagated +doCheck +doInstallCheck +mesonFlags +name +nativeBuildInputs +out +outputs +patches +phases +propagatedBuildInputs +propagatedNativeBuildInputs +shell +shellHook +stdenv +strictDeps +system~PATH

- on macOS, run`brew install libpq zstd`

- on Linux, install[`zstd`](https://github.com/horta/zstd.install)

- on macOS, run`brew install pkg-config`

- on macOS, run`brew install pixman`

- on macOS, run`brew install cairo`

- on macOS, run`brew install pango`

- on macOS, run`brew install pandocomatic`

To add new migrations, use the following command:

./coderd/database/migrations/create_fixture.sh my name

/home/coder/src/coder/coderd/database/migrations/000070_my_name.up.sql

/home/coder/src/coder/coderd/database/migrations/000070_my_name.down.sql

Run "make gen" to generate models.

Then write queries into the generated`.up.sql` and`.down.sql` files and commit

them into the repository. The down script should make a best-effort to retain as

much data as possible.

To add a new partial fixture, run the following command:

./coderd/database/migrations/create_fixture.sh my fixture

/home/coder/src/coder/coderd/database/migrations/testdata/fixtures/000070_my_fixture.up.sql

generate data in the database. Then shut down the deployment and take a snapshot

of the database.

mkdir -p coderd/database/migrations/testdata/full_dumps/v0.12.2&&cd$_

pg_dump"postgres://coder@localhost:..." -a --inserts>000069_dump_v0.12.2.up.sql

Make sure sensitive data in the dump is desensitized, for instance names,

To find out what the latest migration for a version of Coder is, use the

following command:

git ls-files v0.12.2 -- coderd/database/migrations/*.up.sql

This helps in naming the dump (e.g.`000069` above).