Config Options

General
Features
Thresholds
Marks
Colors

Almost every feature in Liquid Prompt can be turned on or off using these config options. They can either be set before sourcing Liquid Prompt (in .bashrc or .zshrc, or sourcing a preset), or set in a Liquid Prompt config file.

Note

Config variables set in a config file take precedence over variables set in the environment or on the command line. Setting a config option on the command line, then running lp_activate() will overwrite that option with the value from the config file, if it is set there.

The config file is searched for in the following locations:

~/.liquidpromptrc
$XDG_CONFIG_HOME/liquidpromptrc - (if XDG_CONFIG_HOME is not set, ~/.config is used)
$XDG_CONFIG_DIRS/liquidpromptrc - XDG_CONFIG_DIRS is a : delimited array, each value is searched. (if XDG_CONFIG_DIRS is not set, /etc/xdg is used)
/etc/liquidpromptrc

The first file found is sourced.

To get your own configuration, you may want to generate a default configuration by calling the following script:

./tools/config-from-doc.sh > my_liquidpromptrc

Then edit the my_liquidpromptrc file to suits your needs and copy/link it where you want.

In the event that you synchronize your configuration file across multiple computers, or if you have an /etc/liquidpromptrc system-wide from which you’d like to make minor deviations in an individual user account, you can augment the primary config to add in any local modifications using lines such as these:

LOCAL_RCFILE=$HOME/.liquidpromptrc.local
[ -f "$LOCAL_RCFILE" ] && source "$LOCAL_RCFILE"

Note

The example config file does not include every config option, and the comments describing the options are less verbose than the descriptions on this page.

Several example of configurations are given in the contrib/presets directory. Some of these presets can be combined, for instance for changing the icons, along with the colors.

Each config option is documented with its default value. Options of type bool accept values of 1 for true and 0 for false.

General 

LP_MARK_PREFIX: string = " "

String added directly before LP_MARK_DEFAULT, after all other parts of the prompt. Can be used to tag the prompt in a way that is less intrusive than LP_PS1_PREFIX, or add a newline before the prompt mark.

For example:

LP_MARK_PREFIX=$'\n'

LP_PATH_CHARACTER_KEEP: int = 3: The number of characters to save at the start and possibly the end of a directory name when shortening the path. See LP_PATH_METHOD for details of the specific methods.

New in version 2.0.

LP_PATH_DEFAULT: string = ""

Deprecated since version 2.0: Use LP_PATH_METHOD set to truncate_to_last_dir instead.

Used to define the string used for the path. Could be used to make use of shell path shortening features, like %2~ in Zsh to keep the last two directories of the path.

LP_ENABLE_SHORTEN_PATH must be disabled to have any effect.

LP_PATH_KEEP: int = 2

The number of directories (counting ‘/’) to display at the beginning of a shortened path.

Set to 1, will display only root. Set to 0, will keep nothing from the beginning of the path.

LP_ENABLE_SHORTEN_PATH must be enabled to have any effect.

See also: LP_PATH_LENGTH and LP_PATH_METHOD.

Changed in version 2.0: No longer supports a value of -1.

LP_PATH_LENGTH: int = 35

The maximum percentage of the terminal width used to display the path before removing the center portion of the path and replacing with LP_MARK_SHORTEN_PATH.

LP_ENABLE_SHORTEN_PATH must be enabled to have any effect.

Note

LP_PATH_KEEP and LP_PATH_METHOD have higher precedence over this option. Important path parts, including directories saved by LP_PATH_KEEP, LP_PATH_VCS_ROOT, and the last directory, will always be displayed, even if the path does not fit in the maximum length.

LP_PATH_METHOD: string = "truncate_chars_from_path_left"

Sets the method used for shortening the path display when it exceeds the maximum length set by LP_PATH_LENGTH.

truncate_chars_from_path_left: Truncates characters from the start of the path, showing consecutive directories as one shortened section. E.g. in a directory named ~/MyProjects/liquidprompt/tests, it will be shortened to ...prompt/tests. The shortened mark is LP_MARK_SHORTEN_PATH.
truncate_chars_from_dir_right: Leaves the beginning of a directory name untouched. E.g. directories will be shortened like so: ~/Doc.../Office. How many characters will be untouched is set by LP_PATH_CHARACTER_KEEP. The shortened mark is LP_MARK_SHORTEN_PATH.
truncate_chars_from_dir_middle: Leaves the beginning and end of a directory name untouched. E.g. in a directory named ~/MyProjects/Office, then it will be shortened to ~/MyP...cts/Office. How many characters will be untouched is set by LP_PATH_CHARACTER_KEEP. The shortened mark is LP_MARK_SHORTEN_PATH.
truncate_chars_to_unique_dir: Truncate each directory to the shortest unique starting portion of their name. E.g. in a folder ~/dev/liquidprompt, it will be shortened to ~/d/liquidprompt if there is no other directory starting with ‘d’ in the home directory.
truncate_to_last_dir: Only display the last directory in the path. In other words, the current directory name.

All methods (other than truncate_to_last_dir) start at the far left of the path (limited by LP_PATH_KEEP). Only the minimum number of directories needed to fit inside LP_PATH_LENGTH will be shortened.

LP_ENABLE_SHORTEN_PATH must be enabled to have any effect.

New in version 2.0.

LP_PATH_VCS_ROOT: bool = 1: Display the root directory of the current VCS repository with special formatting, set by LP_COLOR_PATH_VCS_ROOT. If LP_ENABLE_SHORTEN_PATH is enabled, also prevent the path shortening from shortening or hiding the VCS root directory.

New in version 2.0.

LP_PS1_POSTFIX: string = "": A string displayed at the very end of the prompt, after even the prompt mark. LP_MARK_PREFIX is an alternative that goes before the prompt mark.

LP_PS1_PREFIX: string = "": A string displayed at the start of the prompt. Can also be set with prompt_tag().

LP_TIME_FORMAT: string = "%H:%M:%S"

The formatting string passed to date(1) using formatting from strftime(3) used to display the current date and/or time.

Features 

LP_ALWAYS_DISPLAY_VALUES: bool = 1

Display the actual values of load, batteries, and wifi signal strength along with their corresponding marks. Disable to only print the colored marks.

LP_DELIMITER_KUBECONTEXT_PREFIX: string = ""

Delimiter to shorten the Kubernetes context by removing a prefix.

Usage example:

if your context names are cluster-dev and cluster-test, then set this to “-” in order to output dev and test in prompt.
if using AWS EKS then set this to “/” to show only the cluster name, without the rest of the ARN (arn:aws:eks:$AWS_REGION:$ACCOUNT_ID:cluster/$CLUSTER_NAME)
alternatively, if using AWS EKS, set this to “:” to show only cluster/$CLUSTER_NAME. (Note: the prefix removed is a greedy match - it contains all the “:”s in the input.)

If set to the empty string no truncating will occur (this is the default).

New in version 2.1.

LP_DELIMITER_KUBECONTEXT_SUFFIX: string = ""

Delimiter to shorten the Kubernetes context by removing a suffix.

Usage example:

if your context names are dev-cluster and test-cluster, then set this to “-” in order to output dev and test in prompt.
if your context names are dev.k8s.example.com and test.k8s.example.com, then set this to “.” in order to output dev and test in prompt. (Note: the suffix removed is a greedy match - it contains all the “.”s in the input.)
if using OpenShift then set this to “/” to show only the project name without the cluster and user parts.

If set to the empty string no truncating will occur (this is the default).

New in version 2.1.

LP_DISABLED_VCS_PATH: string = "": Deprecated since version 2.0: Use LP_DISABLED_VCS_PATHS instead.

An colon (:) separated list of absolute directory paths where VCS features will be disabled. See LP_DISABLED_VCS_PATHS for more information.

LP_DISABLED_VCS_PATHS: array<string> = ()

An array of absolute directory paths where VCS features will be disabled. Generally this would be used for repositories that are large and slow, where generating VCS information for the prompt would impact prompt responsiveness.

Any subdirectory under the input directory is also disabled, so setting /repos would disable VCS display when the current directory is /repos/a-repo. Setting ("/") would disable VCS display completely.

An example value would be:

LP_DISABLED_VCS_PATHS=("/a/svn/repo" "/home/me/my/large/repo")

See also: LP_HOSTNAME_ALWAYS.

LP_ENABLE_GIT: bool = 1

Display VCS information inside Git repositories.

Will be disabled if git is not found.

See also: LP_HOSTNAME_ALWAYS.

LP_ENABLE_SUDO: bool = 0

Check if the user has valid sudo credentials, and display an indicating mark or color.

Will be disabled if sudo is not found.

Warning

Each evocation of sudo by default writes to the syslog, and this will run sudo once each prompt, unless you have NOPASSWD powers. This is likely to make your sysadmin hate you.

See also: LP_HOSTNAME_ALWAYS.

New in version 2.1.

LP_PERCENTS_ALWAYS: bool = 1

Deprecated since version 2.2: Use LP_ALWAYS_DISPLAY_VALUES and LP_DISPLAY_VALUES_AS_PERCENTS instead.

Display the actual values of load, batteries, and wifi signal strength along with their corresponding marks. Disable to only print the colored marks.

LP_RUBY_RVM_PROMPT_OPTIONS: array<string> = (i v g s)

An array of single letter switches to customize the RVM prompt output.

Will only have an effect if LP_ENABLE_RUBY_VENV is enabled and you are using RVM (i.e. no effect with RBENV).

New in version 2.1.

LP_TEMP_SYSFS_IGNORE_FILES: array<string> = ()

Paths to files in the sysfs interface that should be ignored when reading temperature sensors. A path can include globs.

Thresholds 

LP_BATTERY_THRESHOLD: int = 75

The percentage threshold that the battery level needs to fall below before it will be displayed in LP_COLOR_CHARGING_UNDER or LP_COLOR_DISCHARGING_UNDER color. Otherwise, it will be displayed in LP_COLOR_CHARGING_ABOVE or LP_COLOR_DISCHARGING_ABOVE color.

LP_ENABLE_BATT must be enabled to have any effect.

LP_DISK_PRECISION: int = 2

Control the numbers of decimals when displaying the absolute available space of the current hard drive. If set to 0, don’t display decimals. If set to 1 or 2, display decimals.

See LP_ENABLE_DISK, LP_ALWAYS_DISPLAY_VALUES, and LP_DISPLAY_VALUES_AS_PERCENTS.

New in version 2.2.

LP_DISK_THRESHOLD: int = 100000

Display something if the available space on the hard drive hosting the current directory goes below this absolute threshold in kilobytes.

The threshold for disk can also be set with LP_DISK_THRESHOLD_PERC, the first one to be reached triggering the display.

Marks 

LP_MARK_ADAPTER: string = "⏚"

Mark used for battery display when charging.

See also: LP_ENABLE_BATT.

LP_MARK_BATTERY: string = "⌁"

Mark used for battery display when on battery power.

See also: LP_ENABLE_BATT.

LP_MARK_BRACKET_CLOSE: string = "]"

Mark used for closing core prompt brackets. Used by the default theme for enclosing user, host, and current working directory sections.

Changed in version 2.2: Can be disabled by LP_ENABLE_MULTIPLEXER.

LP_MARK_BRACKET_OPEN: string = "["

Mark used for opening core prompt brackets. Used by the default theme for enclosing user, host, and current working directory sections.

Changed in version 2.2: Can be disabled by LP_ENABLE_MULTIPLEXER.

LP_MARK_BZR: string = "⚯"

Mark used instead of LP_MARK_DEFAULT to indicate that the current directory is inside of a Bazaar repository.

See also:

LP_ENABLE_ENV_VARS
LP_ENV_VARS
LP_MARK_ENV_VARS_SEP
LP_MARK_ENV_VARS_CLOSE
LP_COLOR_ENV_VARS_SET
LP_COLOR_ENV_VARS_UNSET

New in version 2.2.

LP_MARK_ENV_VARS_SEP: string = " "

Mark used to separate items of the user-defined environment variables watch list.

See also:

LP_ENABLE_ENV_VARS
LP_ENV_VARS
LP_MARK_ENV_VARS_OPEN
LP_MARK_ENV_VARS_CLOSE
LP_COLOR_ENV_VARS_SET
LP_COLOR_ENV_VARS_UNSET

New in version 2.2.

LP_MARK_ENV_VARS_CLOSE: string = ")"

Mark used to end the user-defined environment variables watch list.

See also:

LP_ENABLE_ENV_VARS
LP_ENV_VARS
LP_MARK_ENV_VARS_OPEN
LP_MARK_ENV_VARS_SEP
LP_COLOR_ENV_VARS_SET
LP_COLOR_ENV_VARS_UNSET

New in version 2.2.

LP_MARK_FOSSIL: string = "⌘"

Mark used instead of LP_MARK_DEFAULT to indicate that the current directory is inside of a Fossil repository.

See also: LP_ENABLE_MODULES.

LP_MARK_MODULES_CLOSE: string = ""

Mark used after displaying loaded modules.

See also: LP_ENABLE_MODULES.

LP_MARK_MODULES_SEP: string = ":"

Mark used between loaded modules.

See also: LP_ENABLE_MODULES.

LP_MARK_MULTIPLEXER_CLOSE: string = $LP_MARK_BRACKET_CLOSE

Mark used for closing core prompt brackets. Used by the default theme when inside of a multiplexer.

New in version 2.1.

Changed in version 2.2: Can be disabled by LP_ENABLE_MULTIPLEXER.

LP_MARK_MULTIPLEXER_OPEN: string = $LP_MARK_BRACKET_OPEN

Mark used for opening core prompt brackets. Used by the default theme when inside of a multiplexer.

New in version 2.1.

Changed in version 2.2: Can be disabled by LP_ENABLE_MULTIPLEXER.

LP_MARK_OS: array<string> = ()

A list of pair of strings to be replaced by another string when displaying information about the OS.

Each pair in the list configures the match, then the replacement string.

For instance, if you set LP_MARK_OS=("Linux" "L") and LP_ENABLE_OS=1 ; LP_ENABLE_OS_FAMILY=1, then any occurrence of “Linux” will be replaced by an “L” in the OS section.

It is possible to use presets colors in the replacement string (see the Colors section below). Note that if a replacement occurs, the result will not be colored automatically.

For example, to shorten known names, you can use the following configuration (if your font supports those characters):

LP_MARK_OS=(
    # Arch
    "x86_64"    "${BLUE}x64${NO_COL}"
    "i386"      "i3"
    "i686"      "i6"
    "aarch64"   "${GREEN}a64${NO_COL}"
    # Families
    "BSD"       "${RED}BSD${NO_COL}"
    "Windows"   "🪟"
    "Unix"      "U"
    "GNU"       "🐮"
    # Kernels
    "FreeBSD"   "👹"
    "DragonFly" "🦋"
    "OpenBSD"   "🐡"
    "Darwin"    "🍎"
    "SunOS"     "${BOLD_YELLOW}☀${NO_COL}"
    "Cygwin"    "🦢"
    "MSYS"      "M"
    "MinGW"     "GW"
    "Linux"     "🐧"
)

See LP_ENABLE_OS.

New in version 2.2.

LP_MARK_OS_SEP: string = "/"

The character used to separate items of the OS section.

See LP_ENABLE_OS.

New in version 2.2.

LP_MARK_PERM: string = ":"

Mark used by default separate hostname and current working directory, and is colored to indicate user permissions on the current directory.

Is still used (without colors) if LP_ENABLE_PERM is disabled.

New in version 1.12.

LP_MARK_PROXY: string = "↥"

Mark used to indicate a proxy is active.

Colors 

These color strings will be used without modification, so they need to be valid terminal escape sequences, either generated with lp_terminal_format() or using the $COLOR variables.

Valid preset color variables are:

BOLD - bold formatting only.
BLACK
BOLD_GRAY - actually bold black
RED
BOLD_RED
GREEN
BOLD_GREEN
YELLOW
BOLD_YELLOW
BLUE
BOLD_BLUE
PURPLE or MAGENTA
BOLD_PURPLE, BOLD_MAGENTA or PINK
CYAN
BOLD_CYAN
WHITE
BOLD_WHITE
WARN_RED - black foreground, red background
CRIT_RED - white foreground, red background
DANGER_RED - yellow foreground, red background

LP_COLORMAP: array<string> = ( "" $GREEN $BOLD_GREEN $YELLOW $BOLD_YELLOW $RED $BOLD_RED $WARN_RED $CRIT_RED $DANGER_RED )

An array of colors that is used by the battery, load, temperature, and wireless signal strength features to indicate the severity level of their status. A normal or low status will use the first index, while the last index is the most severe.

LP_COLOR_AWS_PROFILE: string = $YELLOW

Color used to display the current active AWS Profile.

See also: LP_ENABLE_BATT.

LP_COLOR_CHARGING_UNDER: string = $YELLOW

Color used to indicate that the battery is charging and under the LP_BATTERY_THRESHOLD.

See also: LP_ENABLE_BATT.

LP_COLOR_CMAKE_BUILD: string = $MAGENTA

Color used to display the build type in the CMake segment.

See LP_ENABLE_CMAKE.

New in version 2.2.

LP_COLOR_CMAKE_C: string = $MAGENTA

Color used to display the C compiler in the CMake segment.

See LP_ENABLE_CMAKE.

New in version 2.2.

LP_COLOR_CMAKE_CXX: string = $MAGENTA

Color used to display the C++ compiler in the CMake segment.

See LP_ENABLE_CMAKE.

New in version 2.2.

LP_COLOR_CMAKE_DEBUG: string = $MAGENTA

Color for the Debug build type of the CMake section.

New in version 2.2.

LP_COLOR_CMAKE_RWDI: string = $BLUE

Color for the RelWithDebInfo build type of the CMake section.

New in version 2.2.

LP_COLOR_CMAKE_RELEASE: string = $CYAN

Color for the Release build type of the CMake section.

New in version 2.2.

LP_COLOR_COMMITS_BEHIND: string = $BOLD_RED

Color used to indicate that the current repository has a remote tracking branch that has commits that the local branch does not.

May be used by LP_ENABLE_VCS_REMOTE.

LP_COLOR_COMMITS: string = $YELLOW

Color used to indicate that the current repository has commits on the local branch that the remote tracking branch does not.

Also used to color LP_MARK_STASH and LP_MARK_VCS_REMOTE.

LP_COLOR_CONTAINER: string = $BOLD_BLUE: Color used to indicate that the current shell is running in a container.

New in version 2.1.

LP_COLOR_DIFF: string = $PURPLE: Color used to indicate that the current repository has lines that have been changed since the last commit.

LP_COLOR_DIRSTACK: string = $BOLD_YELLOW

Color used to indicate the size of the directory stack.

New in version 2.0.

LP_COLOR_DISCHARGING_ABOVE: string = $YELLOW

Color used to indicate that the battery is discharging and above the LP_BATTERY_THRESHOLD.

See also: LP_ENABLE_BATT.

LP_COLOR_DISCHARGING_UNDER: string = $RED

Color used to indicate that the battery is discharging and above the LP_BATTERY_THRESHOLD.

See also: LP_ENABLE_BATT.

LP_COLOR_DISK: string = $BOLD_RED

Color used for displaying information about the hard drive hosting the current directory.

New in version 2.2.

LP_COLOR_DISK_UNITS: string = $RED

Color used for displaying the unit of the available space on the hard drive hosting the current directory.

New in version 2.2.

LP_COLOR_ERR: string = $PURPLE

Color used to indicate the last command exited with a non-zero return code.

See also:

LP_ENABLE_ENV_VARS
LP_ENV_VARS
LP_COLOR_ENV_VARS_SET
LP_MARK_ENV_VARS_OPEN
LP_MARK_ENV_VARS_SEP
LP_MARK_ENV_VARS_CLOSE

New in version 2.2.

LP_COLOR_HOST: string = ""

Color used for the hostname when connected locally.

See also: LP_HOSTNAME_ALWAYS.

LP_COLOR_IN_MULTIPLEXER: string = $BOLD_BLUE: Color used for LP_MARK_MULTIPLEXER_OPEN and LP_MARK_MULTIPLEXER_CLOSE if the terminal is in a multiplexer.

Changed in version 2.2: Can be disabled by LP_ENABLE_MULTIPLEXER.

LP_COLOR_JOB_D: string = $YELLOW

Color used for detached multiplexer sessions.

LP_COLOR_JOB_R: string = $BOLD_YELLOW

Color used for running shell jobs.

See also: LP_ENABLE_MODULES.

LP_COLOR_NODE_VENV: string = $LP_COLOR_VIRTUALENV

Color used for displaying a Node.js virtual environment.

See also: LP_HOSTNAME_ALWAYS.

LP_COLOR_SU: string = $BOLD_YELLOW

Color used for displaying the hostname when running under su or sudo.

See also: LP_HOSTNAME_ALWAYS.

LP_COLOR_TELNET: string = $WARN_RED

Color used for displaying the hostname when connected with Telnet.

See also: LP_HOSTNAME_ALWAYS.

LP_COLOR_TERRAFORM: string = $PINK

Color used for displaying a Terraform workspace.

Config Options

General

Features

Thresholds

Marks

Colors

General 

Features 

Thresholds 

Marks 

Colors 