Skip to content

Commit c88daec

Browse files
authored
docs: warning about environment variables (#4761)
1 parent 2e5e2c8 commit c88daec

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

docs/guides/vscode.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,16 @@ Because the VSCode extension establishes a long-running process connected to the
149149

150150
Therefore, we do not recommend using DuckDB as a state store with the VSCode extension.
151151

152+
### Environment variables
153+
154+
The VSCode extension is based on a [language server](https://en.wikipedia.org/wiki/Language_Server_Protocol) that runs in the background as a separate process. When the VSCode extension starts the background language server, the server inherits environment variables from the environment where you started VSCode. The server does *not* inherit environment variables from your terminal instance in VSCode, so it may not have access to variables you use when calling SQLMesh from the CLI.
155+
156+
If you have environment variables that are needed by the context and the language server, you can use one of these approaches to pass variables to the language server:
157+
158+
- Open VSCode from a terminal that has the variables set
159+
- Use environment variables pulled from somewhere else dynamically (e.g. a `.env` file) in your config
160+
- Set the environment variables in the python environment that the extension uses. You can find detailed instructions [here](https://code.visualstudio.com/docs/python/environments#_environment-variables)
161+
152162
### Python environment woes
153163

154164
The most common problem is the extension not using the correct Python interpreter.

0 commit comments

Comments
 (0)