Skip to content

Add documentation for profile.environment setting #921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
boukeversteegh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add documentation for profile.environment setting #921

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions TerminalDocs/customize-settings/profile-advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,25 @@ This sets the number of lines above the ones displayed in the window you can scr

___

## Environment variables

This sets additional environment variables that will be passed to the process started in the profile. This setting is only available in the [settings.json file](../install.md#settings-json-file) and is not configurable via the settings UI.

**Property name:** `environment`

**Necessity:** Optional

**Accepts:** An object with string keys and values, for example: `"environment": { "VAR_NAME": "value" }`

**Example:** To add environment variables `FOO` and `BAR` to your PowerShell profile, add `"environment": { "FOO": "one", "BAR": "two" }` to that profile.

> [!NOTE]
> When a profile specifies its own `environment`, it completely replaces any environment variables set in the `defaults` section rather than merging with them. Profiles without their own `environment` setting will still inherit from `defaults`.

<br />

___

## Profile termination behavior

This sets how the profile reacts to termination or failure to launch. `"graceful"` will close the profile when `exit` is typed or when the process exits normally. `"always"` will always close the profile and `"never"` will never close the profile. `"automatic"` was added once Windows Terminal was allowed to be the default terminal application; for processes launched in Terminal directly, it behaves the same as `"graceful"` but for processes that were handed off to Terminal it behaves the same as `"always"`.
Expand Down