Skip to content

Latest commit

 

History

History
245 lines (182 loc) · 12 KB

options.md

File metadata and controls

245 lines (182 loc) · 12 KB
Raw

Customization Options

Configuring Geometry is just a matter of setting some variables. Below, you'll find a list of all possible options that you can set that will override Geometry appearance and functionality.

Table of Contents

geometry_docker_machine

Show the docker machine name.

Variable Description Default
GEOMETRY_DOCKER_MACHINE_SYMBOL Indicator ⚓
GEOMETRY_DOCKER_MACHINE_COLOR Color of the machine name blue

geometry_exec_time

Show the elapsed time for long running commands.

Variable Description Default
GEOMETRY_EXEC_TIME_PATIENCE Seconds before the time is shown 5

geometry_git

Show git related information, such as branch name, status and time since last commit.

Variable Description Default
GEOMETRY_GIT_GREP Used to override our searching rg > ag > grep
geometry_git_stashes()
Variable Description Default
GEOMETRY_GIT_SYMBOL_STASHES Indicator ●
GEOMETRY_GIT_COLOR_STASHES Color 144
geometry_git_time()
Variable Description Default
GEOMETRY_COLOR_NO_TIME Text color default
GEOMETRY_GIT_NO_COMMITS_MESSAGE Text message shown when there's no commits no-commits
GEOMETRY_GIT_TIME_DETAILED Detailed timestamp instead of simple false
geometry_git_branch()
Variable Description Default
GEOMETRY_GIT_COLOR_BRANCH Color for branch name 242
geometry_git_status()
Variable Description Default
GEOMETRY_GIT_COLOR_DIRTY Color for dirty indicator red
GEOMETRY_GIT_SYMBOL_DIRTY Indicator when dirty ⬡
GEOMETRY_GIT_COLOR_CLEAN Color for clean indicator green
GEOMETRY_GIT_SYMBOL_CLEAN Indicator when clean ⬢
geometry_git_rebase()
Variable Description Default
GEOMETRY_GIT_SYMBOL_REBASE Indicator ®
geometry_git_remote()
Variable Description Default
GEOMETRY_GIT_SYMBOL_UNPUSHED Unpushed indicator ⇡
GEOMETRY_GIT_SYMBOL_UNPULLED Unpulled indicator ⇣
geometry_git_conflicts()
Variable Description Default
GEOMETRY_GIT_COLOR_CONFLICTS_UNSOLVED Unsolved conflicts color red
GEOMETRY_GIT_COLOR_CONFLICTS_SOLVED Solved conflicts color green
GEOMETRY_GIT_SYMBOL_CONFLICTS_SOLVED Solved conflicts indicator ◆
GEOMETRY_GIT_SYMBOL_CONFLICTS_UNSOLVED Unsolved conflicts indicator ◈
geometry_git()
Variable Description Default
GEOMETRY_GIT_COLOR_BARE Color blue
GEOMETRY_GIT_SYMBOL_BARE Indicator ⬢

geometry_hg

Show Mercurial related information, such as branch name, status and time since last commit.

Variable Description Default
GEOMETRY_HG_COLOR_BRANCH Color for branch name 242
GEOMETRY_HG_COLOR_DIRTY Color for dirty indicator red
GEOMETRY_HG_SYMBOL_DIRTY Indicator for dirty repository ⬡
GEOMETRY_HG_COLOR_CLEAN Color for clean indicator green
GEOMETRY_HG_SYMBOL_CLEAN Idicator for clean repository ⬢
GEOMETRY_HG_SYMBOL_SEPARATOR Separator for the indicators ::

geometry_hostname

Shows user and hostname information, by default in the enter prompt.

Variable Description Default
GEOMETRY_HOSTNAME_HIDE_ON Hide the username and hostname when the hostname matches localhost
GEOMETRY_HOSTNAME_SEPARATOR Separator between user and hostname @

geometry_jobs

Shows background jobs, by default in the enter prompt.

Variable Description Default
GEOMETRY_JOBS_SYMBOL Indicator ⚙
GEOMETRY_JOBS_COLOR Indicator color blue

geometry_kube

Show kubectl (Kubernetes) client version and current context/namespace.

Variable Description Defaults
GEOMETRY_KUBE_COLOR Color for the indicator. blue
GEOMETRY_KUBE_SYMBOL Indicator. ⎈
GEOMETRY_KUBE_PIN Can be set to always show geometry_kube.
GEOMETRY_KUBE_VERSION Display k8s Cluster version. true
GEOMETRY_KUBE_CONTEXT_COLOR Color for the k8s context
GEOMETRY_KUBE_NAMESPACE_COLOR Color for the k8s namespace
GEOMETRY_KUBE_SEPARATOR Wrap plugin with a separator `

geometry_node

Show node and npm/yarn version when in a node project context.

Variable Description Default
GEOMETRY_NODE_SYMBOL Indicator ⬡
GEOMETRY_NODE_COLOR Color for the indicator green
GEOMETRY_NODE_PIN Always show geometry_node false

geometry_npm_package_version

Display the current folder's npm package version from package.json (by @drager).

Variable Description Default
GEOMETRY_NPM_PACKAGE_VERSION_SYMBOL Indicator 📦
GEOMETRY_NPM_PACKAGE_VERSION_SYMBOL_COLOR Color for the indicator red
GEOMETRY_NPM_PACKAGE_VERSION_COLOR Text color red

geometry_path

Show the current path.

Variable Description Default
GEOMETRY_PATH_SYMBOL_HOME Symbol representing the home directory. %3~
GEOMETRY_PATH_SHOW_BASENAME - false
GEOMETRY_PATH_COLOR Color for path. blue

geometry_ruby

Display the current ruby version, rvm version, and gemset.

Variable Description Default
GEOMETRY_RUBY_SYMBOL Indicator ◆
GEOMETRY_RUBY_COLOR Indicator color default
GEOMETRY_RUBY_RVM_SHOW_GEMSET Show RVM gemset true

geometry_rust_version

Display the current version of rust (by @drager).

Variable Description Default
GEOMETRY_RUST_VERSION_COLOR Color for version. red

geometry_rustup

Display a symbol colored with the currently selected rustup toolchain.

Variable Description Default
GEOMETRY_RUSTUP_SYMBOL Indicator ⚙
GEOMETRY_RUSTUP_STABLE_COLOR Stable color green
GEOMETRY_RUSTUP_BETA_COLOR Beta color yellow
GEOMETRY_RUSTUP_NIGHTLY_COLOR Nightly color red
GEOMETRY_RUSTUP_PIN Can be setup to keep rustup rendering even out of context false

geometry_status

Show a symbol with error/success and root/non-root information.

Variable Description Default
GEOMETRY_STATUS_SYMBOL Non-root indicator ▲
GEOMETRY_STATUS_SYMBOL_ERROR Non-root indicator on error △
GEOMETRY_STATUS_SYMBOL_ROOT Root indicator ▼
GEOMETRY_STATUS_SYMBOL_ROOT_ERROR root indicator on error ▽
GEOMETRY_STATUS_COLOR Indicator color default
GEOMETRY_STATUS_COLOR_ERROR Indicator color on error red
GEOMETRY_STATUS_SYMBOL_COLOR_HASH Automatically pick a color based on the hostname false
GEOMETRY_STATUS_SYMBOL_COLOR_HASH_COLORS Array of colors to choose from 1..16

geometry_virtualenv

Show the current virtualenv or conda environment.

Variable Description Default
GEOMETRY_VIRTUALENV_CONDA_SEPARATOR Text separator :
GEOMETRY_VIRTUALENV_COLOR Text color green
GEOMETRY_VIRUALENV_CONDA_COLOR Text color green