Configuring Environment Variables, Paths, and Prompts in Nushell

For example, place this in your `config.nu` to edit your files in Visual Studio Code: ```nu $env.config.buffer_editor = 'code' ``` ::: ## Common Configuration Tasks in `config.nu`: ::: tip Some users will prefer a "monolithic" configuration file with most or all startup tasks in one place. `config.nu` can be used for this purpose. Other users may prefer a "modular" configuration where each file handles a smaller, more focused set of tasks. Files in the autoload dirs can be used to create this experience. ::: `config.nu` is commonly used to: - Set [environment variables](#set-environment-variables) for Nushell and other applications - Set Nushell settings in [`$env.config`](#nushell-settings-in-the-envconfig-record) - Load modules or source files so that their commands are readily available - Run any other applications or commands at startup ## Set Environment Variables ::: tip See Also The [Environment](./environment.md) Chapter covers additional information on how to set and access environment variables. ::: ### Path Configuration As with most shells, Nushell searches the environment variable named `PATH` (or variants). :::tip Unlike some shells, Nushell attempts to be "case agnostic" with environment variables. `Path`, `path`, `PATH`, and even `pAtH` are all allowed variants of the same environment variable. See [Environment - Case Sensitivity](./environment.md#case-sensitivity) for details. ::: When Nushell is launched, it usually inherits the `PATH` as a string. However, Nushell automatically converts this to a Nushell list for easy access. This means that you can _append_ to the path using, for example: ```nu $env.path ++= ["~/.local/bin"] ``` The Standard Library also includes a helper command. The default `path add` behavior is to _prepend_ a directory so that it has higher precedence than the rest of the path. For example, the following can be added to your startup config: ```nu use std/util "path add" path add "~/.local/bin" path add ($env.CARGO_HOME | path join "bin") ``` ::: tip Notice the use of `path join` in the example above. This command properly joins two path components regardless of whether or not the path separator is present. See `help path` for more commands in this category. ::: ### Prompt Configuration Nushell provides a number of prompt configuration options. By default, Nushell includes: - A prompt which includes the current directory, abbreviated using `~` if it is (or is under) the home directory. - A prompt indicator which appears immediately to the right of the prompt. This defaults to `> ` when in normal editing mode, or a `: ` when in Vi-insert mode. Note extra space after the character to provide separation of the command from the prompt. - A right-prompt with the date and time - An indicator which is displayed when the current commandline extends over multiple lines - `::: ` by default The environment variables which control these prompt components are: - `$env.PROMPT_COMMAND`: The prompt itself - `$env.PROMPT_COMMAND_RIGHT`: A prompt which can appear on the right side of the terminal - `$env.PROMPT_INDICATOR`: Emacs mode indicator - `$env.PROMPT_INDICATOR_VI_NORMAL`: Vi-normal mode indicator - `$env.PROMPT_INDICATOR_VI_INSERT`: Vi-insert mode indicator - `$env.PROMPT_MULTILINE_INDICATOR`: The multi-line indicator Each of these variables accepts either: - A string, in which case the component will be statically displayed as that string. - A closure (with no parameters), in which case the component will be dynamically displayed based on the closure's code. - `null`, in which case the component will revert to its internal default value. ::: tip To disable the right-prompt, for instance, add the following to your startup config: ```nu $env.PROMPT_COMMAND_RIGHT = "" # or $env.PROMPT_COMMAND_RIGHT = {||} ``` ::: #### Transient Prompts Nushell also supports transient prompts, which allow a different prompt to be shown _after_ a commandline has been executed. This can be useful in several situations:

This section discusses common configuration tasks in `config.nu`, including setting environment variables and configuring the `PATH`. It explains how Nushell handles case sensitivity for environment variables and automatically converts the `PATH` to a Nushell list, allowing easy modification. The section also details prompt configuration options, such as `$env.PROMPT_COMMAND`, `$env.PROMPT_COMMAND_RIGHT`, `$env.PROMPT_INDICATOR`, and `$env.PROMPT_MULTILINE_INDICATOR`, allowing customization of the prompt's appearance and behavior. It also introduces transient prompts, which display a different prompt after command execution.