Skip to content

Commit

Permalink
Direnv document note (#684)
Browse files Browse the repository at this point in the history
## 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
  • Loading branch information
Lagoja committed Feb 24, 2023
1 parent dba0622 commit caa8a4a
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/app/docs/ide_configuration/direnv.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ title: direnv
___
[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.

:::note
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.

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.
:::

### Prerequisites
* Install direnv and hook it to your shell. Follow [this guide](https://direnv.net/#basic-installation) if you haven't done it.

Expand Down Expand Up @@ -38,7 +44,6 @@ direnv: loading ~/src/devbox/docs/.envrc
direnv: using devbox
```


### Global settings for direnv

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.
Expand Down

0 comments on commit caa8a4a

Please sign in to comment.