Skip to content

Commit caa8a4a

Browse files
authored
Direnv document note (#684)
## Summary Add a note to the direnv docs that users may have to regenerate their envrc in 0.4.0 ## How was it tested? Localhost
1 parent dba0622 commit caa8a4a

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/app/docs/ide_configuration/direnv.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ title: direnv
77
___
88
[direnv](https://direnv.net) is an open source environment management tool that allows setting unique environment variables per directory in your file system. This guide covers how to configure direnv to seamlessly work with a devbox project.
99

10+
:::note
11+
Devbox 0.4.0 makes changes to how the environment is sourced in order to ensure better compatibility with the user's host shell. This may raise some errors if you generated your `.envrc` file with an older version of devbox.
12+
13+
If you see any errors when activating your `.envrc` file, you will need to run `devbox generate direnv --force`, and then re-run `devbox shell` to apply the latest changes. Be sure to back up your old `.envrc` file before running this command.
14+
:::
15+
1016
### Prerequisites
1117
* Install direnv and hook it to your shell. Follow [this guide](https://direnv.net/#basic-installation) if you haven't done it.
1218

@@ -38,7 +44,6 @@ direnv: loading ~/src/devbox/docs/.envrc
3844
direnv: using devbox
3945
```
4046

41-
4247
### Global settings for direnv
4348

4449
Note that every time changes are made to `devbox.json` via `devbox add ...`, `devbox rm ...` or directly editing the file, requires `direnv allow` to run so that `direnv` can setup the new changes.

0 commit comments

Comments
 (0)