Skip to content

Commit a5f0f13

Browse files
authored
[docs] update docs to highlight restrictions for direnv integration (#1377)
## Summary Based on conversation in [discord](https://discord.com/channels/903306922852245526/1140685982673416273/1140710781390954606), we want to highlight the restrictions on direnv integration in docs as requested. <img width="1446" alt="Screenshot 2023-08-15 at 2 15 41 PM" src="https://github.com/jetpack-io/devbox/assets/2292093/f3cc16a0-1699-40ef-96d0-4e0dd3016ded"> ## How was it tested? `yarn build` `yarn start`
1 parent f945541 commit a5f0f13

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/app/docs/ide_configuration/direnv.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ___
1111
Devbox 0.5.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.
1212

1313
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+
Direnv only supports modifying environment variables, so your `init_hook` functionality will be restricted. In particular, aliases, functions, and command completions will not work. If you use these, stick with the manual `devbox shell`.
1416
:::
1517

1618
### Prerequisites

0 commit comments

Comments
 (0)