🕷️ Crawler Inspector

URL Lookup

Direct Parameter Lookup

Raw Queries and Responses

1. Shard Calculation

Query:

Response:

Calculated Shard: 110 (from laksa067)

2. Crawled Status Check

Query:

curl -X POST \
  'http://laksa110.int.ahrefs:8124/' \
  -H 'Content-Type: text/plain' \
  -H 'X-ClickHouse-Database: crawler3' \
  -H 'Authorization: Basic YXBpOg==' \
  -d 'SELECT getAhrefsURLFromUnparsed(src_unparsed) AS found_url, ifNull(toUnixTimestamp(download_stamp), 0) AS crawl_time, ifNull(toUnixTimestamp(props_url_first_seen), 0) AS first_indexed_time, download_http_code AS http_code, src_unparsed AS src_unparsed, src_root_hash AS src_root_hash, history_drop_reason AS history_drop_reason, meta_title AS meta_title, meta_descriptions AS meta_descriptions, attrs_boilerpipe_text AS attrs_boilerpipe_text, attrs_markdown AS attrs_markdown, attrs_readable_markdown AS attrs_readable_markdown, meta_canonical AS meta_canonical FROM crawler3.page_info_local FINAL PREWHERE (src_root_hash, src_unparsed) IN ((getAhrefsRootHashFromUnparsed(getAhrefsUnparsedNoserviceFromURL(\'https://starship.rs/config/\')), getAhrefsUnparsedNoserviceFromURL(\'https://starship.rs/config/\'))) FORMAT JSONEachRow'

Response:

{"found_url":"https:\/\/starship.rs\/config\/","crawl_time":1775771950,"first_indexed_time":1563840546,"http_code":200,"src_unparsed":"rs,starship!\/config\/ s443","src_root_hash":"10819465806357049510","history_drop_reason":null,"meta_title":"Configuration | Starship","meta_descriptions":["The minimal, blazing-fast, and infinitely customizable prompt for any shell!"],"attrs_boilerpipe_text":"Configuration\n\nTo get started configuring starship, create the following file:\n~\/.config\/starship.toml\n.\nsh\nmkdir\n-p\n~\/.config\n&&\ntouch\n~\/.config\/starship.toml\nAll configuration for starship is done in this\nTOML\nfile:\ntoml\n# Get editor completions based on the config schema\n\"$schema\" =\n'https:\/\/starship.rs\/config-schema.json'\n# Inserts a blank line between shell prompts\nadd_newline =\ntrue\n# Replace the '❯' symbol in the prompt with '➜'\n[\ncharacter\n]\n# The name of the module we are configuring is 'character'\nsuccess_symbol =\n'[➜](bold green)'\n# The 'success_symbol' segment is being set to '➜' with the color 'bold green'\n# Disable the package module, hiding it from the prompt completely\n[\npackage\n]\ndisabled =\ntrue\nConfig File Location\n\nYou can change default configuration file location with\nSTARSHIP_CONFIG\nenvironment variable:\nsh\nexport\nSTARSHIP_CONFIG\n=~\n\/example\/non\/default\/path\/starship.toml\nEquivalently in PowerShell (Windows) would be adding this line to your\n$PROFILE\n:\npowershell\n$\nENV:\nSTARSHIP_CONFIG\n=\n\"\n$HOME\n\\example\\non\\default\\path\\starship.toml\"\nOr for Cmd (Windows) would be adding this line to your\nstarship.lua\n:\nlua\nos.\nsetenv\n(\n'STARSHIP_CONFIG'\n,\n'C:\n\\\\\nUsers\n\\\\\nuser\n\\\\\nexample\n\\\\\nnon\n\\\\\ndefault\n\\\\\npath\n\\\\\nstarship.toml'\n)\nLogging\n\nBy default starship logs warnings and errors into a file named\n~\/.cache\/starship\/session_${STARSHIP_SESSION_KEY}.log\n, where the session key is corresponding to an instance of your terminal. This, however can be changed using the\nSTARSHIP_CACHE\nenvironment variable:\nsh\nexport\nSTARSHIP_CACHE\n=~\n\/.starship\/cache\nEquivalently in PowerShell (Windows) would be adding this line to your\n$PROFILE\n:\npowershell\n$\nENV:\nSTARSHIP_CACHE\n=\n\"\n$HOME\n\\AppData\\Local\\Temp\"\nOr for Cmd (Windows) would be adding this line to your\nstarship.lua\n:\nlua\nos.\nsetenv\n(\n'STARSHIP_CACHE'\n,\n'C:\n\\\\\nUsers\n\\\\\nuser\n\\\\\nAppData\n\\\\\nLocal\n\\\\\nTemp'\n)\nTerminology\n\nModule\n: A component in the prompt giving information based on contextual information from your OS. For example, the \"nodejs\" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project.\nVariable\n: Smaller sub-components that contain information provided by the module. For example, the \"version\" variable in the \"nodejs\" module contains the current version of Node.js.\nBy convention, most modules have a prefix of default terminal color (e.g.\nvia\nin \"nodejs\") and an empty space as a suffix.\nStrings\n\nIn TOML syntax,\ntext values\nare declared with\n'\n,\n\"\n,\n'''\n, or\n\"\"\"\n.\nThe following Starship syntax symbols have special usage in a format string and must be escaped to display as that character:\n$ [ ] ( )\n.\nSymbol\nType\nNotes\n'\nliteral string\nless escaping\n\"\nstring\nmore escaping\n'''\nmulti-line literal string\nless escaping\n\"\"\"\nmulti-line string\nmore escaping, newlines in declarations can be ignored\nFor example:\ntoml\n# literal string\nformat =\n'☺\\☻ '\n# regular string\nformat =\n\"☺\n\\\\\n☻ \"\n# escaping Starship symbols\nformat =\n'\\[\\$\\] '\nWhen using line breaks, multi-line declarations can be used. For example, if you want to print a\n$\nsymbol on a new line, the following values for\nformat\nare equivalent:\ntoml\n# with literal string\nformat =\n'''\n\\$'''\n# with multiline basic string\nformat =\n\"\"\"\n\\\\\n$\"\"\"\n# with basic string\nformat =\n\"\n\\n\\\\\n$\"\nIn multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.\ntoml\nformat =\n\"\"\"\nline1\\\nline1\\\nline1\nline2\\\nline2\\\nline2\n\"\"\"\nFormat Strings\n\nFormat strings are the format that a module prints all its variables with. Most modules have an entry called\nformat\nthat configures the display format of the module. You can use texts, variables and text groups in a format string.\nVariable\n\nA variable contains a\n$\nsymbol followed by the name of the variable. The name of a variable can only contain letters, numbers and\n_\n.\nFor example:\n'$version'\nis a format string with a variable named\nversion\n.\n'$git_branch$git_commit'\nis a format string with two variables named\ngit_branch\nand\ngit_commit\n.\n'$git_branch $git_commit'\nhas the two variables separated with a space.\nText Group\n\nA text group is made up of two different parts.\nThe first part, which is enclosed in a\n[]\n, is a\nformat string\n. You can add texts, variables, or even nested text groups in it.\nIn the second part, which is enclosed in a\n()\n, is a\nstyle string\n. This can be used to style the first part.\nFor example:\n'[on](red bold)'\nwill print a string\non\nwith bold text colored red.\n'[⌘ $version](bold green)'\nwill print a symbol\n⌘\nfollowed by the content of variable\nversion\n, with bold text colored green.\n'[a [b](red) c](green)'\nwill print\na b c\nwith\nb\nred, and\na\nand\nc\ngreen.\nStyle Strings\n\nMost modules in starship allow you to configure their display styles. This is done with an entry (usually called\nstyle\n) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the\nadvanced config guide\n.\n'fg:green bg:blue'\nsets green text on a blue background\n'bg:blue fg:bright-green'\nsets bright green text on a blue background\n'bold fg:27'\nsets bold text with\nANSI color\n27\n'underline bg:#bf5700'\nsets underlined text on a burnt orange background\n'bold italic fg:purple'\nsets bold italic purple text\n''\nexplicitly disables all styling\nNote that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.\nConditional Format Strings\n\nA conditional format string wrapped in\n(\nand\n)\nwill not render if all variables inside are empty.\nFor example:\n'(@$region)'\nwill show nothing if the variable\nregion\nis\nNone\nor empty string, otherwise\n@\nfollowed by the value of region.\n'(some text)'\nwill always show nothing since there are no variables wrapped in the braces.\nWhen\n$combined\nis a shortcut for\n\\[$a$b\\]\n,\n'($combined)'\nwill show nothing only if\n$a\nand\n$b\nare both\nNone\n. This works the same as\n'(\\[$a$b\\] )'\n.\nNegative matching\n\nMany modules have\ndetect_extensions\n,\ndetect_files\n, and\ndetect_folders\nvariables. These take lists of strings to match or not match. \"Negative\" options, those which should not be matched, are indicated with a leading '!' character. The presence of\nany\nnegative indicator in the directory will result in the module not being matched.\nExtensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example,\nfoo.bar.tar.gz\nwill be matched against\nbar.tar.gz\nand\ngz\nin the\ndetect_extensions\nvariable. Files whose name begins with a dot are not considered to have extensions at all.\nTo see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:\ntoml\ndetect_extensions = [\n'ts'\n,\n'!video.ts'\n,\n'!audio.ts'\n]\nThis is the list of prompt-wide configuration options.\nOptions\n\nOption\nDefault\nDescription\nformat\nlink\nConfigure the format of the prompt.\nright_format\n''\nSee\nEnable Right Prompt\nscan_timeout\n30\nTimeout for starship to scan files (in milliseconds).\ncommand_timeout\n500\nTimeout for commands executed by starship (in milliseconds).\nadd_newline\ntrue\nInserts blank line between shell prompts.\npalette\n''\nSets which color palette from\npalettes\nto use.\npalettes\n{}\nCollection of color palettes that assign\ncolors\nto user-defined names. Note that color palettes cannot reference their own color definitions.\nfollow_symlinks\ntrue\nFollows symlinks to check if they're directories; used in modules such as git.\nTIP\nIf you have symlinks to networked filesystems, consider setting\nfollow_symlinks\nto\nfalse\n.\nExample\n\ntoml\n# ~\/.config\/starship.toml\n# Use custom format\nformat =\n'''\n[┌───────────────────>](bold green)\n[│](bold green)$directory$rust$package\n[└─>](bold green) '''\n# Wait 10 milliseconds for starship to check files under the current directory.\nscan_timeout =\n10\n# Disable the blank line at the start of the prompt\nadd_newline =\nfalse\n# Set 'foo' as custom color palette\npalette =\n'foo'\n# Define custom colors\n[\npalettes\n.\nfoo\n]\n# Overwrite existing color\nblue =\n'21'\n# Define new color\nmustard =\n'#af8700'\nDefault Prompt Format\n\nThe default\nformat\nis used to define the format of the prompt, if empty or no\nformat\nis provided. The default is as shown:\ntoml\nformat =\n'$all'\n# Which is equivalent to\nformat =\n\"\"\"\n$username\\\n$hostname\\\n$localip\\\n$shlvl\\\n$singularity\\\n$kubernetes\\\n$directory\\\n$vcsh\\\n$fossil_branch\\\n$fossil_metrics\\\n$git_branch\\\n$git_commit\\\n$git_state\\\n$git_metrics\\\n$git_status\\\n$hg_branch\\\n$hg_state\\\n$pijul_channel\\\n$docker_context\\\n$package\\\n$c\\\n$cmake\\\n$cobol\\\n$daml\\\n$dart\\\n$deno\\\n$dotnet\\\n$elixir\\\n$elm\\\n$erlang\\\n$fennel\\\n$fortran\\\n$gleam\\\n$golang\\\n$guix_shell\\\n$haskell\\\n$haxe\\\n$helm\\\n$java\\\n$julia\\\n$kotlin\\\n$gradle\\\n$lua\\\n$nim\\\n$nodejs\\\n$ocaml\\\n$opa\\\n$perl\\\n$php\\\n$pulumi\\\n$purescript\\\n$python\\\n$quarto\\\n$raku\\\n$rlang\\\n$red\\\n$ruby\\\n$rust\\\n$scala\\\n$solidity\\\n$swift\\\n$terraform\\\n$typst\\\n$vlang\\\n$vagrant\\\n$zig\\\n$buf\\\n$nix_shell\\\n$conda\\\n$meson\\\n$spack\\\n$memory_usage\\\n$aws\\\n$gcloud\\\n$openstack\\\n$azure\\\n$nats\\\n$direnv\\\n$env_var\\\n$mise\\\n$crystal\\\n$custom\\\n$sudo\\\n$cmd_duration\\\n$line_break\\\n$jobs\\\n$battery\\\n$time\\\n$status\\\n$os\\\n$container\\\n$netns\\\n$shell\\\n$character\"\"\"\nIf you just want to extend the default format, you can use\n$all\n; modules you explicitly add to the format will not be duplicated. Eg.\ntoml\n# Move the directory to the second line\nformat =\n'$all$directory$character'\nAWS\n\nThe\naws\nmodule shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the\nAWS_REGION\n,\nAWS_DEFAULT_REGION\n, and\nAWS_PROFILE\nenv vars and the\n~\/.aws\/config\nand\n~\/.aws\/credentials\nfiles as required.\nThe module will display a profile only if its credentials are present in\n~\/.aws\/credentials\nor if a\ncredential_process\n,\nsso_start_url\n, or\nsso_session\nare defined in\n~\/.aws\/config\n. Alternatively, having any of the\nAWS_ACCESS_KEY_ID\n,\nAWS_SECRET_ACCESS_KEY\n, or\nAWS_SESSION_TOKEN\nenv vars defined will also suffice. If the option\nforce_display\nis set to\ntrue\n, all available information will be displayed even if no credentials per the conditions above are detected.\nWhen using\naws-vault\nthe profile is read from the\nAWS_VAULT\nenv var and the credentials expiration date is read from the\nAWS_SESSION_EXPIRATION\nenv var.\nWhen using\nawsu\nthe profile is read from the\nAWSU_PROFILE\nenv var.\nWhen using\nAWSume\nthe profile is read from the\nAWSUME_PROFILE\nenv var and the credentials expiration date is read from the\nAWSUME_EXPIRATION\nenv var.\nWhen using\nsaml2aws\nthe expiration information obtained from\n~\/.aws\/credentials\nfalls back to the\nx_security_token_expires\nkey.\nWhen using\naws-sso-cli\nthe profile is read from the\nAWS_SSO_PROFILE\nenv var.\nOptions\n\nOption\nDefault\nDescription\nformat\n'on [$symbol($profile )(\$$region\$ )(\\[$duration\\] )]($style)'\nThe format for the module.\nsymbol\n'☁️ '\nThe symbol used before displaying the current AWS profile.\nregion_aliases\n{}\nTable of region aliases to display in addition to the AWS name.\nprofile_aliases\n{}\nTable of profile aliases to display in addition to the AWS name.\nstyle\n'bold yellow'\nThe style for the module.\nexpiration_symbol\n'X'\nThe symbol displayed when the temporary credentials have expired.\ndisabled\nfalse\nDisables the\nAWS\nmodule.\nforce_display\nfalse\nIf\ntrue\ndisplays info even if\ncredentials\n,\ncredential_process\nor\nsso_start_url\nhave not been setup.\nVariables\n\nVariable\nExample\nDescription\nregion\nap-northeast-1\nThe current AWS region\nprofile\nastronauts\nThe current AWS profile\nduration\n2h27m20s\nThe temporary credentials validity duration\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExamples\n\nDisplay everything\n\ntoml\n# ~\/.config\/starship.toml\n[\naws\n]\nformat =\n'on [$symbol($profile )(\$$region\$ )]($style)'\nstyle =\n'bold blue'\nsymbol =\n'🅰 '\n[\naws\n.\nregion_aliases\n]\nap-southeast-2 =\n'au'\nus-east-1 =\n'va'\n[\naws\n.\nprofile_aliases\n]\nCompanyGroupFrobozzOnCallAccess =\n'Frobozz'\nDisplay region\n\ntoml\n# ~\/.config\/starship.toml\n[\naws\n]\nformat =\n'on [$symbol$region]($style) '\nstyle =\n'bold blue'\nsymbol =\n'🅰 '\n[\naws\n.\nregion_aliases\n]\nap-southeast-2 =\n'au'\nus-east-1 =\n'va'\nDisplay profile\n\ntoml\n# ~\/.config\/starship.toml\n[\naws\n]\nformat =\n'on [$symbol$profile]($style) '\nstyle =\n'bold blue'\nsymbol =\n'🅰 '\n[\naws\n.\nprofile_aliases\n]\nEnterprise_Naming_Scheme-voidstars =\n'void**'\nAzure\n\nThe\nazure\nmodule shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the\n~\/.azure\/azureProfile.json\nfile.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nVariable\nDefault\nDescription\nformat\n'on [$symbol($subscription)]($style) '\nThe format for the Azure module to render.\nsymbol\n'󰠅 '\nThe symbol used in the format.\nstyle\n'blue bold'\nThe style used in the format.\ndisabled\ntrue\nDisables the\nazure\nmodule.\nsubscription_aliases\n{}\nTable of subscription name aliases to display in addition to Azure subscription name.\nExamples\n\nDisplay Subscription Name\n\ntoml\n# ~\/.config\/starship.toml\n[\nazure\n]\ndisabled =\nfalse\nformat =\n'on [$symbol($subscription)]($style) '\nsymbol =\n'󰠅 '\nstyle =\n'blue bold'\nDisplay Username\n\ntoml\n# ~\/.config\/starship.toml\n[\nazure\n]\ndisabled =\nfalse\nformat =\n\"on [$symbol($username)]($style) \"\nsymbol =\n\"󰠅 \"\nstyle =\n\"blue bold\"\nDisplay Subscription Name Alias\n\ntoml\n# ~\/.config\/starship.toml\n[\nazure\n.\nsubscription_aliases\n]\nvery-long-subscription-name =\n'vlsn'\nBattery\n\nThe\nbattery\nmodule shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.\nOptions\n\nOption\nDefault\nDescription\nfull_symbol\n'󰁹 '\nThe symbol shown when the battery is full.\ncharging_symbol\n'󰂄 '\nThe symbol shown when the battery is charging.\ndischarging_symbol\n'󰂃 '\nThe symbol shown when the battery is discharging.\nunknown_symbol\n'󰁽 '\nThe symbol shown when the battery state is unknown.\nempty_symbol\n'󰂎 '\nThe symbol shown when the battery state is empty.\nformat\n'[$symbol$percentage]($style) '\nThe format for the module.\ndisplay\nlink\nDisplay threshold and style for the module.\ndisabled\nfalse\nDisables the\nbattery\nmodule.\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nbattery\n]\nfull_symbol =\n'🔋 '\ncharging_symbol =\n'⚡️ '\ndischarging_symbol =\n'💀 '\nBattery Display\n\nThe\ndisplay\nconfiguration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no\ndisplay\nis provided. The default is as shown:\ntoml\n[[\nbattery\n.\ndisplay\n]]\nthreshold =\n10\nstyle =\n'bold red'\nThe default value for the\ncharging_symbol\nand\ndischarging_symbol\noption is respectively the value of\nbattery\n's\ncharging_symbol\nand\ndischarging_symbol\noption.\nOptions\n\nThe\ndisplay\noption is an array of the following table.\nOption\nDefault\nDescription\nthreshold\n10\nThe upper bound for the display option.\nstyle\n'red bold'\nThe style used if the display option is in use.\ncharging_symbol\nOptional symbol displayed if display option is in use, defaults to battery's\ncharging_symbol\noption.\ndischarging_symbol\nOptional symbol displayed if display option is in use, defaults to battery's\ndischarging_symbol\noption.\nExample\n\ntoml\n[[\nbattery\n.\ndisplay\n]]\n# 'bold red' style and discharging_symbol when capacity is between 0% and 10%\nthreshold =\n10\nstyle =\n'bold red'\n[[\nbattery\n.\ndisplay\n]]\n# 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%\nthreshold =\n30\nstyle =\n'bold yellow'\ndischarging_symbol =\n'💦 '\n# when capacity is over 30%, the battery indicator will not be displayed\nBuf\n\nThe\nbuf\nmodule shows the currently installed version of\nBuf\n. By default, the module is shown if the current directory contains a\nbuf.yaml\n,\nbuf.gen.yaml\n, or\nbuf.work.yaml\nconfiguration file.\nOptions\n\nOption\nDefault\nDescription\nformat\n'with [$symbol($version )]($style)'\nThe format for the\nbuf\nmodule.\nversion_format\n'v${raw}'\nThe version format.\nsymbol\n'🐃 '\nThe symbol used before displaying the version of Buf.\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this modules.\nstyle\n'bold blue'\nThe style for the module.\ndisabled\nfalse\nDisables the\nelixir\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.0.0\nThe version of\nbuf\nsymbol\nMirrors the value of option\nsymbol\nstyle\n*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nbuf\n]\nsymbol =\n'🦬 '\nBun\n\nThe\nbun\nmodule shows the currently installed version of the\nbun\nJavaScript runtime. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nbun.lock\nfile\nThe current directory contains a\nbun.lockb\nfile\nThe current directory contains a\nbunfig.toml\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🥟 '\nA format string representing the symbol of Bun.\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['bun.lock', 'bun.lockb', 'bunfig.toml']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'bold red'\nThe style for the module.\ndisabled\nfalse\nDisables the\nbun\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.1.4\nThe version of\nbun\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\nCustomize the format\n\ntoml\n# ~\/.config\/starship.toml\n[\nbun\n]\nformat =\n'via [🍔 $version](bold green) '\nC\n\nThe\nc\nmodule shows some information about your C compiler. By default the module will be shown if the current directory contains a\n.c\nor\n.h\nfile.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version(-$name) )]($style)'\nThe format string for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'C '\nThe symbol used before displaying the compiler details\ndetect_extensions\n['c', 'h']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ncommands\n[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]\nHow to detect what the compiler is\nstyle\n'bold 149'\nThe style for the module.\ndisabled\nfalse\nDisables the\nc\nmodule.\nVariables\n\nVariable\nExample\nDescription\nname\nclang\nThe name of the compiler\nversion\n13.0.0\nThe version of the compiler\nsymbol\nMirrors the value of option\nsymbol\nstyle\nMirrors the value of option\nstyle\nCommands\n\nThe\ncommands\noption accepts a list of commands to determine the compiler version and name.\nEach command is represented as a list of the executable name, followed by its arguments, usually something like\n['mycc', '--version']\n. Starship will try executing each command until it gets a result on STDOUT.\nIf a C compiler is not supported by this module, you can request it by\nraising an issue on GitHub\n.\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nc\n]\nformat =\n'via [$name $version]($style)'\nCPP\n\nThe\ncpp\nmodule shows some information about your\nC++\ncompiler. By default, the module will be shown if the current directory contains a\n.cpp\n,\n.hpp\n, or other\nC++\n-related files.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version(-$name) )]($style)'\nThe format string for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'C++ '\nThe symbol used before displaying the compiler details\ndetect_extensions\n['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ncommands\n[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]\nHow to detect what the compiler is\nstyle\n'bold 149'\nThe style for the module.\ndisabled\ntrue\nDisables the\ncpp\nmodule.\nVariables\n\nVariable\nExample\nDescription\nname\nclang++\nThe name of the compiler\nversion\n13.0.0\nThe version of the compiler\nsymbol\nMirrors the value of option\nsymbol\nstyle\nMirrors the value of option\nstyle\nCommands\n\nThe\ncommands\noption accepts a list of commands to determine the compiler version and name.\nEach command is represented as a list of the executable name, followed by its arguments, usually something like\n['mycpp', '--version']\n. Starship will try executing each command until it gets a result on STDOUT.\nIf a C++ compiler is not supported by this module, you can request it by\nraising an issue on GitHub\n.\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ncpp\n]\ndisabled =\nfalse\nformat =\n'via [$name $version]($style)'\nCharacter\n\nThe\ncharacter\nmodule shows a character (usually an arrow) beside where the text is entered in your terminal.\nThe character will tell you whether the last command was successful or not. It can do this in two ways:\nchanging color (\nred\n\/\ngreen\n)\nchanging shape (\n❯\n\/\n✖\n)\nBy default it only changes color. If you also want to change its shape take a look at\nthis example\n.\nWARNING\nvimcmd_symbol\nis only supported in cmd, fish and zsh.\nvimcmd_replace_one_symbol\n,\nvimcmd_replace_symbol\n, and\nvimcmd_visual_symbol\nare only supported in fish due to\nupstream issues with mode detection in zsh\n.\nOptions\n\nOption\nDefault\nDescription\nformat\n'$symbol '\nThe format string used before the text input.\nsuccess_symbol\n'[❯](bold green)'\nThe format string used before the text input if the previous command succeeded.\nerror_symbol\n'[❯](bold red)'\nThe format string used before the text input if the previous command failed.\nvimcmd_symbol\n'[❮](bold green)'\nThe format string used before the text input if the shell is in vim normal mode.\nvimcmd_replace_one_symbol\n'[❮](bold purple)'\nThe format string used before the text input if the shell is in vim\nreplace_one\nmode.\nvimcmd_replace_symbol\n'[❮](bold purple)'\nThe format string used before the text input if the shell is in vim replace mode.\nvimcmd_visual_symbol\n'[❮](bold yellow)'\nThe format string used before the text input if the shell is in vim visual mode.\ndisabled\nfalse\nDisables the\ncharacter\nmodule.\nVariables\n\nVariable\nExample\nDescription\nsymbol\nA mirror of either\nsuccess_symbol\n,\nerror_symbol\n,\nvimcmd_symbol\nor\nvimcmd_replace_one_symbol\netc.\nExamples\n\nWith custom error shape\n\ntoml\n# ~\/.config\/starship.toml\n[\ncharacter\n]\nsuccess_symbol =\n'[➜](bold green) '\nerror_symbol =\n'[✗](bold red) '\nWithout custom error shape\n\ntoml\n# ~\/.config\/starship.toml\n[\ncharacter\n]\nsuccess_symbol =\n'[➜](bold green) '\nerror_symbol =\n'[➜](bold red) '\nWith custom vim shape\n\ntoml\n# ~\/.config\/starship.toml\n[\ncharacter\n]\nvimcmd_symbol =\n'[V](bold green) '\nCMake\n\nThe\ncmake\nmodule shows the currently installed version of\nCMake\n. By default the module will be activated if any of the following conditions are met:\nThe current directory contains a\nCMakeLists.txt\nfile\nThe current directory contains a\nCMakeCache.txt\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'△ '\nThe symbol used before the version of cmake.\ndetect_extensions\n[]\nWhich extensions should trigger this module\ndetect_files\n['CMakeLists.txt', 'CMakeCache.txt']\nWhich filenames should trigger this module\ndetect_folders\n[]\nWhich folders should trigger this module\nstyle\n'bold blue'\nThe style for the module.\ndisabled\nfalse\nDisables the\ncmake\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv3.17.3\nThe version of cmake\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nCOBOL \/ GNUCOBOL\n\nThe\ncobol\nmodule shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:\nThe current directory contains any files ending in\n.cob\nor\n.COB\nThe current directory contains any files ending in\n.cbl\nor\n.CBL\nOptions\n\nOption\nDefault\nDescription\nsymbol\n'⚙️ '\nThe symbol used before displaying the version of COBOL.\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nstyle\n'bold blue'\nThe style for the module.\ndetect_extensions\n['cbl', 'cob', 'CBL', 'COB']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ndisabled\nfalse\nDisables the\ncobol\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv3.1.2.0\nThe version of\ncobol\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nCommand Duration\n\nThe\ncmd_duration\nmodule shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the\nmin_time\nconfig value, if it exists.\nWARNING\nDo not hook the DEBUG trap in Bash\nIf you are running Starship in\nbash\n, do not hook the\nDEBUG\ntrap after running\neval $(starship init $0)\n, or this module\nwill\nbreak.\nBash users who need preexec-like functionality can use\nrcaloras's bash_preexec framework\n. Simply define the arrays\npreexec_functions\nand\nprecmd_functions\nbefore running\neval $(starship init $0)\n, and then proceed as normal.\nOptions\n\nOption\nDefault\nDescription\nmin_time\n2_000\nShortest duration to show time for (in milliseconds).\nshow_milliseconds\nfalse\nShow milliseconds in addition to seconds for the duration.\nformat\n'took [$duration]($style) '\nThe format for the module.\nstyle\n'bold yellow'\nThe style for the module.\ndisabled\nfalse\nDisables the\ncmd_duration\nmodule.\nshow_notifications\nfalse\nShow desktop notifications when command completes.\nmin_time_to_notify\n45_000\nShortest duration for notification (in milliseconds).\nnotification_timeout\nDuration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option.\nVariables\n\nVariable\nExample\nDescription\nduration\n16m40s\nThe time it took to execute the command\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ncmd_duration\n]\nmin_time =\n500\nformat =\n'underwent [$duration](bold yellow)'\nConda\n\nThe\nconda\nmodule shows the current\nConda\nenvironment, if\n$CONDA_DEFAULT_ENV\nis set.\nTIP\nThis does not suppress conda's own prompt modifier, you may want to run\nconda config --set changeps1 False\n. If you use\npixi\n, you can disable pixi's prompt modifier by running\npixi config set shell.change-ps1 false\n.\nOptions\n\nOption\nDefault\nDescription\ntruncation_length\n1\nThe number of directories the environment path should be truncated to, if the environment was created via\nconda create -p [path]\n.\n0\nmeans no truncation. Also see the\ndirectory\nmodule.\nsymbol\n'🅒 '\nThe symbol used before the environment name.\nstyle\n'bold green'\nThe style for the module.\nformat\n'via [$symbol$environment]($style) '\nThe format for the module.\nignore_base\ntrue\nIgnores\nbase\nenvironment when activated.\ndetect_env_vars\n[\"!PIXI_ENVIRONMENT_NAME\"]\nWhich environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default.\ndisabled\nfalse\nDisables the\nconda\nmodule.\nVariables\n\nVariable\nExample\nDescription\nenvironment\nastronauts\nThe current conda environment\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nconda\n]\nformat =\n'[$symbol$environment](dimmed green) '\nContainer\n\nThe\ncontainer\nmodule displays a symbol and container name, if inside a container.\nOptions\n\nOption\nDefault\nDescription\nsymbol\n'⬢'\nThe symbol shown, when inside a container\nstyle\n'bold red dimmed'\nThe style for the module.\nformat\n'[$symbol \\[$name\\]]($style) '\nThe format for the module.\ndisabled\nfalse\nDisables the\ncontainer\nmodule.\nVariables\n\nVariable\nExample\nDescription\nname\nfedora-toolbox:35\nThe name of the container\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ncontainer\n]\nformat =\n'[$symbol \\[$name\\]]($style) '\nCrystal\n\nThe\ncrystal\nmodule shows the currently installed version of\nCrystal\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nshard.yml\nfile\nThe current directory contains a\n.cr\nfile\nOptions\n\nOption\nDefault\nDescription\nsymbol\n'🔮 '\nThe symbol used before displaying the version of crystal.\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nstyle\n'bold red'\nThe style for the module.\ndetect_extensions\n['cr']\nWhich extensions should trigger this module.\ndetect_files\n['shard.yml']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ndisabled\nfalse\nDisables the\ncrystal\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.32.1\nThe version of\ncrystal\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ncrystal\n]\nformat =\n'via [✨ $version](bold blue) '\nDaml\n\nThe\ndaml\nmodule shows the currently used\nDaml\nSDK version when you are in the root directory of your Daml project. The\nsdk-version\nin the\ndaml.yaml\nfile will be used, unless it's overridden by the\nDAML_SDK_VERSION\nenvironment variable. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\ndaml.yaml\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'Λ '\nA format string representing the symbol of Daml\nstyle\n'bold cyan'\nThe style for the module.\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['daml.yaml']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ndisabled\nfalse\nDisables the\ndaml\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv2.2.0\nThe version of\ndaml\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ndaml\n]\nformat =\n'via [D $version](bold bright-green) '\nDart\n\nThe\ndart\nmodule shows the currently installed version of\nDart\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a file with\n.dart\nextension\nThe current directory contains a\n.dart_tool\ndirectory\nThe current directory contains a\npubspec.yaml\n,\npubspec.yml\nor\npubspec.lock\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🎯 '\nA format string representing the symbol of Dart\ndetect_extensions\n['dart']\nWhich extensions should trigger this module.\ndetect_files\n['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']\nWhich filenames should trigger this module.\ndetect_folders\n['.dart_tool']\nWhich folders should trigger this module.\nstyle\n'bold blue'\nThe style for the module.\ndisabled\nfalse\nDisables the\ndart\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv2.8.4\nThe version of\ndart\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ndart\n]\nformat =\n'via [🔰 $version](bold red) '\nDeno\n\nThe\ndeno\nmodule shows you your currently installed version of\nDeno\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\ndeno.json\n,\ndeno.jsonc\n,\ndeno.lock\n,\nmod.ts\n,\nmod.js\n,\ndeps.ts\nor\ndeps.js\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🦕 '\nA format string representing the symbol of Deno\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['deno.json', 'deno.jsonc', 'deno.lock', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'green bold'\nThe style for the module.\ndisabled\nfalse\nDisables the\ndeno\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.8.3\nThe version of\ndeno\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ndeno\n]\nformat =\n'via [🦕 $version](green bold) '\nDirectory\n\nThe\ndirectory\nmodule shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.\nWhen using the\nfish_style_pwd_dir_length\noption, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.\nFor example, given\n~\/Dev\/Nix\/nixpkgs\/pkgs\nwhere\nnixpkgs\nis the repo root, and the option set to\n1\n. You will now see\n~\/D\/N\/nixpkgs\/pkgs\n, whereas before it would have been\nnixpkgs\/pkgs\n.\nOptions\n\nOption\nDefault\nDescription\ntruncation_length\n3\nThe number of parent folders that the current directory should be truncated to.\ntruncate_to_repo\ntrue\nWhether or not to truncate to the root of the git repo that you're currently in.\nformat\n'[$path]($style)[$read_only]($read_only_style) '\nThe format for the module.\nstyle\n'bold cyan'\nThe style for the module.\ndisabled\nfalse\nDisables the\ndirectory\nmodule.\nread_only\n'🔒'\nThe symbol indicating current directory is read only.\nread_only_style\n'red'\nThe style for the read only symbol.\ntruncation_symbol\n''\nThe symbol to prefix to truncated paths. eg: '…\/'\nbefore_repo_root_style\nThe style for the path segment above the root of the git repo. The default value is equivalent to\nstyle\n.\nrepo_root_style\nThe style for the root of the git repo. The default value is equivalent to\nstyle\n.\nrepo_root_format\n'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '\nThe format of a git repo when\nbefore_repo_root_style\nand\nrepo_root_style\nis defined.\nhome_symbol\n'~'\nThe symbol indicating home directory.\nuse_os_path_sep\ntrue\nUse the OS specific path separator instead of always using\n\/\n(e.g.\n\\\non Windows)\nThis module has a few advanced configuration options that control how the directory is displayed.\nAdvanced Option\nDefault\nDescription\nsubstitutions\nA table of substitutions to be made to the path.\nfish_style_pwd_dir_length\n0\nThe number of characters to use when applying fish shell pwd path logic.\nuse_logical_path\ntrue\nIf\ntrue\nrender the logical path sourced from the shell via\nPWD\nor\n--logical-path\n. If\nfalse\ninstead render the physical filesystem path with symlinks resolved.\nsubstitutions\nallows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories of Java. Note that this will disable the fish style PWD.\ntoml\n[\ndirectory\n.\nsubstitutions\n]\n'\/Volumes\/network\/path' =\n'\/net'\n'src\/com\/long\/java\/path' =\n'mypath'\nfish_style_pwd_dir_length\ninteracts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path\n\/built\/this\/city\/on\/rock\/and\/roll\n, which would normally be displayed as\nrock\/and\/roll\n, would be displayed as\n\/b\/t\/c\/o\/rock\/and\/roll\nwith\nfish_style_pwd_dir_length = 1\n--the path components that would normally be removed are displayed with a single character. For\nfish_style_pwd_dir_length = 2\n, it would be\n\/bu\/th\/ci\/on\/rock\/and\/roll\n.\nVariables\n\nVariable\nExample\nDescription\npath\n'D:\/Projects'\nThe current directory path\nstyle*\n'black bold dimmed'\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nThe git repos have additional variables.\nLet us consider the path\n\/path\/to\/home\/git_repo\/src\/lib\nVariable\nExample\nDescription\nbefore_root_path\n'\/path\/to\/home\/'\nThe path before git root directory path\nrepo_root\n'git_repo'\nThe git root directory name\npath\n'\/src\/lib'\nThe remaining path\nstyle\n'black bold dimmed'\nMirrors the value of option\nstyle\nrepo_root_style\n'underline white'\nStyle for git root directory name\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ndirectory\n]\ntruncation_length =\n8\ntruncation_symbol =\n'…\/'\nDirenv\n\nThe\ndirenv\nmodule shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by\ndirenv\n.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nformat\n'[$symbol$loaded\/$allowed]($style) '\nThe format for the module.\nsymbol\n'direnv '\nThe symbol used before displaying the direnv context.\nstyle\n'bold orange'\nThe style for the module.\ndisabled\ntrue\nDisables the\ndirenv\nmodule.\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['.envrc']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ndetect_env_vars\n['DIRENV_FILE']\nWhich environment variables should trigger this module.\nallowed_msg\n'allowed'\nThe message displayed when an rc file is allowed.\nnot_allowed_msg\n'not allowed'\nThe message displayed when an rc file is not_allowed.\ndenied_msg\n'denied'\nThe message displayed when an rc file is denied.\nloaded_msg\n'loaded'\nThe message displayed when an rc file is loaded.\nunloaded_msg\n'not loaded'\nThe message displayed when an rc file is not loaded.\nVariables\n\nVariable\nExample\nDescription\nloaded\nloaded\nWhether the current rc file is loaded.\nallowed\ndenied\nWhether the current rc file is allowed.\nrc_path\n\/home\/test\/.envrc\nThe current rc file path.\nsymbol\nMirrors the value of option\nsymbol\n.\nstyle*\nred bold\nMirrors the value of option\nstyle\n.\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ndirenv\n]\ndisabled =\nfalse\nDocker Context\n\nThe\ndocker_context\nmodule shows the currently active\nDocker context\nif it's not set to\ndefault\nor\ndesktop-linux\n, or if the\nDOCKER_MACHINE_NAME\n,\nDOCKER_HOST\nor\nDOCKER_CONTEXT\nenvironment variables are set (as they are meant to override the context in use).\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol$context]($style) '\nThe format for the module.\nsymbol\n'🐳 '\nThe symbol used before displaying the Docker context.\nonly_with_files\ntrue\nOnly show when there's a match\ndetect_extensions\n[]\nWhich extensions should trigger this module (needs\nonly_with_files\nto be true).\ndetect_files\n['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']\nWhich filenames should trigger this module (needs\nonly_with_files\nto be true).\ndetect_folders\n[]\nWhich folders should trigger this module (needs\nonly_with_files\nto be true).\nstyle\n'blue bold'\nThe style for the module.\ndisabled\nfalse\nDisables the\ndocker_context\nmodule.\nVariables\n\nVariable\nExample\nDescription\ncontext\ntest_context\nThe current docker context\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ndocker_context\n]\nformat =\n'via [🐋 $context](blue bold)'\nDotnet\n\nThe\ndotnet\nmodule shows the relevant version of the\n.NET Core SDK\nfor the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.\nBy default this module will only be shown in your prompt when one or more of the following files are present in the current directory:\nglobal.json\nproject.json\nDirectory.Build.props\nDirectory.Build.targets\nPackages.props\n*.csproj\n*.fsproj\n*.xproj\nYou'll also need the .NET Core SDK installed in order to use it correctly.\nInternally, this module uses its own mechanism for version detection. Typically it is twice as fast as running\ndotnet --version\n, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting\nheuristic = false\nin the module options.\nThe module will also show the Target Framework Moniker (\nhttps:\/\/docs.microsoft.com\/en-us\/dotnet\/standard\/frameworks#supported-target-frameworks\n) when there is a\n.csproj\nfile in the current directory.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )(🎯 $tfm )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'.NET '\nThe symbol used before displaying the version of dotnet.\nheuristic\ntrue\nUse faster version detection to keep starship snappy.\ndetect_extensions\n['csproj', 'fsproj', 'xproj']\nWhich extensions should trigger this module.\ndetect_files\n['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this modules.\nstyle\n'bold blue'\nThe style for the module.\ndisabled\nfalse\nDisables the\ndotnet\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv3.1.201\nThe version of\ndotnet\nsdk\ntfm\nnetstandard2.0\nThe Target Framework Moniker that the current project is targeting\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ndotnet\n]\nsymbol =\n'🥅 '\nstyle =\n'green'\nheuristic =\nfalse\nElixir\n\nThe\nelixir\nmodule shows the currently installed version of\nElixir\nand\nErlang\/OTP\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nmix.exs\nfile.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version \$OTP $otp_version\$ )]($style)'\nThe format for the module elixir.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'💧 '\nThe symbol used before displaying the version of Elixir\/Erlang.\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['mix.exs']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this modules.\nstyle\n'bold purple'\nThe style for the module.\ndisabled\nfalse\nDisables the\nelixir\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.10\nThe version of\nelixir\notp_version\nThe otp version of\nelixir\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nelixir\n]\nsymbol =\n'🔮 '\nElm\n\nThe\nelm\nmodule shows the currently installed version of\nElm\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nelm.json\nfile\nThe current directory contains a\nelm-package.json\nfile\nThe current directory contains a\n.elm-version\nfile\nThe current directory contains a\nelm-stuff\nfolder\nThe current directory contains\n*.elm\nfiles\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🌳 '\nA format string representing the symbol of Elm.\ndetect_extensions\n['elm']\nWhich extensions should trigger this module.\ndetect_files\n['elm.json', 'elm-package.json', '.elm-version']\nWhich filenames should trigger this module.\ndetect_folders\n['elm-stuff']\nWhich folders should trigger this modules.\nstyle\n'cyan bold'\nThe style for the module.\ndisabled\nfalse\nDisables the\nelm\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.19.1\nThe version of\nelm\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nelm\n]\nformat =\n'via [ $version](cyan bold) '\nEnvironment Variable\n\nThe\nenv_var\nmodule displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met:\nThe\nvariable\nconfiguration option matches an existing environment variable\nThe\nvariable\nconfiguration option is not defined, but the\ndefault\nconfiguration option is\nTIP\nThe order in which env_var modules are shown can be individually set by including\n${env_var.foo}\nin the top level\nformat\n(as it includes a dot, you need to use\n${...}\n). By default, the\nenv_var\nmodule will simply show all env_var modules in the order they were defined.\nTIP\nMultiple environmental variables can be displayed by using a\n.\n. (see example) If the\nvariable\nconfiguration option is not set, the module will display value of variable under the name of text after the\n.\ncharacter.\nExample: following configuration will display value of USER environment variable\ntoml\n# ~\/.config\/starship.toml\n[\nenv_var\n.\nUSER\n]\ndefault =\n'unknown user'\nOptions\n\nOption\nDefault\nDescription\nsymbol\n\"\"\nThe symbol used before displaying the variable value.\nvariable\nThe environment variable to be displayed.\ndefault\nThe default value to be displayed when the selected variable is not defined.\nformat\n\"with [$env_value]($style) \"\nThe format for the module.\ndescription\n\"<env_var module>\"\nThe description of the module that is shown when running\nstarship explain\n.\ndisabled\nfalse\nDisables the\nenv_var\nmodule.\nVariables\n\nVariable\nExample\nDescription\nenv_value\nWindows NT\n(if\nvariable\nwould be\n$OS\n)\nThe environment value of option\nvariable\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nblack bold dimmed\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nenv_var\n]\nvariable =\n'SHELL'\ndefault =\n'unknown shell'\nDisplaying multiple environmental variables:\ntoml\n# ~\/.config\/starship.toml\n[\nenv_var\n.\nSHELL\n]\nvariable =\n'SHELL'\ndefault =\n'unknown shell'\n[\nenv_var\n.\nUSER\n]\ndefault =\n'unknown user'\nErlang\n\nThe\nerlang\nmodule shows the currently installed version of\nErlang\/OTP\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nrebar.config\nfile.\nThe current directory contains a\nerlang.mk\nfile.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n' '\nThe symbol used before displaying the version of erlang.\nstyle\n'bold red'\nThe style for the module.\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['rebar.config', 'elang.mk']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this modules.\ndisabled\nfalse\nDisables the\nerlang\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv22.1.3\nThe version of\nerlang\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nerlang\n]\nformat =\n'via [e $version](bold red) '\nFennel\n\nThe\nfennel\nmodule shows the currently installed version of\nFennel\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a file with the\n.fnl\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🧅 '\nThe symbol used before displaying the version of fennel.\nstyle\n'bold green'\nThe style for the module.\ndetect_extensions\n['fnl']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this modules.\ndisabled\nfalse\nDisables the\nfennel\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.2.1\nThe version of\nfennel\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nfennel\n]\nsymbol =\n'⫰ '\nFill\n\nThe\nfill\nmodule fills any extra space on the line with a symbol. If multiple\nfill\nmodules are present in a line they will split the space evenly between them. This is useful for aligning other modules.\nOptions\n\nOption\nDefault\nDescription\nsymbol\n'.'\nThe symbol used to fill the line.\nstyle\n'bold black'\nThe style for the module.\ndisabled\nfalse\nDisables the\nfill\nmodule\nExample\n\ntoml\n# ~\/.config\/starship.toml\nformat =\n'AA $fill BB $fill CC'\n[\nfill\n]\nsymbol =\n'-'\nstyle =\n'bold green'\nProduces a prompt that looks like:\nAA -------------------------------------------- BB -------------------------------------------- CC\nFortran\n\nThe\nfortran\nmodule shows the current compiler version of Fortran.\nOptions\n\nOption\nDefault\nDescription\nsymbol\n' '\nThe symbol used before displaying the version of Fortran.\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nstyle\n'bold purple'\nThe style for the module.\ndetect_extensions\n['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']\nWhich extensions should trigger this module.\ndetect_files\n['fpm.toml']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ncommands\n[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]\nHow to detect what the compiler is\ndisabled\nfalse\nDisables the\nfortran\nmodule.\nVariables\n\nVariable\nExample\nDescription\nname\ngfortran\nThe name of the compiler\nversion\n14.2.0\nThe version of the Fortran compiler\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nCommands\n\nThe\ncommands\noption accepts a list of commands to determine the compiler version and name.\nEach command is represented as a list of the executable name, followed by its arguments, usually something like\n['myfortran', '--version']\n. Starship will try executing each command until it gets a result on STDOUT.\nIf a Fortran compiler is not supported by this module, you can request it by\nraising an issue on GitHub\n.\nFossil Branch\n\nThe\nfossil_branch\nmodule shows the name of the active branch of the check-out in your current directory.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nformat\n'on [$symbol$branch]($style) '\nThe format for the module. Use\n'$branch'\nto refer to the current branch name.\nsymbol\n' '\nThe symbol used before the branch name of the check-out in your current directory.\nstyle\n'bold purple'\nThe style for the module.\ntruncation_length\n2^63 - 1\nTruncates a Fossil branch name to\nN\ngraphemes\ntruncation_symbol\n'…'\nThe symbol used to indicate a branch name was truncated. You can use\n''\nfor no symbol.\ndisabled\ntrue\nDisables the\nfossil_branch\nmodule.\nVariables\n\nVariable\nExample\nDescription\nbranch\ntrunk\nThe active Fossil branch\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nfossil_branch\n]\nsymbol =\n'🦎 '\ntruncation_length =\n4\ntruncation_symbol =\n''\nFossil Metrics\n\nThe\nfossil_metrics\nmodule will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nformat\n'([+$added]($added_style) )([-$deleted]($deleted_style) )'\nThe format for the module.\nadded_style\n'bold green'\nThe style for the added count.\ndeleted_style\n'bold red'\nThe style for the deleted count.\nonly_nonzero_diffs\ntrue\nRender status only for changed items.\ndisabled\ntrue\nDisables the\nfossil_metrics\nmodule.\nVariables\n\nVariable\nExample\nDescription\nadded\n1\nThe current number of added lines\ndeleted\n2\nThe current number of deleted lines\nadded_style*\nMirrors the value of option\nadded_style\ndeleted_style*\nMirrors the value of option\ndeleted_style\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nfossil_metrics\n]\nadded_style =\n'bold blue'\nformat =\n'[+$added]($added_style)\/[-$deleted]($deleted_style) '\nGoogle Cloud (\ngcloud\n)\n\nThe\ngcloud\nmodule shows the current configuration for\ngcloud\nCLI. This is based on the\n~\/.config\/gcloud\/active_config\nfile and the\n~\/.config\/gcloud\/configurations\/config_{CONFIG NAME}\nfile and the\nCLOUDSDK_CONFIG\nenv var.\nWhen the module is enabled it will always be active, unless\ndetect_env_vars\nhas been set in which case the module will only be active when one of the environment variables has been set.\nOptions\n\nOption\nDefault\nDescription\nformat\n'on [$symbol$account(@$domain)(\$$region\$)]($style) '\nThe format for the module.\nsymbol\n'☁️ '\nThe symbol used before displaying the current GCP profile.\nregion_aliases\n{}\nTable of region aliases to display in addition to the GCP name.\nproject_aliases\n{}\nTable of project aliases to display in addition to the GCP name.\ndetect_env_vars\n[]\nWhich environmental variables should trigger this module\nstyle\n'bold blue'\nThe style for the module.\ndisabled\nfalse\nDisables the\ngcloud\nmodule.\nVariables\n\nVariable\nExample\nDescription\nregion\nus-central1\nThe current GCP region\naccount\nfoo\nThe current GCP profile\ndomain\nexample.com\nThe current GCP profile domain\nproject\nThe current GCP project\nactive\ndefault\nThe active config name written in\n~\/.config\/gcloud\/active_config\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExamples\n\nDisplay account and project\n\ntoml\n# ~\/.config\/starship.toml\n[\ngcloud\n]\nformat =\n'on [$symbol$account(@$domain)(\$$project\$)]($style) '\nDisplay active config name only\n\ntoml\n# ~\/.config\/starship.toml\n[\ngcloud\n]\nformat =\n'[$symbol$active]($style) '\nstyle =\n'bold yellow'\nDisplay account and aliased region\n\ntoml\n# ~\/.config\/starship.toml\n[\ngcloud\n]\nsymbol =\n'️🇬️ '\n[\ngcloud\n.\nregion_aliases\n]\nus-central1 =\n'uc1'\nasia-northeast1 =\n'an1'\nDisplay account and aliased project\n\ntoml\n# ~\/.config\/starship.toml\n[\ngcloud\n]\nformat =\n'on [$symbol$account(@$domain)(\$$project\$)]($style) '\n[\ngcloud\n.\nproject_aliases\n]\nvery-long-project-name =\n'vlpn'\nGit Branch\n\nThe\ngit_branch\nmodule shows the active branch of the repo in your current directory.\nOptions\n\nOption\nDefault\nDescription\nalways_show_remote\nfalse\nShows the remote tracking branch name, even if it is equal to the local branch name.\nformat\n'on [$symbol$branch(:$remote_branch)]($style) '\nThe format for the module. Use\n'$branch'\nto refer to the current branch name.\nsymbol\n' '\nA format string representing the symbol of git branch.\nstyle\n'bold purple'\nThe style for the module.\ntruncation_length\n2^63 - 1\nTruncates a git branch to\nN\ngraphemes.\ntruncation_symbol\n'…'\nThe symbol used to indicate a branch name was truncated. You can use\n''\nfor no symbol.\nonly_attached\nfalse\nOnly show the branch name when not in a detached\nHEAD\nstate.\nignore_branches\n[]\nA list of names to avoid displaying. Useful for 'master' or 'main'.\nignore_bare_repo\nfalse\nDo not show when in a bare repo.\ndisabled\nfalse\nDisables the\ngit_branch\nmodule.\nVariables\n\nVariable\nExample\nDescription\nbranch\nmaster\nThe current branch name, falls back to\nHEAD\nif there's no current branch (e.g. git detached\nHEAD\n).\nremote_name\norigin\nThe remote name.\nremote_branch\nmaster\nThe name of the branch tracked on\nremote_name\n.\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ngit_branch\n]\nsymbol =\n'🌱 '\ntruncation_length =\n4\ntruncation_symbol =\n''\nignore_branches = [\n'master'\n,\n'main'\n]\nGit Commit\n\nThe\ngit_commit\nmodule shows the current commit hash and also the tag (if any) of the repo in your current directory.\nOptions\n\nOption\nDefault\nDescription\ncommit_hash_length\n7\nThe length of the displayed git commit hash.\nformat\n'[\$$hash$tag\$]($style) '\nThe format for the module.\nstyle\n'bold green'\nThe style for the module.\nonly_detached\ntrue\nOnly show git commit hash when in detached\nHEAD\nstate\ntag_disabled\ntrue\nDisables showing tag info in\ngit_commit\nmodule.\ntag_max_candidates\n0\nHow many commits to consider for tag display. The default only allows exact matches.\ntag_symbol\n' 🏷 '\nTag symbol prefixing the info shown\ndisabled\nfalse\nDisables the\ngit_commit\nmodule.\nVariables\n\nVariable\nExample\nDescription\nhash\nb703eb3\nThe current git commit hash\ntag\nv1.0.0\nThe tag name if showing tag info is enabled.\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ngit_commit\n]\ncommit_hash_length =\n4\ntag_symbol =\n'🔖 '\nGit State\n\nThe\ngit_state\nmodule will show in directories which are part of a git repository, and where there is an operation in progress, such as:\nREBASING\n,\nBISECTING\n, etc. If there is progress information (e.g., REBASING 3\/10), that information will be shown too.\nOptions\n\nOption\nDefault\nDescription\nrebase\n'REBASING'\nA format string displayed when a\nrebase\nis in progress.\nmerge\n'MERGING'\nA format string displayed when a\nmerge\nis in progress.\nrevert\n'REVERTING'\nA format string displayed when a\nrevert\nis in progress.\ncherry_pick\n'CHERRY-PICKING'\nA format string displayed when a\ncherry-pick\nis in progress.\nbisect\n'BISECTING'\nA format string displayed when a\nbisect\nis in progress.\nam\n'AM'\nA format string displayed when an\napply-mailbox\n(\ngit am\n) is in progress.\nam_or_rebase\n'AM\/REBASE'\nA format string displayed when an ambiguous\napply-mailbox\nor\nrebase\nis in progress.\nstyle\n'bold yellow'\nThe style for the module.\nformat\n'\$[$state( $progress_current\/$progress_total)]($style)\$ '\nThe format for the module.\ndisabled\nfalse\nDisables the\ngit_state\nmodule.\nVariables\n\nVariable\nExample\nDescription\nstate\nREBASING\nThe current state of the repo\nprogress_current\n1\nThe current operation progress\nprogress_total\n2\nThe total operation progress\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ngit_state\n]\nformat =\n'[\$$state( $progress_current of $progress_total)\$]($style) '\ncherry_pick =\n'[🍒 PICKING](bold red)'\nGit Metrics\n\nThe\ngit_metrics\nmodule will show the number of added and deleted lines in the current git repository.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nadded_style\n'bold green'\nThe style for the added count.\ndeleted_style\n'bold red'\nThe style for the deleted count.\nonly_nonzero_diffs\ntrue\nRender status only for changed items.\nformat\n'([+$added]($added_style) )([-$deleted]($deleted_style) )'\nThe format for the module.\ndisabled\ntrue\nDisables the\ngit_metrics\nmodule.\nignore_submodules\nfalse\nIgnore changes to submodules\nVariables\n\nVariable\nExample\nDescription\nadded\n1\nThe current number of added lines\ndeleted\n2\nThe current number of deleted lines\nadded_style*\nMirrors the value of option\nadded_style\ndeleted_style*\nMirrors the value of option\ndeleted_style\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ngit_metrics\n]\nadded_style =\n'bold blue'\nformat =\n'[+$added]($added_style)\/[-$deleted]($deleted_style) '\nGit Status\n\nThe\ngit_status\nmodule shows symbols representing the state of the repo in your current directory.\nTIP\nThe Git Status module is very slow in Windows directories (for example under\n\/mnt\/c\/\n) when in a WSL environment. You can disable the module or use the\nwindows_starship\noption to use a Windows-native Starship executable to compute\ngit_status\nfor those paths.\nOptions\n\nOption\nDefault\nDescription\nformat\n'([\\[$all_status$ahead_behind\\]]($style) )'\nThe default format for\ngit_status\nconflicted\n'='\nThis branch has merge conflicts.\nahead\n'⇡'\nThe format of\nahead\nbehind\n'⇣'\nThe format of\nbehind\ndiverged\n'⇕'\nThe format of\ndiverged\nup_to_date\n''\nThe format of\nup_to_date\nuntracked\n'?'\nThe format of\nuntracked\nstashed\n'\\$'\nThe format of\nstashed\nmodified\n'!'\nThe format of\nmodified\nstaged\n'+'\nThe format of\nstaged\nrenamed\n'»'\nThe format of\nrenamed\ndeleted\n'✘'\nThe format of\ndeleted\ntypechanged\n\"\"\nThe format of\ntypechanged\nstyle\n'bold red'\nThe style for the module.\nignore_submodules\nfalse\nIgnore changes to submodules.\ndisabled\nfalse\nDisables the\ngit_status\nmodule.\nwindows_starship\nUse this (Linux) path to a Windows Starship executable to render\ngit_status\nwhen on Windows paths in WSL.\nuse_git_executable\nfalse\nDo not use\ngitoxide\nfor computing the status, but use the\ngit\nexecutable instead.\nVariables\n\nThe following variables can be used in\nformat\n:\nVariable\nDescription\nall_status\nShortcut for\n$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked\nahead_behind\nDisplays\ndiverged\n,\nahead\n,\nbehind\nor\nup_to_date\nformat string based on the current status of the repo.\nconflicted\nDisplays\nconflicted\nwhen this branch has merge conflicts.\nuntracked\nDisplays\nuntracked\nwhen there are untracked files in the working directory.\nstashed\nDisplays\nstashed\nwhen a stash exists for the local repository.\nmodified\nDisplays\nmodified\nwhen there are file modifications in the working directory.\nstaged\nDisplays\nstaged\nwhen a new file has been added to the staging area.\nrenamed\nDisplays\nrenamed\nwhen a renamed file has been added to the staging area.\ndeleted\nDisplays\ndeleted\nwhen a file's deletion has been added to the staging area.\ntypechanged\nDisplays\ntypechanged\nwhen a file's type has been changed in the staging area.\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nThe following variables can be used in\ndiverged\n:\nVariable\nDescription\nahead_count\nNumber of commits ahead of the tracking branch\nbehind_count\nNumber of commits behind the tracking branch\nThe following variables can be used in\nconflicted\n,\nahead\n,\nbehind\n,\nuntracked\n,\nstashed\n,\nmodified\n,\nstaged\n,\nrenamed\nand\ndeleted\n:\nVariable\nDescription\ncount\nShow the number of files\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ngit_status\n]\nconflicted =\n'🏳'\nahead =\n'🏎💨'\nbehind =\n'😰'\ndiverged =\n'😵'\nup_to_date =\n'✓'\nuntracked =\n'🤷'\nstashed =\n'📦'\nmodified =\n'📝'\nstaged =\n'[++\$$count\$](green)'\nrenamed =\n'👅'\ndeleted =\n'🗑'\nShow ahead\/behind count of the branch being tracked\ntoml\n# ~\/.config\/starship.toml\n[\ngit_status\n]\nahead =\n'⇡${count}'\ndiverged =\n'⇕⇡${ahead_count}⇣${behind_count}'\nbehind =\n'⇣${count}'\nUse Windows Starship executable on Windows paths in WSL\ntoml\n# ~\/.config\/starship.toml\n[\ngit_status\n]\nwindows_starship =\n'\/mnt\/c\/Users\/username\/scoop\/apps\/starship\/current\/starship.exe'\nGleam\n\nThe\ngleam\nmodule shows the currently installed version of\nGleam\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\ngleam.toml\nfile\nThe current directory contains a file with the\n.gleam\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'⭐ '\nA format string representing the symbol of Gleam.\ndetect_extensions\n['gleam']\nWhich extensions should trigger this module.\ndetect_files\n['gleam.toml']\nWhich filenames should trigger this module.\nstyle\n'bold #FFAFF3'\nThe style for the module.\ndisabled\nfalse\nDisables the\ngleam\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.0.0\nThe version of\ngleam\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ngleam\n]\nformat =\n'via [⭐ $version](bold red) '\nGo\n\nThe\ngolang\nmodule shows the currently installed version of\nGo\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\ngo.mod\nfile\nThe current directory contains a\ngo.sum\nfile\nThe current directory contains a\ngo.work\nfile\nThe current directory contains a\nglide.yaml\nfile\nThe current directory contains a\nGopkg.yml\nfile\nThe current directory contains a\nGopkg.lock\nfile\nThe current directory contains a\n.go-version\nfile\nThe current directory contains a\nGodeps\ndirectory\nThe current directory contains a file with the\n.go\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🐹 '\nA format string representing the symbol of Go.\ndetect_extensions\n['go']\nWhich extensions should trigger this module.\ndetect_files\n['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']\nWhich filenames should trigger this module.\ndetect_folders\n['Godeps']\nWhich folders should trigger this module.\nstyle\n'bold cyan'\nThe style for the module.\nnot_capable_style\n'bold red'\nThe style for the module when the go directive in the go.mod file does not match the installed Go version.\ndisabled\nfalse\nDisables the\ngolang\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.12.1\nThe version of\ngo\nmod_version\n1.16\ngo\nversion requirement as set in the go directive of\ngo.mod\n. Will only show if the version requirement does not match the\ngo\nversion.\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ngolang\n]\nformat =\n'via [🏎💨 $version](bold cyan) '\nUsing\nmod_version\n\ntoml\n# ~\/.config\/starship.toml\n[\ngolang\n]\nformat =\n'via [$symbol($version )($mod_version )]($style)'\nGuix-shell\n\nThe\nguix_shell\nmodule shows the\nguix-shell\nenvironment. The module will be shown when inside a guix-shell environment.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol]($style) '\nThe format for the module.\nsymbol\n'🐃 '\nA format string representing the symbol of guix-shell.\nstyle\n'yellow bold'\nThe style for the module.\ndisabled\nfalse\nDisables the\nguix_shell\nmodule.\nVariables\n\nVariable\nExample\nDescription\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nguix_shell\n]\ndisabled =\ntrue\nformat =\n'via [🐂](yellow bold) '\nGradle\n\nThe\ngradle\nmodule shows the version of the\nGradle Wrapper\ncurrently used in the project directory.\nBy default the module will be shown if any of the following conditions are met:\nThe current directory contains a\ngradle\/wrapper\/gradle-wrapper.properties\ndirectory.\nThe current directory contains a file ending with\n.gradle\nor\n.gradle.kts\n.\nThe\ngradle\nmodule is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🅶 '\nA format string representing the symbol of Gradle.\ndetect_extensions\n['gradle', 'gradle.kts']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n['gradle']\nWhich folders should trigger this module.\nstyle\n'bold bright-cyan'\nThe style for the module.\ndisabled\nfalse\nDisables the\ngradle\nmodule.\nrecursive\nfalse\nEnables recursive finding for the\ngradle\ndirectory.\nVariables\n\nVariable\nExample\nDescription\nversion\nv7.5.1\nThe version of\ngradle\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nHaskell\n\nThe\nhaskell\nmodule finds the current selected GHC version and\/or the selected Stack snapshot.\nBy default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nstack.yaml\nfile\nThe current directory contains any\n.hs\n,\n.cabal\n, or\n.hs-boot\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nsymbol\n'λ '\nA format string representing the symbol of Haskell\ndetect_extensions\n['hs', 'cabal', 'hs-boot']\nWhich extensions should trigger this module.\ndetect_files\n['stack.yaml', 'cabal.project']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'bold purple'\nThe style for the module.\ndisabled\nfalse\nDisables the\nhaskell\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nghc_version\nor\nsnapshot\ndepending on whether the current project is a Stack project\nsnapshot\nlts-18.12\nCurrently selected Stack snapshot\nghc_version\n9.2.1\nCurrently installed GHC version\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nHaxe\n\nThe\nhaxe\nmodule shows the currently installed version of\nHaxe\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nproject.xml\n,\nProject.xml\n,\napplication.xml\n,\nhaxelib.json\n,\nhxformat.json\nor\n.haxerc\nfile\nThe current directory contains a\n.haxelib\nor a\nhaxe_libraries\ndirectory\nThe current directory contains a file with the\n.hx\nor\n.hxml\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\ndetect_extensions\n['hx', 'hxml']\nWhich extensions should trigger this module.\ndetect_files\n['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']\nWhich filenames should trigger this module.\ndetect_folders\n['.haxelib', 'haxe_libraries']\nWhich folders should trigger this modules.\nsymbol\n'⌘ '\nA format string representing the symbol of Haxe.\nstyle\n'bold fg:202'\nThe style for the module.\ndisabled\nfalse\nDisables the\nhaxe\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv4.2.5\nThe version of\nhaxe\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nhaxe\n]\nformat =\n\"via [⌘ $version](bold fg:202) \"\nHelm\n\nThe\nhelm\nmodule shows the currently installed version of\nHelm\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nhelmfile.yaml\nfile\nThe current directory contains a\nChart.yaml\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['helmfile.yaml', 'Chart.yaml']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this modules.\nsymbol\n'⎈ '\nA format string representing the symbol of Helm.\nstyle\n'bold white'\nThe style for the module.\ndisabled\nfalse\nDisables the\nhelm\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv3.1.1\nThe version of\nhelm\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nhelm\n]\nformat =\n'via [⎈ $version](bold white) '\nHostname\n\nThe\nhostname\nmodule shows the system hostname.\nOptions\n\nOption\nDefault\nDescription\nssh_only\ntrue\nOnly show hostname when connected to an SSH session.\nssh_symbol\n'🌐 '\nA format string representing the symbol when connected to SSH session.\ntrim_at\n'.'\nString that the hostname is cut off at, after the first match.\n'.'\nwill stop after the first dot.\n''\nwill disable any truncation.\ndetect_env_vars\n[]\nWhich environment variable(s) should trigger this module.\nformat\n'[$ssh_symbol$hostname]($style) in '\nThe format for the module.\nstyle\n'bold dimmed green'\nThe style for the module.\ndisabled\nfalse\nDisables the\nhostname\nmodule.\naliases\n{}\nTranslate system hostnames to something else. If\ntrim_at\nis specified, only the first part will be matched and replaced.\nVariables\n\nVariable\nExample\nDescription\nhostname\ncomputer\nThe hostname of the computer\nstyle*\nMirrors the value of option\nstyle\nssh_symbol\n'🌏 '\nThe symbol to represent when connected to SSH session\n*: This variable can only be used as a part of a style string\nExamples\n\nAlways show the hostname\n\ntoml\n# ~\/.config\/starship.toml\n[\nhostname\n]\nssh_only =\nfalse\nformat =\n'[$ssh_symbol](bold blue) on [$hostname](bold red) '\ntrim_at =\n'.companyname.com'\ndisabled =\nfalse\nHide the hostname in remote tmux sessions\n\ntoml\n# ~\/.config\/starship.toml\n[\nhostname\n]\nssh_only =\nfalse\ndetect_env_vars = [\n'!TMUX'\n,\n'SSH_CONNECTION'\n]\ndisabled =\nfalse\nReplace the hostname with a nickname\n\ntoml\n# ~\/.config\/starship.toml\n[\nhostname\n]\naliases = { \"Max's MacBook Pro\" =\n\"home\"\n}\nJava\n\nThe\njava\nmodule shows the currently installed version of\nJava\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\npom.xml\n,\nbuild.gradle.kts\n,\nbuild.sbt\n,\n.java-version\n,\ndeps.edn\n,\nproject.clj\n,\nbuild.boot\n, or\n.sdkmanrc\nfile\nThe current directory contains a file with the\n.java\n,\n.class\n,\n.gradle\n,\n.jar\n,\n.clj\n, or\n.cljc\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [${symbol}(${version} )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\ndetect_extensions\n['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']\nWhich extensions should trigger this module.\ndetect_files\n['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this modules.\nsymbol\n'☕ '\nA format string representing the symbol of Java\nstyle\n'red dimmed'\nThe style for the module.\ndisabled\nfalse\nDisables the\njava\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv14\nThe version of\njava\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\njava\n]\nsymbol =\n'🌟 '\nJobs\n\nThe\njobs\nmodule shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the\nnumber_threshold\nconfig value, if it exists. The module will show a symbol if there is at least 1 job, or more than the\nsymbol_threshold\nconfig value, if it exists. You can set both values to 0 in order to\nalways\nshow the symbol and number of jobs, even if there are 0 jobs running.\nThe default functionality is:\n0 jobs -> Nothing is shown.\n1 job ->\nsymbol\nis shown.\n2 jobs or more ->\nsymbol\n+\nnumber\nare shown.\nWARNING\nThis module is not supported on tcsh.\nWARNING\nThe\nthreshold\noption is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the\nthreshold\nconfig value, if it exists. If\nthreshold\nis set to 0, then the module will also show when there are 0 jobs running.\nOptions\n\nOption\nDefault\nDescription\nthreshold\n*\n1\nShow number of jobs if exceeded.\nsymbol_threshold\n1\nShow\nsymbol\nif the job count is at least\nsymbol_threshold\n.\nnumber_threshold\n2\nShow the number of jobs if the job count is at least\nnumber_threshold\n.\nformat\n'[$symbol$number]($style) '\nThe format for the module.\nsymbol\n'✦'\nThe string used to represent the\nsymbol\nvariable.\nstyle\n'bold blue'\nThe style for the module.\ndisabled\nfalse\nDisables the\njobs\nmodule.\n*: This option is deprecated, please use the\nnumber_threshold\nand\nsymbol_threshold\noptions instead.\nVariables\n\nVariable\nExample\nDescription\nnumber\n1\nThe number of jobs\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExamples\n\ntoml\n# ~\/.config\/starship.toml\n[\njobs\n]\nsymbol =\n'+ '\nnumber_threshold =\n4\nsymbol_threshold =\n0\nChanging process grouping behavior in fish\n\nWhen using the Fish shell, Starship counts\njob groups\ninstead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:\nfish\nset\n-g __starship_fish_use_job_groups\n\"false\"\nJulia\n\nThe\njulia\nmodule shows the currently installed version of\nJulia\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nProject.toml\nfile\nThe current directory contains a\nManifest.toml\nfile\nThe current directory contains a file with the\n.jl\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\ndetect_extensions\n['jl']\nWhich extensions should trigger this module.\ndetect_files\n['Project.toml', 'Manifest.toml']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this modules.\nsymbol\n'ஃ '\nA format string representing the symbol of Julia.\nstyle\n'bold purple'\nThe style for the module.\ndisabled\nfalse\nDisables the\njulia\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.4.0\nThe version of\njulia\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\njulia\n]\nsymbol =\n'∴ '\nKotlin\n\nThe\nkotlin\nmodule shows the currently installed version of\nKotlin\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\n.kt\nor a\n.kts\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\ndetect_extensions\n['kt', 'kts']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this modules.\nsymbol\n'🅺 '\nA format string representing the symbol of Kotlin.\nstyle\n'bold blue'\nThe style for the module.\nkotlin_binary\n'kotlin'\nConfigures the kotlin binary that Starship executes when getting the version.\ndisabled\nfalse\nDisables the\nkotlin\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.4.21\nThe version of\nkotlin\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nkotlin\n]\nsymbol =\n'🅺 '\ntoml\n# ~\/.config\/starship.toml\n[\nkotlin\n]\n# Uses the Kotlin Compiler binary to get the installed version\nkotlin_binary =\n'kotlinc'\nKubernetes\n\nDisplays the current\nKubernetes context\nname and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via\nkubectl config set-context starship-context --namespace astronaut\n. Similarly, the user and cluster can be set with\nkubectl config set-context starship-context --user starship-user\nand\nkubectl config set-context starship-context --cluster starship-cluster\n. If the\n$KUBECONFIG\nenv var is set the module will use that if not it will use the\n~\/.kube\/config\n.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nWhen the module is enabled it will always be active, unless any of\ndetect_env_vars\n,\ndetect_extensions\n,\ndetect_files\nor\ndetect_folders\nhave been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.\nOptions\n\nWARNING\nThe\ncontext_aliases\nand\nuser_aliases\noptions are deprecated. Use\ncontexts\nand the corresponding\ncontext_alias\nand\nuser_alias\noptions instead.\nOption\nDefault\nDescription\nsymbol\n'☸ '\nA format string representing the symbol displayed before the Cluster.\nformat\n'[$symbol$context( \$$namespace\$)]($style) in '\nThe format for the module.\nstyle\n'cyan bold'\nThe style for the module.\ncontext_aliases\n*\n{}\nTable of context aliases to display.\nuser_aliases\n*\n{}\nTable of user aliases to display.\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this modules.\ndetect_env_vars\n[]\nWhich environmental variables should trigger this module\ncontexts\n[]\nCustomized styles and symbols for specific contexts.\ndisabled\ntrue\nDisables the\nkubernetes\nmodule.\n*: This option is deprecated, please add\ncontexts\nwith the corresponding\ncontext_alias\nand\nuser_alias\noptions instead.\nTo customize the style of the module for specific environments, use the following configuration as part of the\ncontexts\nlist:\nVariable\nDescription\ncontext_pattern\nRequired\nRegular expression to match current Kubernetes context name.\nuser_pattern\nRegular expression to match current Kubernetes user name.\ncontext_alias\nContext alias to display instead of the full context name.\nuser_alias\nUser alias to display instead of the full user name.\nstyle\nThe style for the module when using this context. If not set, will use module's style.\nsymbol\nThe symbol for the module when using this context. If not set, will use module's symbol.\nNote that all regular expression are anchored with\n^<pattern>$\nand so must match the whole string. The\n*_pattern\nregular expressions may contain capture groups, which can be referenced in the corresponding alias via\n$name\nand\n$N\n(see example below and the\nrust Regex::replace() documentation\n).\nVariables\n\nVariable\nExample\nDescription\ncontext\nstarship-context\nThe current kubernetes context name\nnamespace\nstarship-namespace\nIf set, the current kubernetes namespace\nuser\nstarship-user\nIf set, the current kubernetes user\ncluster\nstarship-cluster\nIf set, the current kubernetes cluster\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nkubernetes\n]\nformat =\n'on [⛵ ($user on )($cluster in )$context \$$namespace\$](dimmed green) '\ndisabled =\nfalse\ncontexts = [\n{ context_pattern =\n\"dev.local.cluster.k8s\"\n, style =\n\"green\"\n, symbol =\n\"💔 \"\n},\n]\nOnly show the module in directories that contain a\nk8s\nfile.\ntoml\n# ~\/.config\/starship.toml\n[\nkubernetes\n]\ndisabled =\nfalse\ndetect_files = [\n'k8s'\n]\nKubernetes Context specific config\n\nThe\ncontexts\nconfiguration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.\ntoml\n# ~\/.config\/starship.toml\n[[\nkubernetes\n.\ncontexts\n]]\n# \"bold red\" style + default symbol when Kubernetes current context name equals \"production\" *and* the current user\n# equals \"admin_user\"\ncontext_pattern =\n\"production\"\nuser_pattern =\n\"admin_user\"\nstyle =\n\"bold red\"\ncontext_alias =\n\"prod\"\nuser_alias =\n\"admin\"\n[[\nkubernetes\n.\ncontexts\n]]\n# \"green\" style + a different symbol when Kubernetes current context name contains openshift\ncontext_pattern =\n\".*openshift.*\"\nstyle =\n\"green\"\nsymbol =\n\"💔 \"\ncontext_alias =\n\"openshift\"\n[[\nkubernetes\n.\ncontexts\n]]\n# Using capture groups\n# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region\/zone.\n# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)\n# and renames every matching kube context into a more readable format (`gke-cluster-name`):\ncontext_pattern =\n\"gke_.*_(?P<cluster>[\n\\\\\nw-]+)\"\ncontext_alias =\n\"gke-$cluster\"\nLine Break\n\nThe\nline_break\nmodule separates the prompt into two lines.\nOptions\n\nOption\nDefault\nDescription\ndisabled\nfalse\nDisables the\nline_break\nmodule, making the prompt a single line.\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nline_break\n]\ndisabled =\ntrue\nLocal IP\n\nThe\nlocalip\nmodule shows the IPv4 address of the primary network interface.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nssh_only\ntrue\nOnly show IP address when connected to an SSH session.\nformat\n'[$localipv4]($style) '\nThe format for the module.\nstyle\n'bold yellow'\nThe style for the module.\ndisabled\ntrue\nDisables the\nlocalip\nmodule.\nVariables\n\nVariable\nExample\nDescription\nlocalipv4\n192.168.1.13\nContains the primary IPv4 address\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nlocalip\n]\nssh_only =\nfalse\nformat =\n'@[$localipv4](bold red) '\ndisabled =\nfalse\nLua\n\nThe\nlua\nmodule shows the currently installed version of\nLua\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\n.lua-version\nfile\nThe current directory contains a\nlua\ndirectory\nThe current directory contains a file with the\n.lua\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🌙 '\nA format string representing the symbol of Lua.\ndetect_extensions\n['lua']\nWhich extensions should trigger this module.\ndetect_files\n['.lua-version']\nWhich filenames should trigger this module.\ndetect_folders\n['lua']\nWhich folders should trigger this module.\nstyle\n'bold blue'\nThe style for the module.\nlua_binary\n'lua'\nConfigures the lua binary that Starship executes when getting the version.\ndisabled\nfalse\nDisables the\nlua\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv5.4.0\nThe version of\nlua\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nlua\n]\nformat =\n'via [🌕 $version](bold blue) '\nMemory Usage\n\nThe\nmemory_usage\nmodule shows current system memory and swap usage.\nBy default the swap usage is displayed if the total system swap is non-zero.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nthreshold\n75\nHide the memory usage unless it exceeds this percentage.\nformat\n'via $symbol [${ram}( | ${swap})]($style) '\nThe format for the module.\nsymbol\n'🐏'\nThe symbol used before displaying the memory usage.\nstyle\n'bold dimmed white'\nThe style for the module.\ndisabled\ntrue\nDisables the\nmemory_usage\nmodule.\nVariables\n\nVariable\nExample\nDescription\nram\n31GiB\/65GiB\nThe usage\/total RAM of the current system memory.\nram_pct\n48%\nThe percentage of the current system memory.\nswap**\n1GiB\/4GiB\nThe swap memory size of the current system swap memory file.\nswap_pct**\n77%\nThe swap memory percentage of the current system swap memory file.\nsymbol\n🐏\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string **: The SWAP file information is only displayed if detected on the current system\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nmemory_usage\n]\ndisabled =\nfalse\nthreshold =\n-1\nsymbol =\n' '\nstyle =\n'bold dimmed green'\nMeson\n\nThe\nmeson\nmodule shows the current Meson developer environment status.\nBy default the Meson project name is displayed, if\n$MESON_DEVENV\nis set.\nOptions\n\nOption\nDefault\nDescription\ntruncation_length\n2^32 - 1\nTruncates a project name to\nN\ngraphemes.\ntruncation_symbol\n'…'\nThe symbol used to indicate a project name was truncated. You can use\n''\nfor no symbol.\nformat\n'via [$symbol$project]($style) '\nThe format for the module.\nsymbol\n'⬢ '\nThe symbol used before displaying the project name.\nstyle\n'blue bold'\nThe style for the module.\ndisabled\nfalse\nDisables the\nmeson\nmodule.\nVariables\n\nVariable\nExample\nDescription\nproject\nstarship\nThe current Meson project name\nsymbol\n🐏\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nmeson\n]\ndisabled =\nfalse\ntruncation_symbol =\n'--'\nsymbol =\n' '\nstyle =\n'bold dimmed green'\nMercurial Branch\n\nThe\nhg_branch\nmodule shows the active branch and topic of the repo in your current directory.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nsymbol\n' '\nThe symbol used before the hg bookmark or branch name of the repo in your current directory.\nstyle\n'bold purple'\nThe style for the module.\nformat\n'on [$symbol$branch(:$topic)]($style) '\nThe format for the module.\ntruncation_length\n2^63 - 1\nTruncates the hg branch \/ topic name to\nN\ngraphemes\ntruncation_symbol\n'…'\nThe symbol used to indicate a branch name was truncated.\ndisabled\ntrue\nDisables the\nhg_branch\nmodule.\nVariables\n\nVariable\nExample\nDescription\nbranch\nmaster\nThe active mercurial branch\ntopic\nfeature\nThe active mercurial topic\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nhg_branch\n]\nformat =\n'on [🌱 $branch](bold purple)'\ntruncation_length =\n4\ntruncation_symbol =\n''\nMercurial State\n\nThe\nhg_state\nmodule will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as:\nREBASING\n,\nBISECTING\n, etc.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nmerge\n'MERGING'\nA format string displayed when a\nmerge\nis in progress.\nrebase\n'REBASING'\nA format string displayed when a\nrebase\nis in progress.\nupdate\n'UPDATING'\nA format string displayed when a\nupdate\nis in progress.\nbisect\n'BISECTING'\nA format string displayed when a\nbisect\nis in progress.\nshelve\n'SHELVING'\nA format string displayed when a\nshelve\nis in progress.\ngraft\n'GRAFTING'\nA format string displayed when a\ngraft\nis in progress.\ntransplant\n'TRANSPLANTING'\nA format string displayed when a\ntransplant\nis in progress.\nhistedit\n'HISTEDITING'\nA format string displayed when a\nhistedit\nis in progress.\nstyle\n'bold yellow'\nThe style for the module.\nformat\n'\$[$state]($style)\$ '\nThe format for the module.\ndisabled\ntrue\nDisables the\nhg_state\nmodule.\nVariables\n\nVariable\nExample\nDescription\nstate\nREBASING\nThe current state of the repo\nprogress_current\n1\nThe current operation progress\nprogress_total\n2\nThe total operation progress\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nMise\n\nThe\nmise\nmodule shows the current mise health as reported by running\nmise doctor\n.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nsymbol\n'mise '\nThe symbol used before displaying\nmise\nhealth.\nstyle\n'bold purple'\nThe style for the module.\nformat\n'on [$symbol$health]($style) '\nThe format for the module.\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['mise.toml', 'mise.local.toml', '.mise.toml', '.mise.local.toml']\nWhich filenames should trigger this module.\ndetect_folders\n['.mise']\nWhich folders should trigger this module.\nhealthy_symbol\nhealthy\nThe message displayed when\nmise\nis healthy.\nunhealthy_symbol\nunhealthy\nThe message displayed when\nmise\nis unhealthy.\ndisabled\ntrue\nDisables the\nmise\nmodule.\nVariables\n\nVariable\nExample\nDescription\nhealth\nhealthy\nThe health of\nmise\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nmise\n]\nhealth =\n'ready'\nMojo\n\nThe\nmojo\nmodule shows the current version of\nMojo programming language\ninstalled\nOptions\n\nOption\nDefault\nDescription\nformat\n'with [$symbol($version )]($style)'\nThe format for the module.\nsymbol\n'🔥 '\nThe symbol used before displaying the version of Mojo.\nstyle\n'bold 208'\nThe style for the module.\ndisabled\nfalse\nDisables the\nmojo\nmodule.\ndetect_extensions\n['mojo', '🔥']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nVariables\n\nVariable\nExample\nDescription\nversion\n24.4.0\nThe version of\nmojo\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nmojo\n]\nformat =\n'via [mojo ($version )($hash )]($style)'\nNATS\n\nThe\nnats\nmodule shows the name of the current\nNATS\ncontext.\nOptions\n\nOption\nDefault\nDescription\nsymbol\n'✉️ '\nThe symbol used before the NATS context (defaults to empty).\nstyle\n'bold purple'\nThe style for the module.\nformat\n'[$symbol$name]($style)'\nThe format for the module.\ndisabled\nfalse\nDisables the\nnats\nmodule.\nVariables\n\nVariable\nExample\nDescription\nname\nlocalhost\nThe name of the NATS context\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\nExample\n\ntoml\n[\nnats\n]\nformat =\n'[$symbol]($style)'\nstyle =\n'bold purple'\nNetwork Namespace\n\nThe\nnetns\nmodule shows the current network namespace. This uses\nip netns identify\nto get the network namespace, so only network namespaces mounted at\n\/var\/run\/netns\nwill be detected.\nOptions\n\nOption\nDefault\nDescription\nformat\n'[$symbol \\[$name\\]]($style)'\nThe format for the module.\nsymbol\n'🛜 '\nThe symbol used before the network namespace (defaults to empty).\nstyle\n'blue bold dimmed'\nThe style for the module.\ndisabled\nfalse\nDisables the\nnetns\nmodule.\nVariables\n\nVariable\nExample\nDescription\nname\nmy-netns\nThe name of the current network namespace\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nnetns\n]\nstyle =\n'bold yellow'\nsymbol =\n'🌐 '\nNim\n\nThe\nnim\nmodule shows the currently installed version of\nNim\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nnim.cfg\nfile\nThe current directory contains a file with the\n.nim\nextension\nThe current directory contains a file with the\n.nims\nextension\nThe current directory contains a file with the\n.nimble\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'👑 '\nThe symbol used before displaying the version of Nim.\ndetect_extensions\n['nim', 'nims', 'nimble']\nWhich extensions should trigger this module.\ndetect_files\n['nim.cfg']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'bold yellow'\nThe style for the module.\ndisabled\nfalse\nDisables the\nnim\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.2.0\nThe version of\nnimc\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nnim\n]\nstyle =\n'yellow'\nsymbol =\n'🎣 '\nNix-shell\n\nThe\nnix_shell\nmodule shows the\nnix-shell\nenvironment. The module will be shown when inside a nix-shell environment.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol$state( \$$name\$)]($style) '\nThe format for the module.\nsymbol\n'❄️ '\nA format string representing the symbol of nix-shell.\nstyle\n'bold blue'\nThe style for the module.\nimpure_msg\n'impure'\nA format string shown when the shell is impure.\npure_msg\n'pure'\nA format string shown when the shell is pure.\nunknown_msg\n''\nA format string shown when it is unknown if the shell is pure\/impure.\ndisabled\nfalse\nDisables the\nnix_shell\nmodule.\nheuristic\nfalse\nAttempts to detect new\nnix shell\n-style shells with a heuristic.\nVariables\n\nVariable\nExample\nDescription\nstate\npure\nThe state of the nix-shell\nname\nlorri\nThe name of the nix-shell\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nnix_shell\n]\ndisabled =\ntrue\nimpure_msg =\n'[impure shell](bold red)'\npure_msg =\n'[pure shell](bold green)'\nunknown_msg =\n'[unknown shell](bold yellow)'\nformat =\n'via [☃️ $state( \$$name\$)](bold blue) '\nNode.js\n\nThe\nnodejs\nmodule shows the currently installed version of\nNode.js\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\npackage.json\nfile\nThe current directory contains a\n.node-version\nfile\nThe current directory contains a\n.nvmrc\nfile\nThe current directory contains a\nnode_modules\ndirectory\nThe current directory contains a file with the\n.js\n,\n.mjs\nor\n.cjs\nextension\nThe current directory contains a file with the\n.ts\n,\n.mts\nor\n.cts\nextension\nAdditionally, the module will be hidden by default if the directory contains a\nbunfig.toml\n,\nbun.lock\n, or\nbun.lockb\nfile, overriding the above conditions.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n' '\nA format string representing the symbol of Node.js.\ndetect_extensions\n['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']\nWhich extensions should trigger this module.\ndetect_files\n['package.json', '.node-version', '.nvmrc']\nWhich filenames should trigger this module.\ndetect_folders\n['node_modules']\nWhich folders should trigger this module.\nstyle\n'bold green'\nThe style for the module.\ndisabled\nfalse\nDisables the\nnodejs\nmodule.\nnot_capable_style\n'bold red'\nThe style for the module when an engines property in package.json does not match the Node.js version.\nVariables\n\nVariable\nExample\nDescription\nversion\nv13.12.0\nThe version of\nnode\nengines_version\n>=12.0.0\nnode\nversion requirement as set in the engines property of\npackage.json\n. Will only show if the version requirement does not match the\nnode\nversion.\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nnodejs\n]\nformat =\n'via [🤖 $version](bold green) '\nOCaml\n\nThe\nocaml\nmodule shows the currently installed version of\nOCaml\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a file with\n.opam\nextension or\n_opam\ndirectory\nThe current directory contains a\nesy.lock\ndirectory\nThe current directory contains a\ndune\nor\ndune-project\nfile\nThe current directory contains a\njbuild\nor\njbuild-ignore\nfile\nThe current directory contains a\n.merlin\nfile\nThe current directory contains a file with\n.ml\n,\n.mli\n,\n.re\nor\n.rei\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )(\$$switch_indicator$switch_name\$ )]($style)'\nThe format string for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🐫 '\nThe symbol used before displaying the version of OCaml.\nglobal_switch_indicator\n''\nThe format string used to represent global OPAM switch.\nlocal_switch_indicator\n'*'\nThe format string used to represent local OPAM switch.\ndetect_extensions\n['opam', 'ml', 'mli', 're', 'rei']\nWhich extensions should trigger this module.\ndetect_files\n['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']\nWhich filenames should trigger this module.\ndetect_folders\n['_opam', 'esy.lock']\nWhich folders should trigger this module.\nstyle\n'bold yellow'\nThe style for the module.\ndisabled\nfalse\nDisables the\nocaml\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv4.10.0\nThe version of\nocaml\nswitch_name\nmy-project\nThe active OPAM switch\nswitch_indicator\nMirrors the value of\nindicator\nfor currently active OPAM switch\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nocaml\n]\nformat =\n'via [🐪 $version]($style) '\nOdin\n\nThe\nodin\nmodule shows the currently installed version of\nOdin\n. By default the module will be shown if the current directory contains a\n.odin\nfile.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nshow_commit\nfalse\nShows the commit as part of the version.\nsymbol\n'Ø '\nThe symbol used before displaying the version of Odin.\nstyle\n'bold bright-blue'\nThe style for the module.\ndisabled\nfalse\nDisables the\nodin\nmodule.\ndetect_extensions\n['odin']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nVariables\n\nVariable\nExample\nDescription\nversion\ndev-2024-03\nThe version of\nodin\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nodin\n]\nformat =\n'via [󰹩 ($version )]($style)'\nshow_commit =\ntrue\nOpen Policy Agent\n\nThe\nopa\nmodule shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a\n.rego\nfile.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🪖 '\nA format string representing the symbol of OPA.\ndetect_extensions\n['rego']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'bold blue'\nThe style for the module.\ndisabled\nfalse\nDisables the\nopa\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.44.0\nThe version of\nopa\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nopa\n]\nformat =\n'via [⛑️  $version](bold red) '\nOpenStack\n\nThe\nopenstack\nmodule shows the current OpenStack cloud and project. The module only active when the\nOS_CLOUD\nenv var is set, in which case it will read\nclouds.yaml\nfile from any of the\ndefault locations\n. to fetch the current project in use.\nOptions\n\nOption\nDefault\nDescription\nformat\n'on [$symbol$cloud(\$$project\$)]($style) '\nThe format for the module.\nsymbol\n'☁️ '\nThe symbol used before displaying the current OpenStack cloud.\nstyle\n'bold yellow'\nThe style for the module.\ndisabled\nfalse\nDisables the\nopenstack\nmodule.\nVariables\n\nVariable\nExample\nDescription\ncloud\ncorp\nThe current OpenStack cloud\nproject\ndev\nThe current OpenStack project\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nopenstack\n]\nformat =\n'on [$symbol$cloud(\$$project\$)]($style) '\nstyle =\n'bold yellow'\nsymbol =\n'☁️ '\nOS\n\nThe\nos\nmodule shows the current operating system. OS information is detected via the\nos_info\ncrate.\nWARNING\nThe\nos_info\ncrate used by this module is known to be inaccurate on some systems.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nformat\n'[$symbol]($style)'\nThe format for the module.\nstyle\n'bold white'\nThe style for the module.\ndisabled\ntrue\nDisables the\nos\nmodule.\nsymbols\nA table that maps each operating system to its symbol.\nsymbols\nallows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a\nfeature request\n.\ntoml\n# This is the default symbols table.\n[\nos\n.\nsymbols\n]\nAIX =\n\"➿ \"\nAlpaquita =\n\"🔔 \"\nAlmaLinux =\n\"💠 \"\nAlpine =\n\"🏔️ \"\nALTLinux =\n\"Ⓐ \"\nAmazon =\n\"🙂 \"\nAndroid =\n\"🤖 \"\nAOSC =\n\"🐱 \"\nArch =\n\"🎗️ \"\nArtix =\n\"🎗️ \"\nBluefin =\n\"🐟 \"\nCachyOS =\n\"🎗️ \"\nCentOS =\n\"💠 \"\nDebian =\n\"🌀 \"\nDragonFly =\n\"🐉 \"\nElementary =\n\"🍏 \"\nEmscripten =\n\"🔗 \"\nEndeavourOS =\n\"🚀 \"\nFedora =\n\"🎩 \"\nFreeBSD =\n\"😈 \"\nGaruda =\n\"🦅 \"\nGentoo =\n\"🗜️ \"\nHardenedBSD =\n\"🛡️ \"\nIllumos =\n\"🐦 \"\nIos =\n\"📱 \"\nInstantOS =\n\"⏲️ \"\nKali =\n\"🐉 \"\nLinux =\n\"🐧 \"\nMabox =\n\"📦 \"\nMacos =\n\"🍎 \"\nManjaro =\n\"🥭 \"\nMariner =\n\"🌊 \"\nMidnightBSD =\n\"🌘 \"\nMint =\n\"🌿 \"\nNetBSD =\n\"🚩 \"\nNixOS =\n\"❄️ \"\nNobara =\n\"🎩 \"\nOpenBSD =\n\"🐡 \"\nOpenCloudOS =\n\"☁️ \"\nopenEuler =\n\"🦉 \"\nopenSUSE =\n\"🦎 \"\nOracleLinux =\n\"🦴 \"\nPikaOS =\n\"🐤 \"\nPop =\n\"🍭 \"\nRaspbian =\n\"🍓 \"\nRedhat =\n\"🎩 \"\nRedHatEnterprise =\n\"🎩 \"\nRockyLinux =\n\"💠 \"\nRedox =\n\"🧪 \"\nSolus =\n\"⛵ \"\nSUSE =\n\"🦎 \"\nUbuntu =\n\"🎯 \"\nUltramarine =\n\"🔷 \"\nUnknown =\n\"❓ \"\nUos =\n\"🐲 \"\nVoid =\n\" \"\nWindows =\n\"🪟 \"\nZorin =\n\"🔹 \"\nVariables\n\nVariable\nExample\nDescription\nsymbol\n🎗️\nThe current operating system symbol from advanced option\nsymbols\nname\nArch Linux\nThe current operating system name\ntype\nArch\nThe current operating system type\ncodename\nThe current operating system codename, if applicable\nedition\nThe current operating system edition, if applicable\nversion\nThe current operating system version, if applicable\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nos\n]\nformat =\n\"on [($name )]($style)\"\nstyle =\n\"bold blue\"\ndisabled =\nfalse\n[\nos\n.\nsymbols\n]\nWindows =\n\" \"\nArch =\n\"Arch is the best! \"\nPackage Version\n\nThe\npackage\nmodule is shown when the current directory is the repository for a package, and shows its current version. The module currently supports\nnpm\n,\nnimble\n,\ncargo\n,\npoetry\n,\npython\n,\ncomposer\n,\ngradle\n,\njulia\n,\nmix\n,\nhelm\n,\nshards\n,\ngalaxy\n,\ndaml\nand\ndart\npackages.\nnpm\n– The\nnpm\npackage version is extracted from the\npackage.json\npresent in the current directory\nJSR\n– The\njsr\npackage version is extracted from the\njsr.json\n\/\njsr.jsonc\nor\ndeno.json\n\/\ndeno.jsonc\npresent in the current directory\nCargo\n– The\ncargo\npackage version is extracted from the\nCargo.toml\npresent in the current directory\nNimble\n- The\nnimble\npackage version is extracted from the\n*.nimble\nfile present in the current directory with the\nnimble dump\ncommand\nPoetry\n– The\npoetry\npackage version is extracted from the\npyproject.toml\npresent in the current directory\nPython\n- The\npython\npackage version is extracted from a\nPEP 621\ncompliant\npyproject.toml\nor a\nsetup.cfg\npresent in the current directory\nComposer\n– The\ncomposer\npackage version is extracted from the\ncomposer.json\npresent in the current directory\nGradle\n– The\ngradle\npackage version is extracted from the\nbuild.gradle\npresent in the current directory\nJulia\n- The package version is extracted from the\nProject.toml\npresent in the current directory\nMix\n- The\nmix\npackage version is extracted from the\nmix.exs\npresent in the current directory\nHelm\n- The\nhelm\nchart version is extracted from the\nChart.yaml\npresent in the current directory\nMaven\n- The\nmaven\npackage version is extracted from the\npom.xml\npresent in the current directory\nMeson\n- The\nmeson\npackage version is extracted from the\nmeson.build\npresent in the current directory\nShards\n- The\nshards\npackage version is extracted from the\nshard.yml\npresent in the current directory\nGalaxy\n- The\ngalaxy\npackage version is extracted from the\ngalaxy.yml\npresent in the current directory\nV\n- The\nvlang\npackage version is extracted from the\nv.mod\npresent in the current directory\nSBT\n- The\nsbt\npackage version is extracted from the\nbuild.sbt\npresent in the current directory\nDaml\n- The\ndaml\npackage version is extracted from the\ndaml.yaml\npresent in the current directory\nDart\n- The\ndart\npackage version is extracted from the\npubspec.yaml\npresent in the current directory\n⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.\nOptions\n\nOption\nDefault\nDescription\nformat\n'is [$symbol$version]($style) '\nThe format for the module.\nsymbol\n'📦 '\nThe symbol used before displaying the version the package.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nstyle\n'bold 208'\nThe style for the module.\ndisplay_private\nfalse\nEnable displaying version for packages marked as private.\ndisabled\nfalse\nDisables the\npackage\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.0.0\nThe version of your package\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\npackage\n]\nformat =\n'via [🎁 $version](208 bold) '\nPerl\n\nThe\nperl\nmodule shows the currently installed version of\nPerl\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nMakefile.PL\nor\nBuild.PL\nfile\nThe current directory contains a\ncpanfile\nor\ncpanfile.snapshot\nfile\nThe current directory contains a\nMETA.json\nfile or\nMETA.yml\nfile\nThe current directory contains a\n.perl-version\nfile\nThe current directory contains a\n.pl\n,\n.pm\nor\n.pod\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format string for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🐪 '\nThe symbol used before displaying the version of Perl\ndetect_extensions\n['pl', 'pm', 'pod']\nWhich extensions should trigger this module.\ndetect_files\n['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'bold 149'\nThe style for the module.\ndisabled\nfalse\nDisables the\nperl\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv5.26.1\nThe version of\nperl\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nperl\n]\nformat =\n'via [🦪 $version]($style) '\nPHP\n\nThe\nphp\nmodule shows the currently installed version of\nPHP\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\ncomposer.json\nfile\nThe current directory contains a\n.php-version\nfile\nThe current directory contains a\n.php\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🐘 '\nThe symbol used before displaying the version of PHP.\ndetect_extensions\n['php']\nWhich extensions should trigger this module.\ndetect_files\n['composer.json', '.php-version']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'147 bold'\nThe style for the module.\ndisabled\nfalse\nDisables the\nphp\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv7.3.8\nThe version of\nphp\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nphp\n]\nformat =\n'via [🔹 $version](147 bold) '\nPijul Channel\n\nThe\npijul_channel\nmodule shows the active channel of the repo in your current directory.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nsymbol\n' '\nThe symbol used before the pijul channel name of the repo in your current directory.\nstyle\n'bold purple'\nThe style for the module.\nformat\n'on [$symbol$channel]($style) '\nThe format for the module.\ntruncation_length\n2^63 - 1\nTruncates the pijul channel name to\nN\ngraphemes\ntruncation_symbol\n'…'\nThe symbol used to indicate a branch name was truncated.\ndisabled\ntrue\nDisables the\npijul\nmodule.\nPixi\n\nThe\npixi\nmodule shows the installed\npixi\nversion as well as the activated environment, if\n$PIXI_ENVIRONMENT_NAME\nis set.\nTIP\nThis does not suppress pixi's own prompt modifier, you may want to run\npixi config set shell.change-ps1 false\n.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )(\$$environment\$ )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\n.\nsymbol\n'🧚 '\nThe symbol used before the environment name.\nstyle\n'yellow bold'\nThe style for the module.\nshow_default_environment\ntrue\nWhether to indicate that the\ndefault\nenvironment of your project is activated.\npixi_binary\n['pixi']\nConfigures the pixi binary that Starship should execute when getting the version.\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['pixi.toml']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ndisabled\nfalse\nDisables the\npixi\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.33.0\nThe version of\npixi\nenvironment\npy311\nThe current pixi environment\nsymbol\nMirrors the value of option\nsymbol\nstyle\nMirrors the value of option\nstyle\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\npixi\n]\nformat =\n'[$symbol$environment](yellow) '\nPulumi\n\nThe\npulumi\nmodule shows the current username, selected\nPulumi Stack\n, and version.\nTIP\nBy default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it,\nfollow the example shown below\n.\nBy default the module will be shown if any of the following conditions are met:\nThe current directory contains either\nPulumi.yaml\nor\nPulumi.yml\nA parent directory contains either\nPulumi.yaml\nor\nPulumi.yml\nunless\nsearch_upwards\nis set to\nfalse\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($username@)$stack]($style) '\nThe format string for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n' '\nA format string shown before the Pulumi stack.\nstyle\n'bold 5'\nThe style for the module.\nsearch_upwards\ntrue\nEnable discovery of pulumi config files in parent directories.\ndisabled\nfalse\nDisables the\npulumi\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.12.24\nThe version of\npulumi\nstack\ndev\nThe current Pulumi stack\nusername\nalice\nThe current Pulumi username\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\nWith Pulumi Version\n\ntoml\n# ~\/.config\/starship.toml\n[\npulumi\n]\nformat =\n'[🛥 ($version )$stack]($style) '\nWithout Pulumi version\n\ntoml\n# ~\/.config\/starship.toml\n[\npulumi\n]\nsymbol =\n'🛥 '\nformat =\n'[$symbol$stack]($style) '\nPureScript\n\nThe\npurescript\nmodule shows the currently installed version of\nPureScript\nversion. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nspago.dhall\nfile\nThe current directory contains a\nspago.yaml\nfile\nThe current directory contains a\nspago.lock\nfile\nThe current directory contains a file with the\n.purs\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'<=> '\nThe symbol used before displaying the version of PureScript.\ndetect_extensions\n['purs']\nWhich extensions should trigger this module.\ndetect_files\n['spago.dhall', 'spago.yaml', 'spago.lock']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'bold white'\nThe style for the module.\ndisabled\nfalse\nDisables the\npurescript\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\n0.13.5\nThe version of\npurescript\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\npurescript\n]\nformat =\n'via [$symbol$version](bold white)'\nPython\n\nThe\npython\nmodule shows the currently installed version of\nPython\nand the current\nPython virtual environment\nif one is activated.\nIf\npyenv_version_name\nis set to\ntrue\n, it will display the pyenv version name. Otherwise, it will display the version number from\npython --version\n.\nBy default, the module will be shown if any of the following conditions are met:\nThe current directory contains a\n.python-version\nfile\nThe current directory contains a\nPipfile\nfile\nThe current directory contains a\n__init__.py\nfile\nThe current directory contains a\npyproject.toml\nfile\nThe current directory contains a\nrequirements.txt\nfile\nThe current directory contains a\nsetup.py\nfile\nThe current directory contains a\ntox.ini\nfile\nThe current directory contains a file with the\n.py\nextension.\nThe current directory contains a file with the\n.ipynb\nextension.\nA virtual environment is currently activated\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [${symbol}${pyenv_prefix}(${version} )(\$$virtualenv\$ )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🐍 '\nA format string representing the symbol of Python\nstyle\n'yellow bold'\nThe style for the module.\npyenv_version_name\nfalse\nUse pyenv to get Python version\npyenv_prefix\n'pyenv'\nPrefix before pyenv version display, only used if pyenv is used\npython_binary\n['python', 'python3', 'python2']\nConfigures the python binaries that Starship should execute when getting the version.\ndetect_extensions\n['py', 'ipynb']\nWhich extensions should trigger this module\ndetect_files\n['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']\nWhich filenames should trigger this module\ndetect_folders\n[]\nWhich folders should trigger this module\ndisabled\nfalse\nDisables the\npython\nmodule.\nTIP\nThe\npython_binary\nvariable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.\nThe default values and order for\npython_binary\nwas chosen to first identify the Python version in a virtualenv\/conda environments (which currently still add a\npython\n, no matter if it points to\npython3\nor\npython2\n). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink\n\/usr\/bin\/python\nto Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to\n'python3'\nwill hide any Python version 2, see example below.\nVariables\n\nVariable\nExample\nDescription\nversion\n'v3.8.1'\nThe version of\npython\nsymbol\n'🐍 '\nMirrors the value of option\nsymbol\nstyle\n'yellow bold'\nMirrors the value of option\nstyle\npyenv_prefix\n'pyenv '\nMirrors the value of option\npyenv_prefix\nvirtualenv\n'venv'\nThe current\nvirtualenv\nname\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\npython\n]\nsymbol =\n'👾 '\npyenv_version_name =\ntrue\ntoml\n# ~\/.config\/starship.toml\n[\npython\n]\n# Only use the `python3` binary to get the version.\npython_binary =\n'python3'\ntoml\n# ~\/.config\/starship.toml\n[\npython\n]\n# Don't trigger for files with the py extension\ndetect_extensions = []\nQuarto\n\nThe\nquarto\nmodule shows the current installed version of Quarto used in a project.\nBy default, the module will be shown if any of the following conditions are met:\nThe current directory contains a\n_quarto.yml\nfile\nThe current directory contains any\n*.qmd\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'⨁ '\nA format string representing the symbol of Quarto\nstyle\n'bold #75AADB'\nThe style for the module.\ndetect_extensions\n['.qmd']\nWhich extensions should trigger this module.\ndetect_files\n['_quarto.yml']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ndisabled\nfalse\nDisables the\nquarto\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\n1.4.549\nThe version of\nquarto\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nR\n\nThe\nrlang\nmodule shows the currently installed version of\nR\n. The module will be shown if any of the following conditions are met:\nThe current directory contains a file with the\n.R\nextension.\nThe current directory contains a file with the\n.Rd\nextension.\nThe current directory contains a file with the\n.Rmd\nextension.\nThe current directory contains a file with the\n.Rproj\nextension.\nThe current directory contains a file with the\n.Rsx\nextension.\nThe current directory contains a\n.Rprofile\nfile\nThe current directory contains a\n.Rproj.user\nfolder\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'📐'\nA format string representing the symbol of R.\nstyle\n'blue bold'\nThe style for the module.\ndetect_extensions\n['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']\nWhich extensions should trigger this module\ndetect_files\n['.Rprofile']\nWhich filenames should trigger this module\ndetect_folders\n['.Rproj.user']\nWhich folders should trigger this module\ndisabled\nfalse\nDisables the\nr\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv4.0.5\nThe version of\nR\nsymbol\nMirrors the value of option\nsymbol\nstyle\n'blue bold'\nMirrors the value of option\nstyle\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nrlang\n]\nformat =\n'with [📐 $version](blue bold) '\nRaku\n\nThe\nraku\nmodule shows the currently installed version of\nRaku\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nMETA6.json\nfile\nThe current directory contains a\n.p6\n,\n.pm6\n,\n.raku\n,\n.rakumod\nor\n.pod6\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version-$vm_version )]($style)'\nThe format string for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🦋 '\nThe symbol used before displaying the version of Raku\ndetect_extensions\n['p6', 'pm6', 'pod6', 'raku', 'rakumod']\nWhich extensions should trigger this module.\ndetect_files\n['META6.json']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'bold 149'\nThe style for the module.\ndisabled\nfalse\nDisables the\nraku\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv6.d\nThe version of\nraku\nvm_version\nmoar\nThe version of VM\nraku\nis built on\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nraku\n]\nformat =\n'via [🦪 $version]($style) '\nRed\n\nBy default the\nred\nmodule shows the currently installed version of\nRed\n. The module will be shown if any of the following conditions are met:\nThe current directory contains a file with\n.red\nor\n.reds\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🔺 '\nA format string representing the symbol of Red.\ndetect_extensions\n['red']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'red bold'\nThe style for the module.\ndisabled\nfalse\nDisables the\nred\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv2.5.1\nThe version of\nred\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nred\n]\nsymbol =\n'🔴 '\nRuby\n\nBy default the\nruby\nmodule shows the currently installed version of\nRuby\n. The module will be shown if any of the following conditions are met:\nThe current directory contains a\nGemfile\nfile\nThe current directory contains a\n.ruby-version\nfile\nThe current directory contains a\n.rb\nfile\nThe environment variables\nRUBY_VERSION\nor\nRBENV_VERSION\nare set\nStarship gets the current Ruby version by running\nruby -v\n.\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'💎 '\nA format string representing the symbol of Ruby.\ndetect_extensions\n['rb']\nWhich extensions should trigger this module.\ndetect_files\n['Gemfile', '.ruby-version']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ndetect_variables\n['RUBY_VERSION', 'RBENV_VERSION']\nWhich environment variables should trigger this module.\nstyle\n'bold red'\nThe style for the module.\ndisabled\nfalse\nDisables the\nruby\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv2.5.1\nThe version of\nruby\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\ngemset\ntest\nOptional, gets the current RVM gemset name.\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nruby\n]\nsymbol =\n'🔺 '\nRust\n\nBy default the\nrust\nmodule shows the currently installed version of\nRust\n. The module will be shown if any of the following conditions are met:\nThe current directory contains a\nCargo.toml\nfile\nThe current directory contains a file with the\n.rs\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🦀 '\nA format string representing the symbol of Rust\ndetect_extensions\n['rs']\nWhich extensions should trigger this module.\ndetect_files\n['Cargo.toml']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'bold red'\nThe style for the module.\ndisabled\nfalse\nDisables the\nrust\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv1.43.0-nightly\nThe version of\nrustc\nnumver\n1.51.0\nThe numeric component of the\nrustc\nversion\ntoolchain\nbeta\nThe toolchain version\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nrust\n]\nformat =\n'via [⚙️ $version](red bold)'\nScala\n\nThe\nscala\nmodule shows the currently installed version of\nScala\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nbuild.sbt\n,\n.scalaenv\nor\n.sbtenv\nfile\nThe current directory contains a file with the\n.scala\nor\n.sbt\nextension\nThe current directory contains a directory named\n.metals\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [${symbol}(${version} )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\ndetect_extensions\n['sbt', 'scala']\nWhich extensions should trigger this module.\ndetect_files\n['.scalaenv', '.sbtenv', 'build.sbt']\nWhich filenames should trigger this module.\ndetect_folders\n['.metals']\nWhich folders should trigger this modules.\nsymbol\n'🆂 '\nA format string representing the symbol of Scala.\nstyle\n'red dimmed'\nThe style for the module.\ndisabled\nfalse\nDisables the\nscala\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\n2.13.5\nThe version of\nscala\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nscala\n]\nsymbol =\n'🌟 '\nShell\n\nThe\nshell\nmodule shows an indicator for currently used shell.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nbash_indicator\n'bsh'\nA format string used to represent bash.\nfish_indicator\n'fsh'\nA format string used to represent fish.\nzsh_indicator\n'zsh'\nA format string used to represent zsh.\npowershell_indicator\n'psh'\nA format string used to represent powershell.\npwsh_indicator\nA format string used to represent pwsh. The default value mirrors the value of\npowershell_indicator\n.\nion_indicator\n'ion'\nA format string used to represent ion.\nelvish_indicator\n'esh'\nA format string used to represent elvish.\ntcsh_indicator\n'tsh'\nA format string used to represent tcsh.\nxonsh_indicator\n'xsh'\nA format string used to represent xonsh.\ncmd_indicator\n'cmd'\nA format string used to represent cmd.\nnu_indicator\n'nu'\nA format string used to represent nu.\nunknown_indicator\n''\nThe default value to be displayed when the shell is unknown.\nformat\n'[$indicator]($style) '\nThe format for the module.\nstyle\n'white bold'\nThe style for the module.\ndisabled\ntrue\nDisables the\nshell\nmodule.\nVariables\n\nVariable\nDefault\nDescription\nindicator\nMirrors the value of\nindicator\nfor currently used shell.\nstyle*\nMirrors the value of option\nstyle\n.\n*: This variable can only be used as a part of a style string\nExamples\n\ntoml\n# ~\/.config\/starship.toml\n[\nshell\n]\nfish_indicator =\n'󰈺 '\npowershell_indicator =\n'_'\nunknown_indicator =\n'mystery shell'\nstyle =\n'cyan bold'\ndisabled =\nfalse\nSHLVL\n\nThe\nshlvl\nmodule shows the current\nSHLVL\n('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nthreshold\n2\nDisplay threshold.\nformat\n'[$symbol$shlvl]($style) '\nThe format for the module.\nsymbol\n'↕️ '\nThe symbol used to represent the\nSHLVL\n.\nrepeat\nfalse\nCauses\nsymbol\nto be repeated by the current\nSHLVL\namount.\nrepeat_offset\n0\nDecrements number of times\nsymbol\nis repeated by the offset value\nstyle\n'bold yellow'\nThe style for the module.\ndisabled\ntrue\nDisables the\nshlvl\nmodule.\nVariables\n\nVariable\nExample\nDescription\nshlvl\n3\nThe current value of\nSHLVL\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nshlvl\n]\ndisabled =\nfalse\nformat =\n'$shlvl level(s) down'\nthreshold =\n3\nUsing\nrepeat\nand\nrepeat_offset\nalong with\ncharacter\nmodule, one can get prompt like\n❯❯❯\nwhere last character is colored appropriately for return status code and preceding characters are provided by\nshlvl\n.\ntoml\n# ~\/.config\/starship.toml\n[\nshlvl\n]\ndisabled =\nfalse\nformat =\n'[$symbol]($style)'\nrepeat =\ntrue\nsymbol =\n'❯'\nrepeat_offset =\n1\nSingularity\n\nThe\nsingularity\nmodule shows the current\nSingularity\nimage, if inside a container and\n$SINGULARITY_NAME\nis set.\nOptions\n\nOption\nDefault\nDescription\nformat\n'[$symbol\\[$env\\]]($style) '\nThe format for the module.\nsymbol\n''\nA format string displayed before the image name.\nstyle\n'bold dimmed blue'\nThe style for the module.\ndisabled\nfalse\nDisables the\nsingularity\nmodule.\nVariables\n\nVariable\nExample\nDescription\nenv\ncentos.img\nThe current Singularity image\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nsingularity\n]\nformat =\n'[📦 \\[$env\\]]($style) '\nSolidity\n\nThe\nsolidity\nmodule shows the currently installed version of\nSolidity\nThe module will be shown if any of the following conditions are met:\nThe current directory contains a file with the\n.sol\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${major}.${minor}.${patch}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'S '\nA format string representing the symbol of Solidity\n`compiler\n['solc']\nThe default compiler for Solidity.\ndetect_extensions\n['sol']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'bold blue'\nThe style for the module.\ndisabled\nfalse\nDisables this module.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.8.1\nThe version of\nsolidity\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nsolidity\n]\nformat =\n\"via [S $version](blue bold)\"\nSpack\n\nThe\nspack\nmodule shows the current\nSpack\nenvironment, if\n$SPACK_ENV\nis set.\nOptions\n\nOption\nDefault\nDescription\ntruncation_length\n1\nThe number of directories the environment path should be truncated to.\n0\nmeans no truncation. Also see the\ndirectory\nmodule.\nsymbol\n'🅢 '\nThe symbol used before the environment name.\nstyle\n'bold blue'\nThe style for the module.\nformat\n'via [$symbol$environment]($style) '\nThe format for the module.\ndisabled\nfalse\nDisables the\nspack\nmodule.\nVariables\n\nVariable\nExample\nDescription\nenvironment\nastronauts\nThe current spack environment\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nspack\n]\nformat =\n'[$symbol$environment](dimmed blue) '\nStatus\n\nThe\nstatus\nmodule displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not\n0\n. The status code will cast to a signed 32-bit integer.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nformat\n'[$symbol$status]($style) '\nThe format of the module\nsymbol\n'❌'\nThe symbol displayed on program error\nsuccess_symbol\n''\nThe symbol displayed on program success\nnot_executable_symbol\n'🚫'\nThe symbol displayed when file isn't executable\nnot_found_symbol\n'🔍'\nThe symbol displayed when the command can't be found\nsigint_symbol\n'🧱'\nThe symbol displayed on SIGINT (Ctrl + c)\nsignal_symbol\n'⚡'\nThe symbol displayed on any signal\nstyle\n'bold red'\nThe style for the module.\nsuccess_style\nThe style used on program success (defaults to\nstyle\nif unset).\nfailure_style\nThe style used on program failure (defaults to\nstyle\nif unset).\nrecognize_signal_code\ntrue\nEnable signal mapping from exit code\nmap_symbol\nfalse\nEnable symbols mapping from exit code\npipestatus\nfalse\nEnable pipestatus reporting\npipestatus_separator\n|\nThe symbol used to separate pipestatus segments (supports formatting)\npipestatus_format\n'\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) '\nThe format of the module when the command is a pipeline\npipestatus_segment_format\nWhen specified, replaces\nformat\nwhen formatting pipestatus segments\ndisabled\ntrue\nDisables the\nstatus\nmodule.\nVariables\n\nVariable\nExample\nDescription\nstatus\n127\nThe exit code of the last command\nhex_status\n0x7F\nThe exit code of the last command in hex\nint\n127\nThe exit code of the last command\ncommon_meaning\nERROR\nMeaning of the code if not a signal\nsignal_number\n9\nSignal number corresponding to the exit code, only if signalled\nsignal_name\nKILL\nName of the signal corresponding to the exit code, only if signalled\nmaybe_int\n7\nContains the exit code number when no meaning has been found\npipestatus\nRendering of in pipeline programs' exit codes, this is only available in pipestatus_format\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nsuccess_style\non program success and\nfailure_style\notherwise\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nstatus\n]\nstyle =\n'bg:blue'\nsymbol =\n'🔴 '\nsuccess_symbol =\n'🟢 SUCCESS'\nformat =\n'[\\[$symbol$common_meaning$signal_name$maybe_int\\]]($style) '\nmap_symbol =\ntrue\ndisabled =\nfalse\nSudo\n\nThe\nsudo\nmodule displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nformat\n'[as $symbol]($style)'\nThe format of the module\nsymbol\n'🧙 '\nThe symbol displayed when credentials are cached\nstyle\n'bold blue'\nThe style for the module.\nallow_windows\nfalse\nSince windows has no default sudo, default is disabled.\ndisabled\ntrue\nDisables the\nsudo\nmodule.\nVariables\n\nVariable\nExample\nDescription\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nsudo\n]\nstyle =\n'bold green'\nsymbol =\n'👩‍💻 '\ndisabled =\nfalse\ntoml\n# On windows\n# $HOME\\.starship\\config.toml\n[\nsudo\n]\nallow_windows =\ntrue\ndisabled =\nfalse\nSwift\n\nBy default the\nswift\nmodule shows the currently installed version of\nSwift\n. The module will be shown if any of the following conditions are met:\nThe current directory contains a\nPackage.swift\nfile\nThe current directory contains a file with the\n.swift\nextension\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'🐦 '\nA format string representing the symbol of Swift\ndetect_extensions\n['swift']\nWhich extensions should trigger this module.\ndetect_files\n['Package.swift']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'bold 202'\nThe style for the module.\ndisabled\nfalse\nDisables the\nswift\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv5.2.4\nThe version of\nswift\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nswift\n]\nformat =\n'via [🏎  $version](red bold)'\nTerraform\n\nThe\nterraform\nmodule shows the currently selected\nTerraform workspace\nand version. It supports both Hashicorp Terraform and OpenTofu for version detection.\nTIP\nBy default the Terraform\/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it,\nfollow the example shown below\n.\nBy default the module will be shown if any of the following conditions are met:\nThe current directory contains a\n.terraform\nfolder\nCurrent directory contains a file with the\n.tf\n,\n.tfplan\nor\n.tfstate\nextensions\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol$workspace]($style) '\nThe format string for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'💠'\nA format string shown before the terraform workspace.\ndetect_extensions\n['tf', 'tfplan', 'tfstate']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n['.terraform']\nWhich folders should trigger this module.\nstyle\n'bold 105'\nThe style for the module.\ndisabled\nfalse\nDisables the\nterraform\nmodule.\ncommands\n[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]\nHow to detect what the Terraform version is.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.12.24\nThe version of\nterraform\nworkspace\ndefault\nThe current Terraform workspace\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\nWith Terraform Version\n\ntoml\n# ~\/.config\/starship.toml\n[\nterraform\n]\nformat =\n'via [$symbol$version $workspace]($style) '\nWithout Terraform version\n\ntoml\n# ~\/.config\/starship.toml\n[\nterraform\n]\nformat =\n'via [$symbol$workspace]($style) '\nTime\n\nThe\ntime\nmodule shows the current\nlocal\ntime. The\nformat\nconfiguration value is used by the\nchrono\ncrate to control how the time is displayed. Take a look\nat the chrono strftime docs\nto see what options are available.\nTIP\nThis module is disabled by default. To enable it, set\ndisabled\nto\nfalse\nin your configuration file.\nOptions\n\nOption\nDefault\nDescription\nformat\n'at [$time]($style) '\nThe format string for the module.\nuse_12hr\nfalse\nEnables 12 hour formatting\ntime_format\nsee below\nThe\nchrono format string\nused to format the time.\nstyle\n'bold yellow'\nThe style for the module time\nutc_time_offset\n'local'\nSets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30\/45 minute timezone offsets.\ndisabled\ntrue\nDisables the\ntime\nmodule.\ntime_range\n'-'\nSets the time range during which the module will be shown. Times must be specified in 24-hours format\nIf\nuse_12hr\nis\ntrue\n, then\ntime_format\ndefaults to\n'%r'\n. Otherwise, it defaults to\n'%T'\n. Manually setting\ntime_format\nwill override the\nuse_12hr\nsetting.\nVariables\n\nVariable\nExample\nDescription\ntime\n13:08:10\nThe current time.\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ntime\n]\ndisabled =\nfalse\nformat =\n'🕙[\\[ $time \\]]($style) '\ntime_format =\n'%T'\nutc_time_offset =\n'-5'\ntime_range =\n'10:00:00-14:00:00'\nTypst\n\nThe\ntypst\nmodule shows the current installed version of Typst used in a project.\nBy default, the module will be shown if any of the following conditions are met:\nThe current directory contains a\ntemplate.typ\nfile\nThe current directory contains any\n*.typ\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n't '\nA format string representing the symbol of Typst\nstyle\n'bold #0093A7'\nThe style for the module.\ndetect_extensions\n['.typ']\nWhich extensions should trigger this module.\ndetect_files\n['template.typ']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\ndisabled\nfalse\nDisables the\ntypst\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.9.0\nThe version of\ntypst\n, alias for typst_version\ntypst_version\ndefault\nThe current Typst version\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nUsername\n\nThe\nusername\nmodule shows active user's username. The module will be shown if any of the following conditions are met:\nThe current user is root\/admin\nThe current user isn't the same as the one that is logged in\nThe user is currently connected as an SSH session\nThe variable\nshow_always\nis set to true\nThe array\ndetect_env_vars\ncontains at least the name of one environment variable, that is set\nTIP\nSSH connection is detected by checking environment variables\nSSH_CONNECTION\n,\nSSH_CLIENT\n, and\nSSH_TTY\n. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.\nOptions\n\nOption\nDefault\nDescription\nstyle_root\n'bold red'\nThe style used when the user is root\/admin.\nstyle_user\n'bold yellow'\nThe style used for non-root users.\ndetect_env_vars\n[]\nWhich environment variable(s) should trigger this module.\nformat\n'[$user]($style) in '\nThe format for the module.\nshow_always\nfalse\nAlways shows the\nusername\nmodule.\ndisabled\nfalse\nDisables the\nusername\nmodule.\naliases\n{}\nTranslate system usernames to something else.\nVariables\n\nVariable\nExample\nDescription\nstyle\n'red bold'\nMirrors the value of option\nstyle_root\nwhen root is logged in and\nstyle_user\notherwise.\nuser\n'matchai'\nThe currently logged-in user ID.\nExample\n\nAlways show the username\n\ntoml\n# ~\/.config\/starship.toml\n[\nusername\n]\nstyle_user =\n'white bold'\nstyle_root =\n'black bold'\nformat =\n'user: [$user]($style) '\ndisabled =\nfalse\nshow_always =\ntrue\naliases = { \"corpuser034g\" =\n\"matchai\"\n}\nVagrant\n\nThe\nvagrant\nmodule shows the currently installed version of\nVagrant\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a\nVagrantfile\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'⍱ '\nA format string representing the symbol of Vagrant.\ndetect_extensions\n[]\nWhich extensions should trigger this module.\ndetect_files\n['Vagrantfile']\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'cyan bold'\nThe style for the module.\ndisabled\nfalse\nDisables the\nvagrant\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nVagrant 2.2.10\nThe version of\nVagrant\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nvagrant\n]\nformat =\n'via [⍱ $version](bold white) '\nV\n\nThe\nvlang\nmodule shows you your currently installed version of\nV\n. By default the module will be shown if any of the following conditions are met:\nThe current directory contains a file with\n.v\nextension\nThe current directory contains a\nv.mod\n,\nvpkg.json\nor\n.vpkg-lock.json\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'V '\nA format string representing the symbol of V\ndetect_extensions\n['v']\nWhich extensions should trigger this module.\ndetect_files\n['v.mod', 'vpkg.json', '.vpkg-lock.json' ]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nstyle\n'blue bold'\nThe style for the module.\ndisabled\nfalse\nDisables the\nvlang\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.2\nThe version of\nv\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nvlang\n]\nformat =\n'via [V $version](blue bold) '\nVCSH\n\nThe\nvcsh\nmodule displays the current active\nVCSH\nrepository. The module will be shown only if a repository is currently in use.\nOptions\n\nOption\nDefault\nDescription\nsymbol\n''\nThe symbol used before displaying the repository name.\nstyle\n'bold yellow'\nThe style for the module.\nformat\n'vcsh [$symbol$repo]($style) '\nThe format for the module.\ndisabled\nfalse\nDisables the\nvcsh\nmodule.\nVariables\n\nVariable\nExample\nDescription\nrepo\ndotfiles\nif in a VCSH repo named dotfiles\nThe active repository name\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nblack bold dimmed\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nvcsh\n]\nformat =\n'[🆅 $repo](bold blue) '\nXMake\n\nThe\nxmake\nmodule shows the currently installed version of\nXMake\n. By default the module will be activated if any of the following conditions are met:\nThe current directory contains a\nxmake.lua\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'△ '\nThe symbol used before the version of cmake.\ndetect_extensions\n[]\nWhich extensions should trigger this module\ndetect_files\n['xmake.lua']\nWhich filenames should trigger this module\ndetect_folders\n[]\nWhich folders should trigger this module\nstyle\n'bold green'\nThe style for the module.\ndisabled\nfalse\nDisables the\nxmake\nmodule.\nVariables\n\nVariable\nExample\nDescription\nversion\nv2.9.5\nThe version of xmake\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nZig\n\nBy default the\nzig\nmodule shows the currently installed version of\nZig\n. The module will be shown if any of the following conditions are met:\nThe current directory contains a\n.zig\nfile\nOptions\n\nOption\nDefault\nDescription\nformat\n'via [$symbol($version )]($style)'\nThe format for the module.\nversion_format\n'v${raw}'\nThe version format. Available vars are\nraw\n,\nmajor\n,\nminor\n, &\npatch\nsymbol\n'↯ '\nThe symbol used before displaying the version of Zig.\nstyle\n'bold yellow'\nThe style for the module.\ndisabled\nfalse\nDisables the\nzig\nmodule.\ndetect_extensions\n['zig']\nWhich extensions should trigger this module.\ndetect_files\n[]\nWhich filenames should trigger this module.\ndetect_folders\n[]\nWhich folders should trigger this module.\nVariables\n\nVariable\nExample\nDescription\nversion\nv0.6.0\nThe version of\nzig\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\nzig\n]\nsymbol =\n'⚡️ '\nCustom commands\n\nThe\ncustom\nmodules show the output of some arbitrary commands.\nThese modules will be shown if any of the following conditions are met:\nThe current directory contains a file whose name is in\ndetect_files\nThe current directory contains a directory whose name is in\ndetect_folders\nThe current directory contains a file whose extension is in\ndetect_extensions\nThe\nwhen\ncommand returns 0\nThe current Operating System (std::env::consts::OS) matches with\nos\nfield if defined.\nTIP\nMultiple custom modules can be defined by using a\n.\n.\nTIP\nThe order in which custom modules are shown can be individually set by including\n${custom.foo}\nin the top level\nformat\n(as it includes a dot, you need to use\n${...}\n). By default, the\ncustom\nmodule will simply show all custom modules in the order they were defined.\nTIP\nIssue #1252\ncontains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!\nWARNING\nIf\nunsafe_no_escape\nis enabled or prior to starship v1.20 command output is printed unescaped to the prompt.\nWhatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g.\n\\h\n, but this module will not work in a fish or zsh shell.\nFormat strings can also contain shell specific prompt sequences, e.g.\nBash\n,\nZsh\n.\nOptions\n\nOption\nDefault\nDescription\ncommand\n''\nThe command whose output should be printed. The command will be passed on stdin to the shell.\nwhen\nfalse\nEither a boolean value (\ntrue\nor\nfalse\n, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the\nshell\nreturns a\n0\nstatus code from executing it.\nrequire_repo\nfalse\nIf\ntrue\n, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options.\nshell\nSee below\ndescription\n'<custom module>'\nThe description of the module that is shown when running\nstarship explain\n.\nunsafe_no_escape\nfalse\nWhen set, command output is not escaped of characters that could be interpreted by the shell.\ndetect_files\n[]\nThe files that will be searched in the working directory for a match.\ndetect_folders\n[]\nThe directories that will be searched in the working directory for a match.\ndetect_extensions\n[]\nThe extensions that will be searched in the working directory for a match.\nsymbol\n''\nThe symbol used before displaying the command output.\nstyle\n'bold green'\nThe style for the module.\nformat\n'[$symbol($output )]($style)'\nThe format for the module.\ndisabled\nfalse\nDisables this\ncustom\nmodule.\nos\nOperating System name on which the module will be shown (unix, linux, macos, windows, ... )\nSee possible values\n.\nuse_stdin\nAn optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling.\nignore_timeout\nfalse\nIgnore global\ncommand_timeout\nsetting and keep running external commands, no matter how long they take.\nVariables\n\nVariable\nDescription\noutput\nThe output of\ncommand\nrun in\nshell\nsymbol\nMirrors the value of option\nsymbol\nstyle*\nMirrors the value of option\nstyle\n*: This variable can only be used as a part of a style string\nCustom command shell\n\nshell\naccepts a non-empty list of strings, where:\nThe first string is the path to the shell to use to execute the command.\nOther following arguments are passed to the shell.\nIf unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd \/C' on Windows.\nThe\ncommand\n(and\nwhen\n, if applicable) will be passed in on stdin.\nIf\nshell\nis not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added:\n-NoProfile -Command -\n. If\nshell\nis not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added:\n\/C\nand\nstdin\nwill be set to\nfalse\n. If\nshell\nis not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added:\n-c\nand\nstdin\nwill be set to\nfalse\n. This behavior can be avoided by explicitly passing arguments to the shell, e.g.\ntoml\nshell = [\n'pwsh'\n,\n'-Command'\n,\n'-'\n]\nWARNING\nMake sure your custom shell configuration exits gracefully\nIf you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the\nshell\noption).\nFor example, PowerShell requires the\n-Command\nparameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.\nParameters similar to\n-NoProfile\nin PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.\nAutomatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered.\nPlease open an issue\nwith shell details and starship configuration if you hit such scenario.\nExample\n\ntoml\n# ~\/.config\/starship.toml\n[\ncustom\n.\nfoo\n]\ncommand =\n'echo foo'\n# shows output of command\ndetect_files = [\n'foo'\n]\n# can specify filters but wildcards are not supported\nwhen =\n''' test \"$HOME\" = \"$PWD\" '''\nformat =\n' transcending [$output]($style)'\n[\ncustom\n.\ntime\n]\ncommand =\n'time \/T'\ndetect_extensions = [\n'pst'\n]\n# filters *.pst files\nshell = [\n'pwsh.exe'\n,\n'-NoProfile'\n,\n'-Command'\n,\n'-'\n]\n[\ncustom\n.\ntime-as-arg\n]\ncommand =\n'time \/T'\ndetect_extensions = [\n'pst'\n]\n# filters *.pst files\nshell = [\n'pwsh.exe'\n,\n'-NoProfile'\n,\n'-Command'\n]\nuse_stdin =\nfalse","attrs_markdown":"[Skip to content](https:\/\/starship.rs\/config\/#VPContent)\n\n[![](https:\/\/starship.rs\/icon.png)Starship](https:\/\/starship.rs\/)\n\nSearch`K`\n\nMain Navigation [Configuration](https:\/\/starship.rs\/config\/)\n\nEnglish\n\n[Deutsch](https:\/\/starship.rs\/de-DE\/config\/)\n\n[Español](https:\/\/starship.rs\/es-ES\/config\/)\n\n[Français](https:\/\/starship.rs\/fr-FR\/config\/)\n\n[Bahasa Indonesia](https:\/\/starship.rs\/id-ID\/config\/)\n\n[Italiano](https:\/\/starship.rs\/it-IT\/config\/)\n\n[日本語](https:\/\/starship.rs\/ja-JP\/config\/)\n\n[Português do Brasil](https:\/\/starship.rs\/pt-BR\/config\/)\n\n[Русский](https:\/\/starship.rs\/ru-RU\/config\/)\n\n[Українська](https:\/\/starship.rs\/uk-UA\/config\/)\n\n[Tiếng Việt](https:\/\/starship.rs\/vi-VN\/config\/)\n\n[简体中文](https:\/\/starship.rs\/zh-CN\/config\/)\n\n[繁體中文](https:\/\/starship.rs\/zh-TW\/config\/)\n\nEnglish\n\n[Deutsch](https:\/\/starship.rs\/de-DE\/config\/)\n\n[Español](https:\/\/starship.rs\/es-ES\/config\/)\n\n[Français](https:\/\/starship.rs\/fr-FR\/config\/)\n\n[Bahasa Indonesia](https:\/\/starship.rs\/id-ID\/config\/)\n\n[Italiano](https:\/\/starship.rs\/it-IT\/config\/)\n\n[日本語](https:\/\/starship.rs\/ja-JP\/config\/)\n\n[Português do Brasil](https:\/\/starship.rs\/pt-BR\/config\/)\n\n[Русский](https:\/\/starship.rs\/ru-RU\/config\/)\n\n[Українська](https:\/\/starship.rs\/uk-UA\/config\/)\n\n[Tiếng Việt](https:\/\/starship.rs\/vi-VN\/config\/)\n\n[简体中文](https:\/\/starship.rs\/zh-CN\/config\/)\n\n[繁體中文](https:\/\/starship.rs\/zh-TW\/config\/)\n\nAppearance\n\nMenu\n\nReturn to top\n\nSidebar Navigation\n\n[Guide](https:\/\/starship.rs\/guide\/)\n\n[Installation](https:\/\/starship.rs\/installing\/)\n\n[Configuration](https:\/\/starship.rs\/config\/)\n\n[Advanced Configuration](https:\/\/starship.rs\/advanced-config\/)\n\n[FAQ](https:\/\/starship.rs\/faq\/)\n\n[Presets](https:\/\/starship.rs\/presets\/)\n\nOn this page\n\n# Configuration [](https:\/\/starship.rs\/config\/#configuration)\nTo get started configuring starship, create the following file: `~\/.config\/starship.toml`.\n\nsh\n```\nmkdir -p ~\/.config && touch ~\/.config\/starship.toml\n```\n\nAll configuration for starship is done in this [TOML](https:\/\/github.com\/toml-lang\/toml) file:\n\ntoml\n```\n# Get editor completions based on the config schema\n\"$schema\" = 'https:\/\/starship.rs\/config-schema.json'\n\n# Inserts a blank line between shell prompts\nadd_newline = true\n\n# Replace the '❯' symbol in the prompt with '➜'\n[character] # The name of the module we are configuring is 'character'\nsuccess_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'\n\n# Disable the package module, hiding it from the prompt completely\n[package]\ndisabled = true\n```\n### Config File Location [](https:\/\/starship.rs\/config\/#config-file-location)\nYou can change default configuration file location with `STARSHIP_CONFIG` environment variable:\n\nsh\n```\nexport STARSHIP_CONFIG=~\/example\/non\/default\/path\/starship.toml\n```\n\nEquivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:\n\npowershell\n```\n$ENV:STARSHIP_CONFIG = \"$HOME\\example\\non\\default\\path\\starship.toml\"\n```\n\nOr for Cmd (Windows) would be adding this line to your `starship.lua`:\n\nlua\n```\nos.setenv('STARSHIP_CONFIG', 'C:\\\\Users\\\\user\\\\example\\\\non\\\\default\\\\path\\\\starship.toml')\n```\n### Logging [](https:\/\/starship.rs\/config\/#logging)\nBy default starship logs warnings and errors into a file named `~\/.cache\/starship\/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to an instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable:\n\nsh\n```\nexport STARSHIP_CACHE=~\/.starship\/cache\n```\n\nEquivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:\n\npowershell\n```\n$ENV:STARSHIP_CACHE = \"$HOME\\AppData\\Local\\Temp\"\n```\n\nOr for Cmd (Windows) would be adding this line to your `starship.lua`:\n\nlua\n```\nos.setenv('STARSHIP_CACHE', 'C:\\\\Users\\\\user\\\\AppData\\\\Local\\\\Temp')\n```\n### Terminology [](https:\/\/starship.rs\/config\/#terminology)\n**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the \"nodejs\" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project.\n\n**Variable**: Smaller sub-components that contain information provided by the module. For example, the \"version\" variable in the \"nodejs\" module contains the current version of Node.js.\n\nBy convention, most modules have a prefix of default terminal color (e.g. `via` in \"nodejs\") and an empty space as a suffix.\n\n### Strings [](https:\/\/starship.rs\/config\/#strings)\nIn TOML syntax, [text values](https:\/\/toml.io\/en\/v1.0.0#string) are declared with `'`, `\"`, `'''`, or `\"\"\"`.\n\nThe following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.\n\n| Symbol | Type | Notes |\n|---|---|---|\n| `'` | literal string | less escaping |\n| `\"` | string | more escaping |\n| `'''` | multi-line literal string | less escaping |\n| `\"\"\"` | multi-line string | more escaping, newlines in declarations can be ignored |\n\nFor example:\n\ntoml\n```\n# literal string\nformat = '☺\\☻ '\n\n# regular string\nformat = \"☺\\\\☻ \"\n\n# escaping Starship symbols\nformat = '\\[\\$\\] '\n```\n\nWhen using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:\n\ntoml\n```\n# with literal string\nformat = '''\n\n\\$'''\n\n# with multiline basic string\nformat = \"\"\"\n\n\\\\$\"\"\"\n\n# with basic string\nformat = \"\\n\\\\$\"\n```\n\nIn multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.\n\ntoml\n```\nformat = \"\"\"\nline1\\\nline1\\\nline1\nline2\\\nline2\\\nline2\n\"\"\"\n```\n### Format Strings [](https:\/\/starship.rs\/config\/#format-strings)\nFormat strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string.\n\n#### Variable [](https:\/\/starship.rs\/config\/#variable)\nA variable contains a `$` symbol followed by the name of the variable. The name of a variable can only contain letters, numbers and `_`.\n\nFor example:\n\n- `'$version'` is a format string with a variable named `version`.\n- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.\n- `'$git_branch $git_commit'` has the two variables separated with a space.\n#### Text Group [](https:\/\/starship.rs\/config\/#text-group)\nA text group is made up of two different parts.\n\nThe first part, which is enclosed in a `[]`, is a [format string](https:\/\/starship.rs\/config\/#format-strings). You can add texts, variables, or even nested text groups in it.\n\nIn the second part, which is enclosed in a `()`, is a [style string](https:\/\/starship.rs\/config\/#style-strings). This can be used to style the first part.\n\nFor example:\n\n- `'[on](red bold)'` will print a string `on` with bold text colored red.\n- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.\n- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.\n#### Style Strings [](https:\/\/starship.rs\/config\/#style-strings)\nMost modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](https:\/\/starship.rs\/advanced-config\/).\n\n- `'fg:green bg:blue'` sets green text on a blue background\n- `'bg:blue fg:bright-green'` sets bright green text on a blue background\n- `'bold fg:27'` sets bold text with [ANSI color](https:\/\/i.stack.imgur.com\/KTSQa.png) 27\n- `'underline bg:#bf5700'` sets underlined text on a burnt orange background\n- `'bold italic fg:purple'` sets bold italic purple text\n- `''` explicitly disables all styling\n\nNote that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.\n\n#### Conditional Format Strings [](https:\/\/starship.rs\/config\/#conditional-format-strings)\nA conditional format string wrapped in `(` and `)` will not render if all variables inside are empty.\n\nFor example:\n\n- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.\n- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.\n- When `$combined` is a shortcut for `\\[$a$b\\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\\[$a$b\\] )'`.\n### Negative matching [](https:\/\/starship.rs\/config\/#negative-matching)\nMany modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. \"Negative\" options, those which should not be matched, are indicated with a leading '!' character. The presence of *any* negative indicator in the directory will result in the module not being matched.\n\nExtensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.\n\nTo see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:\n\ntoml\n```\ndetect_extensions = ['ts', '!video.ts', '!audio.ts']\n```\n## Prompt [](https:\/\/starship.rs\/config\/#prompt)\nThis is the list of prompt-wide configuration options.\n\n### Options [](https:\/\/starship.rs\/config\/#options)\n| Option | Default | Description |\n|---|---|---|\n| `format` | [link](https:\/\/starship.rs\/config\/#default-prompt-format) | Configure the format of the prompt. |\n| `right_format` | `''` | See [Enable Right Prompt](https:\/\/starship.rs\/advanced-config\/#enable-right-prompt) |\n| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |\n| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |\n| `add_newline` | `true` | Inserts blank line between shell prompts. |\n| `palette` | `''` | Sets which color palette from `palettes` to use. |\n| `palettes` | `{}` | Collection of color palettes that assign [colors](https:\/\/starship.rs\/advanced-config\/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |\n| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |\n\nTIP\n\nIf you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.\n### Example [](https:\/\/starship.rs\/config\/#example)\ntoml\n```\n# ~\/.config\/starship.toml\n\n# Use custom format\nformat = '''\n[┌───────────────────>](bold green)\n[│](bold green)$directory$rust$package\n[└─>](bold green) '''\n\n# Wait 10 milliseconds for starship to check files under the current directory.\nscan_timeout = 10\n\n# Disable the blank line at the start of the prompt\nadd_newline = false\n\n# Set 'foo' as custom color palette\npalette = 'foo'\n\n# Define custom colors\n[palettes.foo]\n# Overwrite existing color\nblue = '21'\n# Define new color\nmustard = '#af8700'\n```\n### Default Prompt Format [](https:\/\/starship.rs\/config\/#default-prompt-format)\nThe default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:\n\ntoml\n```\nformat = '$all'\n\n# Which is equivalent to\nformat = \"\"\"\n$username\\\n$hostname\\\n$localip\\\n$shlvl\\\n$singularity\\\n$kubernetes\\\n$directory\\\n$vcsh\\\n$fossil_branch\\\n$fossil_metrics\\\n$git_branch\\\n$git_commit\\\n$git_state\\\n$git_metrics\\\n$git_status\\\n$hg_branch\\\n$hg_state\\\n$pijul_channel\\\n$docker_context\\\n$package\\\n$c\\\n$cmake\\\n$cobol\\\n$daml\\\n$dart\\\n$deno\\\n$dotnet\\\n$elixir\\\n$elm\\\n$erlang\\\n$fennel\\\n$fortran\\\n$gleam\\\n$golang\\\n$guix_shell\\\n$haskell\\\n$haxe\\\n$helm\\\n$java\\\n$julia\\\n$kotlin\\\n$gradle\\\n$lua\\\n$nim\\\n$nodejs\\\n$ocaml\\\n$opa\\\n$perl\\\n$php\\\n$pulumi\\\n$purescript\\\n$python\\\n$quarto\\\n$raku\\\n$rlang\\\n$red\\\n$ruby\\\n$rust\\\n$scala\\\n$solidity\\\n$swift\\\n$terraform\\\n$typst\\\n$vlang\\\n$vagrant\\\n$zig\\\n$buf\\\n$nix_shell\\\n$conda\\\n$meson\\\n$spack\\\n$memory_usage\\\n$aws\\\n$gcloud\\\n$openstack\\\n$azure\\\n$nats\\\n$direnv\\\n$env_var\\\n$mise\\\n$crystal\\\n$custom\\\n$sudo\\\n$cmd_duration\\\n$line_break\\\n$jobs\\\n$battery\\\n$time\\\n$status\\\n$os\\\n$container\\\n$netns\\\n$shell\\\n$character\"\"\"\n```\n\nIf you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. Eg.\n\ntoml\n```\n# Move the directory to the second line\nformat = '$all$directory$character'\n```\n## AWS [](https:\/\/starship.rs\/config\/#aws)\nThe `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~\/.aws\/config` and `~\/.aws\/credentials` files as required.\n\nThe module will display a profile only if its credentials are present in `~\/.aws\/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~\/.aws\/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.\n\nWhen using [aws-vault](https:\/\/github.com\/99designs\/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.\n\nWhen using [awsu](https:\/\/github.com\/kreuzwerker\/awsu) the profile is read from the `AWSU_PROFILE` env var.\n\nWhen using [AWSume](https:\/\/awsu.me\/) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.\n\nWhen using [saml2aws](https:\/\/github.com\/Versent\/saml2aws) the expiration information obtained from `~\/.aws\/credentials` falls back to the `x_security_token_expires` key.\n\nWhen using [aws-sso-cli](https:\/\/github.com\/synfinatic\/aws-sso-cli) the profile is read from the `AWS_SSO_PROFILE` env var.\n\n### Options [](https:\/\/starship.rs\/config\/#options-1)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'on [$symbol($profile )(\$$region\$ )(\\[$duration\\] )]($style)'` | The format for the module. |\n| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |\n| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |\n| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `expiration_symbol` | `'X'` | The symbol displayed when the temporary credentials have expired. |\n| `disabled` | `false` | Disables the `AWS` module. |\n| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |\n### Variables [](https:\/\/starship.rs\/config\/#variables)\n| Variable | Example | Description |\n|---|---|---|\n| region | `ap-northeast-1` | The current AWS region |\n| profile | `astronauts` | The current AWS profile |\n| duration | `2h27m20s` | The temporary credentials validity duration |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Examples [](https:\/\/starship.rs\/config\/#examples)\n#### Display everything [](https:\/\/starship.rs\/config\/#display-everything)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[aws]\nformat = 'on [$symbol($profile )(\$$region\$ )]($style)'\nstyle = 'bold blue'\nsymbol = '🅰 '\n[aws.region_aliases]\nap-southeast-2 = 'au'\nus-east-1 = 'va'\n[aws.profile_aliases]\nCompanyGroupFrobozzOnCallAccess = 'Frobozz'\n```\n#### Display region [](https:\/\/starship.rs\/config\/#display-region)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[aws]\nformat = 'on [$symbol$region]($style) '\nstyle = 'bold blue'\nsymbol = '🅰 '\n[aws.region_aliases]\nap-southeast-2 = 'au'\nus-east-1 = 'va'\n```\n#### Display profile [](https:\/\/starship.rs\/config\/#display-profile)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[aws]\nformat = 'on [$symbol$profile]($style) '\nstyle = 'bold blue'\nsymbol = '🅰 '\n[aws.profile_aliases]\nEnterprise_Naming_Scheme-voidstars = 'void**'\n```\n## Azure [](https:\/\/starship.rs\/config\/#azure)\nThe `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~\/.azure\/azureProfile.json` file.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-2)\n| Variable | Default | Description |\n|---|---|---|\n| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |\n| `symbol` | `'󰠅 '` | The symbol used in the format. |\n| `style` | `'blue bold'` | The style used in the format. |\n| `disabled` | `true` | Disables the `azure` module. |\n| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |\n### Examples [](https:\/\/starship.rs\/config\/#examples-1)\n#### Display Subscription Name [](https:\/\/starship.rs\/config\/#display-subscription-name)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[azure]\ndisabled = false\nformat = 'on [$symbol($subscription)]($style) '\nsymbol = '󰠅 '\nstyle = 'blue bold'\n```\n#### Display Username [](https:\/\/starship.rs\/config\/#display-username)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[azure]\ndisabled = false\nformat = \"on [$symbol($username)]($style) \"\nsymbol = \"󰠅 \"\nstyle = \"blue bold\"\n```\n#### Display Subscription Name Alias [](https:\/\/starship.rs\/config\/#display-subscription-name-alias)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[azure.subscription_aliases]\nvery-long-subscription-name = 'vlsn'\n```\n## Battery [](https:\/\/starship.rs\/config\/#battery)\nThe `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.\n\n### Options [](https:\/\/starship.rs\/config\/#options-3)\n| Option | Default | Description |\n|---|---|---|\n| `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |\n| `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |\n| `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |\n| `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |\n| `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |\n| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |\n| `display` | [link](https:\/\/starship.rs\/config\/#battery-display) | Display threshold and style for the module. |\n| `disabled` | `false` | Disables the `battery` module. |\n### Example [](https:\/\/starship.rs\/config\/#example-1)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[battery]\nfull_symbol = '🔋 '\ncharging_symbol = '⚡️ '\ndischarging_symbol = '💀 '\n```\n### Battery Display [](https:\/\/starship.rs\/config\/#battery-display)\nThe `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. The default is as shown:\n\ntoml\n```\n[[battery.display]]\nthreshold = 10\nstyle = 'bold red'\n```\n\nThe default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.\n\n#### Options [](https:\/\/starship.rs\/config\/#options-4)\nThe `display` option is an array of the following table.\n\n| Option | Default | Description |\n|---|---|---|\n| `threshold` | `10` | The upper bound for the display option. |\n| `style` | `'red bold'` | The style used if the display option is in use. |\n| `charging_symbol` |   | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |\n| `discharging_symbol` |   | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |\n#### Example [](https:\/\/starship.rs\/config\/#example-2)\ntoml\n```\n[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%\nthreshold = 10\nstyle = 'bold red'\n\n[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%\nthreshold = 30\nstyle = 'bold yellow'\ndischarging_symbol = '💦 '\n\n# when capacity is over 30%, the battery indicator will not be displayed\n```\n## Buf [](https:\/\/starship.rs\/config\/#buf)\nThe `buf` module shows the currently installed version of [Buf](https:\/\/buf.build\/). By default, the module is shown if the current directory contains a [`buf.yaml`](https:\/\/docs.buf.build\/configuration\/v1\/buf-yaml), [`buf.gen.yaml`](https:\/\/docs.buf.build\/configuration\/v1\/buf-gen-yaml), or [`buf.work.yaml`](https:\/\/docs.buf.build\/configuration\/v1\/buf-work-yaml) configuration file.\n\n### Options [](https:\/\/starship.rs\/config\/#options-5)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |\n| `version_format` | `'v${raw}'` | The version format. |\n| `symbol` | `'🐃 '` | The symbol used before displaying the version of Buf. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `elixir` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-1)\n| Variable | Example | Description |\n|---|---|---|\n| `version` | `v1.0.0` | The version of `buf` |\n| `symbol` |   | Mirrors the value of option `symbol` |\n| `style`\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-3)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[buf]\nsymbol = '🦬 '\n```\n## Bun [](https:\/\/starship.rs\/config\/#bun)\nThe `bun` module shows the currently installed version of the [bun](https:\/\/bun.sh\/) JavaScript runtime. By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `bun.lock` file\n- The current directory contains a `bun.lockb` file\n- The current directory contains a `bunfig.toml` file\n### Options [](https:\/\/starship.rs\/config\/#options-6)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🥟 '` | A format string representing the symbol of Bun. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['bun.lock', 'bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold red'` | The style for the module. |\n| `disabled` | `false` | Disables the `bun` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-2)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.1.4` | The version of `bun` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-4)\n#### Customize the format [](https:\/\/starship.rs\/config\/#customize-the-format)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[bun]\nformat = 'via [🍔 $version](bold green) '\n```\n## C [](https:\/\/starship.rs\/config\/#c)\nThe `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file.\n\n### Options [](https:\/\/starship.rs\/config\/#options-7)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'C '` | The symbol used before displaying the compiler details |\n| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is |\n| `style` | `'bold 149'` | The style for the module. |\n| `disabled` | `false` | Disables the `c` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-3)\n| Variable | Example | Description |\n|---|---|---|\n| name | clang | The name of the compiler |\n| version | 13\\.0.0 | The version of the compiler |\n| symbol |   | Mirrors the value of option `symbol` |\n| style |   | Mirrors the value of option `style` |\n### Commands [](https:\/\/starship.rs\/config\/#commands)\nThe `commands` option accepts a list of commands to determine the compiler version and name.\n\nEach command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.\n\nIf a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https:\/\/github.com\/starship\/starship\/issues\/new\/choose).\n\n### Example [](https:\/\/starship.rs\/config\/#example-5)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[c]\nformat = 'via [$name $version]($style)'\n```\n## CPP [](https:\/\/starship.rs\/config\/#cpp)\nThe `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`\\-related files.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-8)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'C++ '` | The symbol used before displaying the compiler details |\n| `detect_extensions` | `['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `commands` | `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` | How to detect what the compiler is |\n| `style` | `'bold 149'` | The style for the module. |\n| `disabled` | `true` | Disables the `cpp` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-4)\n| Variable | Example | Description |\n|---|---|---|\n| name | clang++ | The name of the compiler |\n| version | 13\\.0.0 | The version of the compiler |\n| symbol |   | Mirrors the value of option `symbol` |\n| style |   | Mirrors the value of option `style` |\n### Commands [](https:\/\/starship.rs\/config\/#commands-1)\nThe `commands` option accepts a list of commands to determine the compiler version and name.\n\nEach command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT.\n\nIf a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https:\/\/github.com\/starship\/starship\/issues\/new\/choose).\n\n### Example [](https:\/\/starship.rs\/config\/#example-6)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[cpp]\ndisabled = false\nformat = 'via [$name $version]($style)'\n```\n## Character [](https:\/\/starship.rs\/config\/#character)\nThe `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.\n\nThe character will tell you whether the last command was successful or not. It can do this in two ways:\n\n- changing color (`red`\/`green`)\n- changing shape (`❯`\/`✖`)\n\nBy default it only changes color. If you also want to change its shape take a look at [this example](https:\/\/starship.rs\/config\/#with-custom-error-shape).\n\nWARNING\n\n`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https:\/\/github.com\/starship\/starship\/issues\/625#issuecomment-732454148).\n### Options [](https:\/\/starship.rs\/config\/#options-9)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'$symbol '` | The format string used before the text input. |\n| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |\n| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |\n| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |\n| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |\n| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |\n| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |\n| `disabled` | `false` | Disables the `character` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-5)\n| Variable | Example | Description |\n|---|---|---|\n| symbol |   | A mirror of either `success_symbol`, `error_symbol`, `vimcmd_symbol` or `vimcmd_replace_one_symbol` etc. |\n### Examples [](https:\/\/starship.rs\/config\/#examples-2)\n#### With custom error shape [](https:\/\/starship.rs\/config\/#with-custom-error-shape)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[character]\nsuccess_symbol = '[➜](bold green) '\nerror_symbol = '[✗](bold red) '\n```\n#### Without custom error shape [](https:\/\/starship.rs\/config\/#without-custom-error-shape)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[character]\nsuccess_symbol = '[➜](bold green) '\nerror_symbol = '[➜](bold red) '\n```\n#### With custom vim shape [](https:\/\/starship.rs\/config\/#with-custom-vim-shape)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[character]\nvimcmd_symbol = '[V](bold green) '\n```\n## CMake [](https:\/\/starship.rs\/config\/#cmake)\nThe `cmake` module shows the currently installed version of [CMake](https:\/\/cmake.org\/). By default the module will be activated if any of the following conditions are met:\n\n- The current directory contains a `CMakeLists.txt` file\n- The current directory contains a `CMakeCache.txt` file\n### Options [](https:\/\/starship.rs\/config\/#options-10)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'△ '` | The symbol used before the version of cmake. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module |\n| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |\n| `detect_folders` | `[]` | Which folders should trigger this module |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `cmake` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-6)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v3.17.3` | The version of cmake |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## COBOL \/ GNUCOBOL [](https:\/\/starship.rs\/config\/#cobol-gnucobol)\nThe `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:\n\n- The current directory contains any files ending in `.cob` or `.COB`\n- The current directory contains any files ending in `.cbl` or `.CBL`\n### Options [](https:\/\/starship.rs\/config\/#options-11)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `style` | `'bold blue'` | The style for the module. |\n| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `cobol` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-7)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v3.1.2.0` | The version of `cobol` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Command Duration [](https:\/\/starship.rs\/config\/#command-duration)\nThe `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.\n\nWARNING\n\nDo not hook the DEBUG trap in Bash\n\nIf you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.\n\nBash users who need preexec-like functionality can use [rcaloras's bash\\_preexec framework](https:\/\/github.com\/rcaloras\/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal.\n\n### Options [](https:\/\/starship.rs\/config\/#options-12)\n| Option | Default | Description |\n|---|---|---|\n| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |\n| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |\n| `format` | `'took [$duration]($style) '` | The format for the module. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `false` | Disables the `cmd_duration` module. |\n| `show_notifications` | `false` | Show desktop notifications when command completes. |\n| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |\n| `notification_timeout` |   | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-8)\n| Variable | Example | Description |\n|---|---|---|\n| duration | `16m40s` | The time it took to execute the command |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-7)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[cmd_duration]\nmin_time = 500\nformat = 'underwent [$duration](bold yellow)'\n```\n## Conda [](https:\/\/starship.rs\/config\/#conda)\nThe `conda` module shows the current [Conda](https:\/\/docs.conda.io\/en\/latest\/) environment, if `$CONDA_DEFAULT_ENV` is set.\n\nTIP\n\nThis does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https:\/\/pixi.sh\/), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.\n### Options [](https:\/\/starship.rs\/config\/#options-13)\n| Option | Default | Description |\n|---|---|---|\n| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](https:\/\/starship.rs\/config\/#directory) module. |\n| `symbol` | `'🅒 '` | The symbol used before the environment name. |\n| `style` | `'bold green'` | The style for the module. |\n| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |\n| `ignore_base` | `true` | Ignores `base` environment when activated. |\n| `detect_env_vars` | `[\"!PIXI_ENVIRONMENT_NAME\"]` | Which environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default. |\n| `disabled` | `false` | Disables the `conda` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-9)\n| Variable | Example | Description |\n|---|---|---|\n| environment | `astronauts` | The current conda environment |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-8)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[conda]\nformat = '[$symbol$environment](dimmed green) '\n```\n## Container [](https:\/\/starship.rs\/config\/#container)\nThe `container` module displays a symbol and container name, if inside a container.\n\n### Options [](https:\/\/starship.rs\/config\/#options-14)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'⬢'` | The symbol shown, when inside a container |\n| `style` | `'bold red dimmed'` | The style for the module. |\n| `format` | `'[$symbol \\[$name\\]]($style) '` | The format for the module. |\n| `disabled` | `false` | Disables the `container` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-10)\n| Variable | Example | Description |\n|---|---|---|\n| name | `fedora-toolbox:35` | The name of the container |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-9)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[container]\nformat = '[$symbol \\[$name\\]]($style) '\n```\n## Crystal [](https:\/\/starship.rs\/config\/#crystal)\nThe `crystal` module shows the currently installed version of [Crystal](https:\/\/crystal-lang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `shard.yml` file\n- The current directory contains a `.cr` file\n### Options [](https:\/\/starship.rs\/config\/#options-15)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `style` | `'bold red'` | The style for the module. |\n| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |\n| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `crystal` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-11)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.32.1` | The version of `crystal` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-10)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[crystal]\nformat = 'via [✨ $version](bold blue) '\n```\n## Daml [](https:\/\/starship.rs\/config\/#daml)\nThe `daml` module shows the currently used [Daml](https:\/\/www.digitalasset.com\/developers) SDK version when you are in the root directory of your Daml project. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `daml.yaml` file\n### Options [](https:\/\/starship.rs\/config\/#options-16)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'Λ '` | A format string representing the symbol of Daml |\n| `style` | `'bold cyan'` | The style for the module. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `daml` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-12)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v2.2.0` | The version of `daml` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-11)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[daml]\nformat = 'via [D $version](bold bright-green) '\n```\n## Dart [](https:\/\/starship.rs\/config\/#dart)\nThe `dart` module shows the currently installed version of [Dart](https:\/\/dart.dev\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with `.dart` extension\n- The current directory contains a `.dart_tool` directory\n- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file\n### Options [](https:\/\/starship.rs\/config\/#options-17)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |\n| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |\n| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |\n| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `dart` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-13)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v2.8.4` | The version of `dart` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-12)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[dart]\nformat = 'via [🔰 $version](bold red) '\n```\n## Deno [](https:\/\/starship.rs\/config\/#deno)\nThe `deno` module shows you your currently installed version of [Deno](https:\/\/deno.land\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file\n### Options [](https:\/\/starship.rs\/config\/#options-18)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🦕 '` | A format string representing the symbol of Deno |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['deno.json', 'deno.jsonc', 'deno.lock', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'green bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `deno` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-14)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.8.3` | The version of `deno` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-13)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[deno]\nformat = 'via [🦕 $version](green bold) '\n```\n## Directory [](https:\/\/starship.rs\/config\/#directory)\nThe `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.\n\nWhen using the `fish_style_pwd_dir_length` option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.\n\nFor example, given `~\/Dev\/Nix\/nixpkgs\/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~\/D\/N\/nixpkgs\/pkgs`, whereas before it would have been `nixpkgs\/pkgs`.\n\n### Options [](https:\/\/starship.rs\/config\/#options-19)\n| Option | Default | Description |\n|---|---|---|\n| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |\n| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |\n| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |\n| `style` | `'bold cyan'` | The style for the module. |\n| `disabled` | `false` | Disables the `directory` module. |\n| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |\n| `read_only_style` | `'red'` | The style for the read only symbol. |\n| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…\/' |\n| `before_repo_root_style` |   | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |\n| `repo_root_style` |   | The style for the root of the git repo. The default value is equivalent to `style`. |\n| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |\n| `home_symbol` | `'~'` | The symbol indicating home directory. |\n| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `\/` (e.g. `\\` on Windows) |\n\nThis module has a few advanced configuration options that control how the directory is displayed.\n\n| Advanced Option | Default | Description |\n|---|---|---|\n| `substitutions` |   | A table of substitutions to be made to the path. |\n| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |\n| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |\n\n`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories of Java. Note that this will disable the fish style PWD.\n\ntoml\n```\n[directory.substitutions]\n'\/Volumes\/network\/path' = '\/net'\n'src\/com\/long\/java\/path' = 'mypath'\n```\n\n`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `\/built\/this\/city\/on\/rock\/and\/roll`, which would normally be displayed as `rock\/and\/roll`, would be displayed as `\/b\/t\/c\/o\/rock\/and\/roll` with `fish_style_pwd_dir_length = 1`\\--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `\/bu\/th\/ci\/on\/rock\/and\/roll`.\n### Variables [](https:\/\/starship.rs\/config\/#variables-15)\n| Variable | Example | Description |\n|---|---|---|\n| path | `'D:\/Projects'` | The current directory path |\n| style\\* | `'black bold dimmed'` | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\nThe git repos have additional variables.\n\nLet us consider the path `\/path\/to\/home\/git_repo\/src\/lib`\n\n| Variable | Example | Description |\n|---|---|---|\n| before\\_root\\_path | `'\/path\/to\/home\/'` | The path before git root directory path |\n| repo\\_root | `'git_repo'` | The git root directory name |\n| path | `'\/src\/lib'` | The remaining path |\n| style | `'black bold dimmed'` | Mirrors the value of option `style` |\n| repo\\_root\\_style | `'underline white'` | Style for git root directory name |\n### Example [](https:\/\/starship.rs\/config\/#example-14)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[directory]\ntruncation_length = 8\ntruncation_symbol = '…\/'\n```\n## Direnv [](https:\/\/starship.rs\/config\/#direnv)\nThe `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-20)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[$symbol$loaded\/$allowed]($style) '` | The format for the module. |\n| `symbol` | `'direnv '` | The symbol used before displaying the direnv context. |\n| `style` | `'bold orange'` | The style for the module. |\n| `disabled` | `true` | Disables the `direnv` module. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['.envrc']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `detect_env_vars` | `['DIRENV_FILE']` | Which environment variables should trigger this module. |\n| `allowed_msg` | `'allowed'` | The message displayed when an rc file is allowed. |\n| `not_allowed_msg` | `'not allowed'` | The message displayed when an rc file is not\\_allowed. |\n| `denied_msg` | `'denied'` | The message displayed when an rc file is denied. |\n| `loaded_msg` | `'loaded'` | The message displayed when an rc file is loaded. |\n| `unloaded_msg` | `'not loaded'` | The message displayed when an rc file is not loaded. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-16)\n| Variable | Example | Description |\n|---|---|---|\n| loaded | `loaded` | Whether the current rc file is loaded. |\n| allowed | `denied` | Whether the current rc file is allowed. |\n| rc\\_path | `\/home\/test\/.envrc` | The current rc file path. |\n| symbol |   | Mirrors the value of option `symbol`. |\n| style\\* | `red bold` | Mirrors the value of option `style`. |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-15)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[direnv]\ndisabled = false\n```\n## Docker Context [](https:\/\/starship.rs\/config\/#docker-context)\nThe `docker_context` module shows the currently active [Docker context](https:\/\/docs.docker.com\/engine\/context\/working-with-contexts\/) if it's not set to `default` or `desktop-linux`, or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use).\n\n### Options [](https:\/\/starship.rs\/config\/#options-21)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol$context]($style) '` | The format for the module. |\n| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |\n| `only_with_files` | `true` | Only show when there's a match |\n| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |\n| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |\n| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |\n| `style` | `'blue bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `docker_context` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-17)\n| Variable | Example | Description |\n|---|---|---|\n| context | `test_context` | The current docker context |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-16)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[docker_context]\nformat = 'via [🐋 $context](blue bold)'\n```\n## Dotnet [](https:\/\/starship.rs\/config\/#dotnet)\nThe `dotnet` module shows the relevant version of the [.NET Core SDK](https:\/\/dotnet.microsoft.com\/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.\n\nBy default this module will only be shown in your prompt when one or more of the following files are present in the current directory:\n\n- `global.json`\n- `project.json`\n- `Directory.Build.props`\n- `Directory.Build.targets`\n- `Packages.props`\n- `*.csproj`\n- `*.fsproj`\n- `*.xproj`\n\nYou'll also need the .NET Core SDK installed in order to use it correctly.\n\nInternally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options.\n\nThe module will also show the Target Framework Moniker (<https:\/\/docs.microsoft.com\/en-us\/dotnet\/standard\/frameworks#supported-target-frameworks>) when there is a `.csproj` file in the current directory.\n\n### Options [](https:\/\/starship.rs\/config\/#options-22)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )(🎯 $tfm )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'.NET '` | The symbol used before displaying the version of dotnet. |\n| `heuristic` | `true` | Use faster version detection to keep starship snappy. |\n| `detect_extensions` | `['csproj', 'fsproj', 'xproj']` | Which extensions should trigger this module. |\n| `detect_files` | `['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `dotnet` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-18)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v3.1.201` | The version of `dotnet` sdk |\n| tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-17)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[dotnet]\nsymbol = '🥅 '\nstyle = 'green'\nheuristic = false\n```\n## Elixir [](https:\/\/starship.rs\/config\/#elixir)\nThe `elixir` module shows the currently installed version of [Elixir](https:\/\/elixir-lang.org\/) and [Erlang\/OTP](https:\/\/erlang.org\/doc\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `mix.exs` file.\n### Options [](https:\/\/starship.rs\/config\/#options-23)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version \$OTP $otp_version\$ )]($style)'` | The format for the module elixir. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'💧 '` | The symbol used before displaying the version of Elixir\/Erlang. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['mix.exs']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `style` | `'bold purple'` | The style for the module. |\n| `disabled` | `false` | Disables the `elixir` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-19)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.10` | The version of `elixir` |\n| otp\\_version |   | The otp version of `elixir` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-18)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[elixir]\nsymbol = '🔮 '\n```\n## Elm [](https:\/\/starship.rs\/config\/#elm)\nThe `elm` module shows the currently installed version of [Elm](https:\/\/elm-lang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `elm.json` file\n- The current directory contains a `elm-package.json` file\n- The current directory contains a `.elm-version` file\n- The current directory contains a `elm-stuff` folder\n- The current directory contains `*.elm` files\n### Options [](https:\/\/starship.rs\/config\/#options-24)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🌳 '` | A format string representing the symbol of Elm. |\n| `detect_extensions` | `['elm']` | Which extensions should trigger this module. |\n| `detect_files` | `['elm.json', 'elm-package.json', '.elm-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `['elm-stuff']` | Which folders should trigger this modules. |\n| `style` | `'cyan bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `elm` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-20)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.19.1` | The version of `elm` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-19)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[elm]\nformat = 'via [ $version](cyan bold) '\n```\n## Environment Variable [](https:\/\/starship.rs\/config\/#environment-variable)\nThe `env_var` module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met:\n\n- The `variable` configuration option matches an existing environment variable\n- The `variable` configuration option is not defined, but the `default` configuration option is\n\nTIP\n\nThe order in which env\\_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env\\_var modules in the order they were defined.\n\nTIP\n\nMultiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.\n\nExample: following configuration will display value of USER environment variable\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[env_var.USER]\ndefault = 'unknown user'\n```\n### Options [](https:\/\/starship.rs\/config\/#options-25)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `\"\"` | The symbol used before displaying the variable value. |\n| `variable` |   | The environment variable to be displayed. |\n| `default` |   | The default value to be displayed when the selected variable is not defined. |\n| `format` | `\"with [$env_value]($style) \"` | The format for the module. |\n| `description` | `\"<env_var module>\"` | The description of the module that is shown when running `starship explain`. |\n| `disabled` | `false` | Disables the `env_var` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-21)\n| Variable | Example | Description |\n|---|---|---|\n| env\\_value | `Windows NT` (if *variable* would be `$OS`) | The environment value of option `variable` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* | `black bold dimmed` | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-20)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[env_var]\nvariable = 'SHELL'\ndefault = 'unknown shell'\n```\n\nDisplaying multiple environmental variables:\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[env_var.SHELL]\nvariable = 'SHELL'\ndefault = 'unknown shell'\n[env_var.USER]\ndefault = 'unknown user'\n```\n## Erlang [](https:\/\/starship.rs\/config\/#erlang)\nThe `erlang` module shows the currently installed version of [Erlang\/OTP](https:\/\/erlang.org\/doc\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `rebar.config` file.\n- The current directory contains a `erlang.mk` file.\n### Options [](https:\/\/starship.rs\/config\/#options-26)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `' '` | The symbol used before displaying the version of erlang. |\n| `style` | `'bold red'` | The style for the module. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['rebar.config', 'elang.mk']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `disabled` | `false` | Disables the `erlang` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-22)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v22.1.3` | The version of `erlang` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-21)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[erlang]\nformat = 'via [e $version](bold red) '\n```\n## Fennel [](https:\/\/starship.rs\/config\/#fennel)\nThe `fennel` module shows the currently installed version of [Fennel](https:\/\/fennel-lang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with the `.fnl` extension\n### Options [](https:\/\/starship.rs\/config\/#options-27)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |\n| `style` | `'bold green'` | The style for the module. |\n| `detect_extensions` | `['fnl']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `disabled` | `false` | Disables the `fennel` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-23)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.2.1` | The version of `fennel` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-22)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[fennel]\nsymbol = '⫰ '\n```\n## Fill [](https:\/\/starship.rs\/config\/#fill)\nThe `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.\n\n### Options [](https:\/\/starship.rs\/config\/#options-28)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'.'` | The symbol used to fill the line. |\n| `style` | `'bold black'` | The style for the module. |\n| `disabled` | `false` | Disables the `fill` module |\n### Example [](https:\/\/starship.rs\/config\/#example-23)\ntoml\n```\n# ~\/.config\/starship.toml\nformat = 'AA $fill BB $fill CC'\n\n[fill]\nsymbol = '-'\nstyle = 'bold green'\n```\n\nProduces a prompt that looks like:\n```\nAA -------------------------------------------- BB -------------------------------------------- CC\n```\n## Fortran [](https:\/\/starship.rs\/config\/#fortran)\nThe `fortran` module shows the current compiler version of Fortran.\n\n### Options [](https:\/\/starship.rs\/config\/#options-29)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `' '` | The symbol used before displaying the version of Fortran. |\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `style` | `'bold purple'` | The style for the module. |\n| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. |\n| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is |\n| `disabled` | `false` | Disables the `fortran` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-24)\n| Variable | Example | Description |\n|---|---|---|\n| name | gfortran | The name of the compiler |\n| version | `14.2.0` | The version of the Fortran compiler |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Commands [](https:\/\/starship.rs\/config\/#commands-2)\nThe `commands` option accepts a list of commands to determine the compiler version and name.\n\nEach command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT.\n\nIf a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https:\/\/github.com\/starship\/starship\/).\n\n## Fossil Branch [](https:\/\/starship.rs\/config\/#fossil-branch)\nThe `fossil_branch` module shows the name of the active branch of the check-out in your current directory.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-30)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. |\n| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. |\n| `style` | `'bold purple'` | The style for the module. |\n| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes |\n| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |\n| `disabled` | `true` | Disables the `fossil_branch` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-25)\n| Variable | Example | Description |\n|---|---|---|\n| branch | `trunk` | The active Fossil branch |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-24)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[fossil_branch]\nsymbol = '🦎 '\ntruncation_length = 4\ntruncation_symbol = ''\n```\n## Fossil Metrics [](https:\/\/starship.rs\/config\/#fossil-metrics)\nThe `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-31)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |\n| `added_style` | `'bold green'` | The style for the added count. |\n| `deleted_style` | `'bold red'` | The style for the deleted count. |\n| `only_nonzero_diffs` | `true` | Render status only for changed items. |\n| `disabled` | `true` | Disables the `fossil_metrics` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-26)\n| Variable | Example | Description |\n|---|---|---|\n| added | `1` | The current number of added lines |\n| deleted | `2` | The current number of deleted lines |\n| added\\_style\\* |   | Mirrors the value of option `added_style` |\n| deleted\\_style\\* |   | Mirrors the value of option `deleted_style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-25)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[fossil_metrics]\nadded_style = 'bold blue'\nformat = '[+$added]($added_style)\/[-$deleted]($deleted_style) '\n```\n## Google Cloud (`gcloud`) [](https:\/\/starship.rs\/config\/#google-cloud-gcloud)\nThe `gcloud` module shows the current configuration for [`gcloud`](https:\/\/cloud.google.com\/sdk\/gcloud) CLI. This is based on the `~\/.config\/gcloud\/active_config` file and the `~\/.config\/gcloud\/configurations\/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.\n\nWhen the module is enabled it will always be active, unless `detect_env_vars` has been set in which case the module will only be active when one of the environment variables has been set.\n\n### Options [](https:\/\/starship.rs\/config\/#options-32)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'on [$symbol$account(@$domain)(\$$region\$)]($style) '` | The format for the module. |\n| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |\n| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |\n| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |\n| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `gcloud` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-27)\n| Variable | Example | Description |\n|---|---|---|\n| region | `us-central1` | The current GCP region |\n| account | `foo` | The current GCP profile |\n| domain | `example.com` | The current GCP profile domain |\n| project |   | The current GCP project |\n| active | `default` | The active config name written in `~\/.config\/gcloud\/active_config` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Examples [](https:\/\/starship.rs\/config\/#examples-3)\n#### Display account and project [](https:\/\/starship.rs\/config\/#display-account-and-project)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[gcloud]\nformat = 'on [$symbol$account(@$domain)(\$$project\$)]($style) '\n```\n#### Display active config name only [](https:\/\/starship.rs\/config\/#display-active-config-name-only)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[gcloud]\nformat = '[$symbol$active]($style) '\nstyle = 'bold yellow'\n```\n#### Display account and aliased region [](https:\/\/starship.rs\/config\/#display-account-and-aliased-region)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[gcloud]\nsymbol = '️🇬️ '\n[gcloud.region_aliases]\nus-central1 = 'uc1'\nasia-northeast1 = 'an1'\n```\n#### Display account and aliased project [](https:\/\/starship.rs\/config\/#display-account-and-aliased-project)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[gcloud]\nformat = 'on [$symbol$account(@$domain)(\$$project\$)]($style) '\n[gcloud.project_aliases]\nvery-long-project-name = 'vlpn'\n```\n## Git Branch [](https:\/\/starship.rs\/config\/#git-branch)\nThe `git_branch` module shows the active branch of the repo in your current directory.\n\n### Options [](https:\/\/starship.rs\/config\/#options-33)\n| Option | Default | Description |\n|---|---|---|\n| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |\n| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. |\n| `symbol` | `' '` | A format string representing the symbol of git branch. |\n| `style` | `'bold purple'` | The style for the module. |\n| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |\n| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |\n| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |\n| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |\n| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |\n| `disabled` | `false` | Disables the `git_branch` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-28)\n| Variable | Example | Description |\n|---|---|---|\n| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |\n| remote\\_name | `origin` | The remote name. |\n| remote\\_branch | `master` | The name of the branch tracked on `remote_name`. |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-26)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_branch]\nsymbol = '🌱 '\ntruncation_length = 4\ntruncation_symbol = ''\nignore_branches = ['master', 'main']\n```\n## Git Commit [](https:\/\/starship.rs\/config\/#git-commit)\nThe `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.\n\n### Options [](https:\/\/starship.rs\/config\/#options-34)\n| Option | Default | Description |\n|---|---|---|\n| `commit_hash_length` | `7` | The length of the displayed git commit hash. |\n| `format` | `'[\$$hash$tag\$]($style) '` | The format for the module. |\n| `style` | `'bold green'` | The style for the module. |\n| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |\n| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |\n| `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. |\n| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown |\n| `disabled` | `false` | Disables the `git_commit` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-29)\n| Variable | Example | Description |\n|---|---|---|\n| hash | `b703eb3` | The current git commit hash |\n| tag | `v1.0.0` | The tag name if showing tag info is enabled. |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-27)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_commit]\ncommit_hash_length = 4\ntag_symbol = '🔖 '\n```\n## Git State [](https:\/\/starship.rs\/config\/#git-state)\nThe `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: *REBASING*, *BISECTING*, etc. If there is progress information (e.g., REBASING 3\/10), that information will be shown too.\n\n### Options [](https:\/\/starship.rs\/config\/#options-35)\n| Option | Default | Description |\n|---|---|---|\n| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |\n| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |\n| `revert` | `'REVERTING'` | A format string displayed when a `revert` is in progress. |\n| `cherry_pick` | `'CHERRY-PICKING'` | A format string displayed when a `cherry-pick` is in progress. |\n| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |\n| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. |\n| `am_or_rebase` | `'AM\/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `format` | `'\$[$state( $progress_current\/$progress_total)]($style)\$ '` | The format for the module. |\n| `disabled` | `false` | Disables the `git_state` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-30)\n| Variable | Example | Description |\n|---|---|---|\n| state | `REBASING` | The current state of the repo |\n| progress\\_current | `1` | The current operation progress |\n| progress\\_total | `2` | The total operation progress |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-28)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_state]\nformat = '[\$$state( $progress_current of $progress_total)\$]($style) '\ncherry_pick = '[🍒 PICKING](bold red)'\n```\n## Git Metrics [](https:\/\/starship.rs\/config\/#git-metrics)\nThe `git_metrics` module will show the number of added and deleted lines in the current git repository.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-36)\n| Option | Default | Description |\n|---|---|---|\n| `added_style` | `'bold green'` | The style for the added count. |\n| `deleted_style` | `'bold red'` | The style for the deleted count. |\n| `only_nonzero_diffs` | `true` | Render status only for changed items. |\n| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |\n| `disabled` | `true` | Disables the `git_metrics` module. |\n| `ignore_submodules` | `false` | Ignore changes to submodules |\n### Variables [](https:\/\/starship.rs\/config\/#variables-31)\n| Variable | Example | Description |\n|---|---|---|\n| added | `1` | The current number of added lines |\n| deleted | `2` | The current number of deleted lines |\n| added\\_style\\* |   | Mirrors the value of option `added_style` |\n| deleted\\_style\\* |   | Mirrors the value of option `deleted_style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-29)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_metrics]\nadded_style = 'bold blue'\nformat = '[+$added]($added_style)\/[-$deleted]($deleted_style) '\n```\n## Git Status [](https:\/\/starship.rs\/config\/#git-status)\nThe `git_status` module shows symbols representing the state of the repo in your current directory.\n\nTIP\n\nThe Git Status module is very slow in Windows directories (for example under `\/mnt\/c\/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths.\n### Options [](https:\/\/starship.rs\/config\/#options-37)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'([\\[$all_status$ahead_behind\\]]($style) )'` | The default format for `git_status` |\n| `conflicted` | `'='` | This branch has merge conflicts. |\n| `ahead` | `'⇡'` | The format of `ahead` |\n| `behind` | `'⇣'` | The format of `behind` |\n| `diverged` | `'⇕'` | The format of `diverged` |\n| `up_to_date` | `''` | The format of `up_to_date` |\n| `untracked` | `'?'` | The format of `untracked` |\n| `stashed` | `'\\$'` | The format of `stashed` |\n| `modified` | `'!'` | The format of `modified` |\n| `staged` | `'+'` | The format of `staged` |\n| `renamed` | `'»'` | The format of `renamed` |\n| `deleted` | `'✘'` | The format of `deleted` |\n| `typechanged` | `\"\"` | The format of `typechanged` |\n| `style` | `'bold red'` | The style for the module. |\n| `ignore_submodules` | `false` | Ignore changes to submodules. |\n| `disabled` | `false` | Disables the `git_status` module. |\n| `windows_starship` |   | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |\n| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-32)\nThe following variables can be used in `format`:\n\n| Variable | Description |\n|---|---|\n| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked` |\n| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. |\n| `conflicted` | Displays `conflicted` when this branch has merge conflicts. |\n| `untracked` | Displays `untracked` when there are untracked files in the working directory. |\n| `stashed` | Displays `stashed` when a stash exists for the local repository. |\n| `modified` | Displays `modified` when there are file modifications in the working directory. |\n| `staged` | Displays `staged` when a new file has been added to the staging area. |\n| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |\n| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |\n| `typechanged` | Displays `typechanged` when a file's type has been changed in the staging area. |\n| style\\* | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\nThe following variables can be used in `diverged`:\n\n| Variable | Description |\n|---|---|\n| `ahead_count` | Number of commits ahead of the tracking branch |\n| `behind_count` | Number of commits behind the tracking branch |\n\nThe following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`:\n\n| Variable | Description |\n|---|---|\n| `count` | Show the number of files |\n### Example [](https:\/\/starship.rs\/config\/#example-30)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_status]\nconflicted = '🏳'\nahead = '🏎💨'\nbehind = '😰'\ndiverged = '😵'\nup_to_date = '✓'\nuntracked = '🤷'\nstashed = '📦'\nmodified = '📝'\nstaged = '[++\$$count\$](green)'\nrenamed = '👅'\ndeleted = '🗑'\n```\n\nShow ahead\/behind count of the branch being tracked\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_status]\nahead = '⇡${count}'\ndiverged = '⇕⇡${ahead_count}⇣${behind_count}'\nbehind = '⇣${count}'\n```\n\nUse Windows Starship executable on Windows paths in WSL\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_status]\nwindows_starship = '\/mnt\/c\/Users\/username\/scoop\/apps\/starship\/current\/starship.exe'\n```\n## Gleam [](https:\/\/starship.rs\/config\/#gleam)\nThe `gleam` module shows the currently installed version of [Gleam](https:\/\/gleam.run\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `gleam.toml` file\n- The current directory contains a file with the `.gleam` extension\n### Options [](https:\/\/starship.rs\/config\/#options-38)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'⭐ '` | A format string representing the symbol of Gleam. |\n| `detect_extensions` | `['gleam']` | Which extensions should trigger this module. |\n| `detect_files` | `['gleam.toml']` | Which filenames should trigger this module. |\n| `style` | `'bold #FFAFF3'` | The style for the module. |\n| `disabled` | `false` | Disables the `gleam` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-33)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.0.0` | The version of `gleam` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-31)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[gleam]\nformat = 'via [⭐ $version](bold red) '\n```\n## Go [](https:\/\/starship.rs\/config\/#go)\nThe `golang` module shows the currently installed version of [Go](https:\/\/golang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `go.mod` file\n- The current directory contains a `go.sum` file\n- The current directory contains a `go.work` file\n- The current directory contains a `glide.yaml` file\n- The current directory contains a `Gopkg.yml` file\n- The current directory contains a `Gopkg.lock` file\n- The current directory contains a `.go-version` file\n- The current directory contains a `Godeps` directory\n- The current directory contains a file with the `.go` extension\n### Options [](https:\/\/starship.rs\/config\/#options-39)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐹 '` | A format string representing the symbol of Go. |\n| `detect_extensions` | `['go']` | Which extensions should trigger this module. |\n| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `['Godeps']` | Which folders should trigger this module. |\n| `style` | `'bold cyan'` | The style for the module. |\n| `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |\n| `disabled` | `false` | Disables the `golang` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-34)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.12.1` | The version of `go` |\n| mod\\_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-32)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[golang]\nformat = 'via [🏎💨 $version](bold cyan) '\n```\n### Using `mod_version` [](https:\/\/starship.rs\/config\/#using-mod-version)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[golang]\nformat = 'via [$symbol($version )($mod_version )]($style)'\n```\n## Guix-shell [](https:\/\/starship.rs\/config\/#guix-shell)\nThe `guix_shell` module shows the [guix-shell](https:\/\/guix.gnu.org\/manual\/devel\/en\/html_node\/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.\n\n### Options [](https:\/\/starship.rs\/config\/#options-40)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol]($style) '` | The format for the module. |\n| `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |\n| `style` | `'yellow bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `guix_shell` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-35)\n| Variable | Example | Description |\n|---|---|---|\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-33)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[guix_shell]\ndisabled = true\nformat = 'via [🐂](yellow bold) '\n```\n## Gradle [](https:\/\/starship.rs\/config\/#gradle)\nThe `gradle` module shows the version of the [Gradle Wrapper](https:\/\/docs.gradle.org\/current\/userguide\/gradle_wrapper.html) currently used in the project directory.\n\nBy default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `gradle\/wrapper\/gradle-wrapper.properties` directory.\n- The current directory contains a file ending with `.gradle` or `.gradle.kts`.\n\nThe `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns.\n\n### Options [](https:\/\/starship.rs\/config\/#options-41)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |\n| `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `['gradle']` | Which folders should trigger this module. |\n| `style` | `'bold bright-cyan'` | The style for the module. |\n| `disabled` | `false` | Disables the `gradle` module. |\n| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-36)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v7.5.1` | The version of `gradle` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Haskell [](https:\/\/starship.rs\/config\/#haskell)\nThe `haskell` module finds the current selected GHC version and\/or the selected Stack snapshot.\n\nBy default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `stack.yaml` file\n- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file\n### Options [](https:\/\/starship.rs\/config\/#options-42)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `symbol` | `'λ '` | A format string representing the symbol of Haskell |\n| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Which extensions should trigger this module. |\n| `detect_files` | `['stack.yaml', 'cabal.project']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold purple'` | The style for the module. |\n| `disabled` | `false` | Disables the `haskell` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-37)\n| Variable | Example | Description |\n|---|---|---|\n| version |   | `ghc_version` or `snapshot` depending on whether the current project is a Stack project |\n| snapshot | `lts-18.12` | Currently selected Stack snapshot |\n| ghc\\_version | `9.2.1` | Currently installed GHC version |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Haxe [](https:\/\/starship.rs\/config\/#haxe)\nThe `haxe` module shows the currently installed version of [Haxe](https:\/\/haxe.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `project.xml`, `Project.xml`, `application.xml`, `haxelib.json`, `hxformat.json` or `.haxerc` file\n- The current directory contains a `.haxelib` or a `haxe_libraries` directory\n- The current directory contains a file with the `.hx` or `.hxml` extension\n### Options [](https:\/\/starship.rs\/config\/#options-43)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `['hx', 'hxml']` | Which extensions should trigger this module. |\n| `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | Which filenames should trigger this module. |\n| `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |\n| `symbol` | `'⌘ '` | A format string representing the symbol of Haxe. |\n| `style` | `'bold fg:202'` | The style for the module. |\n| `disabled` | `false` | Disables the `haxe` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-38)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v4.2.5` | The version of `haxe` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-34)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[haxe]\nformat = \"via [⌘ $version](bold fg:202) \"\n```\n## Helm [](https:\/\/starship.rs\/config\/#helm)\nThe `helm` module shows the currently installed version of [Helm](https:\/\/helm.sh\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `helmfile.yaml` file\n- The current directory contains a `Chart.yaml` file\n### Options [](https:\/\/starship.rs\/config\/#options-44)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `symbol` | `'⎈ '` | A format string representing the symbol of Helm. |\n| `style` | `'bold white'` | The style for the module. |\n| `disabled` | `false` | Disables the `helm` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-39)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v3.1.1` | The version of `helm` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-35)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[helm]\nformat = 'via [⎈ $version](bold white) '\n```\n## Hostname [](https:\/\/starship.rs\/config\/#hostname)\nThe `hostname` module shows the system hostname.\n\n### Options [](https:\/\/starship.rs\/config\/#options-45)\n| Option | Default | Description |\n|---|---|---|\n| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |\n| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |\n| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation. |\n| `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. |\n| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |\n| `style` | `'bold dimmed green'` | The style for the module. |\n| `disabled` | `false` | Disables the `hostname` module. |\n| `aliases` | `{}` | Translate system hostnames to something else. If `trim_at` is specified, only the first part will be matched and replaced. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-40)\n| Variable | Example | Description |\n|---|---|---|\n| hostname | `computer` | The hostname of the computer |\n| style\\* |   | Mirrors the value of option `style` |\n| ssh\\_symbol | `'🌏 '` | The symbol to represent when connected to SSH session |\n\n\\*: This variable can only be used as a part of a style string\n\n### Examples [](https:\/\/starship.rs\/config\/#examples-4)\n#### Always show the hostname [](https:\/\/starship.rs\/config\/#always-show-the-hostname)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[hostname]\nssh_only = false\nformat = '[$ssh_symbol](bold blue) on [$hostname](bold red) '\ntrim_at = '.companyname.com'\ndisabled = false\n```\n#### Hide the hostname in remote tmux sessions [](https:\/\/starship.rs\/config\/#hide-the-hostname-in-remote-tmux-sessions)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[hostname]\nssh_only = false\ndetect_env_vars = ['!TMUX', 'SSH_CONNECTION']\ndisabled = false\n```\n#### Replace the hostname with a nickname [](https:\/\/starship.rs\/config\/#replace-the-hostname-with-a-nickname)\ntoml\n```\n# ~\/.config\/starship.toml\n[hostname]\naliases = { \"Max's MacBook Pro\" = \"home\" }\n```\n## Java [](https:\/\/starship.rs\/config\/#java)\nThe `java` module shows the currently installed version of [Java](https:\/\/www.oracle.com\/java\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, `build.boot`, or `.sdkmanrc` file\n- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension\n### Options [](https:\/\/starship.rs\/config\/#options-46)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [${symbol}(${version} )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Which extensions should trigger this module. |\n| `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `symbol` | `'☕ '` | A format string representing the symbol of Java |\n| `style` | `'red dimmed'` | The style for the module. |\n| `disabled` | `false` | Disables the `java` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-41)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v14` | The version of `java` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-36)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[java]\nsymbol = '🌟 '\n```\n## Jobs [](https:\/\/starship.rs\/config\/#jobs)\nThe `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running.\n\nThe default functionality is:\n\n- 0 jobs -\\> Nothing is shown.\n- 1 job -\\> `symbol` is shown.\n- 2 jobs or more -\\> `symbol` + `number` are shown.\n\nWARNING\n\nThis module is not supported on tcsh.\n\nWARNING\n\nThe `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.\n### Options [](https:\/\/starship.rs\/config\/#options-47)\n| Option | Default | Description |\n|---|---|---|\n| `threshold`\\* | `1` | Show number of jobs if exceeded. |\n| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. |\n| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. |\n| `format` | `'[$symbol$number]($style) '` | The format for the module. |\n| `symbol` | `'✦'` | The string used to represent the `symbol` variable. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `jobs` module. |\n\n\\*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead.\n\n### Variables [](https:\/\/starship.rs\/config\/#variables-42)\n| Variable | Example | Description |\n|---|---|---|\n| number | `1` | The number of jobs |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Examples [](https:\/\/starship.rs\/config\/#examples-5)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[jobs]\nsymbol = '+ '\nnumber_threshold = 4\nsymbol_threshold = 0\n```\n#### Changing process grouping behavior in fish [](https:\/\/starship.rs\/config\/#changing-process-grouping-behavior-in-fish)\nWhen using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:\n\nfish\n```\nset -g __starship_fish_use_job_groups \"false\"\n```\n## Julia [](https:\/\/starship.rs\/config\/#julia)\nThe `julia` module shows the currently installed version of [Julia](https:\/\/julialang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Project.toml` file\n- The current directory contains a `Manifest.toml` file\n- The current directory contains a file with the `.jl` extension\n### Options [](https:\/\/starship.rs\/config\/#options-48)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `['jl']` | Which extensions should trigger this module. |\n| `detect_files` | `['Project.toml', 'Manifest.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. |\n| `style` | `'bold purple'` | The style for the module. |\n| `disabled` | `false` | Disables the `julia` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-43)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.4.0` | The version of `julia` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-37)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[julia]\nsymbol = '∴ '\n```\n## Kotlin [](https:\/\/starship.rs\/config\/#kotlin)\nThe `kotlin` module shows the currently installed version of [Kotlin](https:\/\/kotlinlang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `.kt` or a `.kts` file\n### Options [](https:\/\/starship.rs\/config\/#options-49)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `['kt', 'kts']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. |\n| `style` | `'bold blue'` | The style for the module. |\n| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. |\n| `disabled` | `false` | Disables the `kotlin` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-44)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.4.21` | The version of `kotlin` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-38)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[kotlin]\nsymbol = '🅺 '\n```\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[kotlin]\n# Uses the Kotlin Compiler binary to get the installed version\nkotlin_binary = 'kotlinc'\n```\n## Kubernetes [](https:\/\/starship.rs\/config\/#kubernetes)\nDisplays the current [Kubernetes context](https:\/\/kubernetes.io\/docs\/concepts\/configuration\/organize-cluster-access-kubeconfig\/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~\/.kube\/config`.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n\nWhen the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.\n### Options [](https:\/\/starship.rs\/config\/#options-50)\nWARNING\n\nThe `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.\n\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |\n| `format` | `'[$symbol$context( \$$namespace\$)]($style) in '` | The format for the module. |\n| `style` | `'cyan bold'` | The style for the module. |\n| `context_aliases`\\* | `{}` | Table of context aliases to display. |\n| `user_aliases`\\* | `{}` | Table of user aliases to display. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |\n| `contexts` | `[]` | Customized styles and symbols for specific contexts. |\n| `disabled` | `true` | Disables the `kubernetes` module. |\n\n\\*: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead.\n\nTo customize the style of the module for specific environments, use the following configuration as part of the `contexts` list:\n\n| Variable | Description |\n|---|---|\n| `context_pattern` | **Required** Regular expression to match current Kubernetes context name. |\n| `user_pattern` | Regular expression to match current Kubernetes user name. |\n| `context_alias` | Context alias to display instead of the full context name. |\n| `user_alias` | User alias to display instead of the full user name. |\n| `style` | The style for the module when using this context. If not set, will use module's style. |\n| `symbol` | The symbol for the module when using this context. If not set, will use module's symbol. |\n\nNote that all regular expression are anchored with `^<pattern>$` and so must match the whole string. The `*_pattern` regular expressions may contain capture groups, which can be referenced in the corresponding alias via `$name` and `$N` (see example below and the [rust Regex::replace() documentation](https:\/\/docs.rs\/regex\/latest\/regex\/struct.Regex.html#method.replace)).\n\n### Variables [](https:\/\/starship.rs\/config\/#variables-45)\n| Variable | Example | Description |\n|---|---|---|\n| context | `starship-context` | The current kubernetes context name |\n| namespace | `starship-namespace` | If set, the current kubernetes namespace |\n| user | `starship-user` | If set, the current kubernetes user |\n| cluster | `starship-cluster` | If set, the current kubernetes cluster |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-39)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[kubernetes]\nformat = 'on [⛵ ($user on )($cluster in )$context \$$namespace\$](dimmed green) '\ndisabled = false\ncontexts = [\n  { context_pattern = \"dev.local.cluster.k8s\", style = \"green\", symbol = \"💔 \" },\n]\n```\n\nOnly show the module in directories that contain a `k8s` file.\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[kubernetes]\ndisabled = false\ndetect_files = ['k8s']\n```\n#### Kubernetes Context specific config [](https:\/\/starship.rs\/config\/#kubernetes-context-specific-config)\nThe `contexts` configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[[kubernetes.contexts]]\n# \"bold red\" style + default symbol when Kubernetes current context name equals \"production\" *and* the current user\n# equals \"admin_user\"\ncontext_pattern = \"production\"\nuser_pattern = \"admin_user\"\nstyle = \"bold red\"\ncontext_alias = \"prod\"\nuser_alias = \"admin\"\n\n[[kubernetes.contexts]]\n# \"green\" style + a different symbol when Kubernetes current context name contains openshift\ncontext_pattern = \".*openshift.*\"\nstyle = \"green\"\nsymbol = \"💔 \"\ncontext_alias = \"openshift\"\n\n[[kubernetes.contexts]]\n# Using capture groups\n# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region\/zone.\n# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)\n# and renames every matching kube context into a more readable format (`gke-cluster-name`):\ncontext_pattern = \"gke_.*_(?P<cluster>[\\\\w-]+)\"\ncontext_alias = \"gke-$cluster\"\n```\n## Line Break [](https:\/\/starship.rs\/config\/#line-break)\nThe `line_break` module separates the prompt into two lines.\n\n### Options [](https:\/\/starship.rs\/config\/#options-51)\n| Option | Default | Description |\n|---|---|---|\n| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |\n### Example [](https:\/\/starship.rs\/config\/#example-40)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[line_break]\ndisabled = true\n```\n## Local IP [](https:\/\/starship.rs\/config\/#local-ip)\nThe `localip` module shows the IPv4 address of the primary network interface.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-52)\n| Option | Default | Description |\n|---|---|---|\n| `ssh_only` | `true` | Only show IP address when connected to an SSH session. |\n| `format` | `'[$localipv4]($style) '` | The format for the module. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `true` | Disables the `localip` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-46)\n| Variable | Example | Description |\n|---|---|---|\n| localipv4 | 192\\.168.1.13 | Contains the primary IPv4 address |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-41)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[localip]\nssh_only = false\nformat = '@[$localipv4](bold red) '\ndisabled = false\n```\n## Lua [](https:\/\/starship.rs\/config\/#lua)\nThe `lua` module shows the currently installed version of [Lua](http:\/\/www.lua.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `.lua-version` file\n- The current directory contains a `lua` directory\n- The current directory contains a file with the `.lua` extension\n### Options [](https:\/\/starship.rs\/config\/#options-53)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. |\n| `detect_extensions` | `['lua']` | Which extensions should trigger this module. |\n| `detect_files` | `['.lua-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `['lua']` | Which folders should trigger this module. |\n| `style` | `'bold blue'` | The style for the module. |\n| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. |\n| `disabled` | `false` | Disables the `lua` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-47)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v5.4.0` | The version of `lua` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-42)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[lua]\nformat = 'via [🌕 $version](bold blue) '\n```\n## Memory Usage [](https:\/\/starship.rs\/config\/#memory-usage)\nThe `memory_usage` module shows current system memory and swap usage.\n\nBy default the swap usage is displayed if the total system swap is non-zero.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-54)\n| Option | Default | Description |\n|---|---|---|\n| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |\n| `format` | `'via $symbol [${ram}( | ${swap})]($style) '` | The format for the module. |\n| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. |\n| `style` | `'bold dimmed white'` | The style for the module. |\n| `disabled` | `true` | Disables the `memory_usage` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-48)\n| Variable | Example | Description |\n|---|---|---|\n| ram | `31GiB\/65GiB` | The usage\/total RAM of the current system memory. |\n| ram\\_pct | `48%` | The percentage of the current system memory. |\n| swap\\*\\* | `1GiB\/4GiB` | The swap memory size of the current system swap memory file. |\n| swap\\_pct\\*\\* | `77%` | The swap memory percentage of the current system swap memory file. |\n| symbol | `🐏` | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string \\*\\*: The SWAP file information is only displayed if detected on the current system\n\n### Example [](https:\/\/starship.rs\/config\/#example-43)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[memory_usage]\ndisabled = false\nthreshold = -1\nsymbol = ' '\nstyle = 'bold dimmed green'\n```\n## Meson [](https:\/\/starship.rs\/config\/#meson)\nThe `meson` module shows the current Meson developer environment status.\n\nBy default the Meson project name is displayed, if `$MESON_DEVENV` is set.\n\n### Options [](https:\/\/starship.rs\/config\/#options-55)\n| Option | Default | Description |\n|---|---|---|\n| `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. |\n| `truncation_symbol` | `'…'` | The symbol used to indicate a project name was truncated. You can use `''` for no symbol. |\n| `format` | `'via [$symbol$project]($style) '` | The format for the module. |\n| `symbol` | `'⬢ '` | The symbol used before displaying the project name. |\n| `style` | `'blue bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `meson` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-49)\n| Variable | Example | Description |\n|---|---|---|\n| project | `starship` | The current Meson project name |\n| symbol | `🐏` | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-44)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[meson]\ndisabled = false\ntruncation_symbol = '--'\nsymbol = ' '\nstyle = 'bold dimmed green'\n```\n## Mercurial Branch [](https:\/\/starship.rs\/config\/#mercurial-branch)\nThe `hg_branch` module shows the active branch and topic of the repo in your current directory.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-56)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |\n| `style` | `'bold purple'` | The style for the module. |\n| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |\n| `truncation_length` | `2^63 - 1` | Truncates the hg branch \/ topic name to `N` graphemes |\n| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |\n| `disabled` | `true` | Disables the `hg_branch` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-50)\n| Variable | Example | Description |\n|---|---|---|\n| branch | `master` | The active mercurial branch |\n| topic | `feature` | The active mercurial topic |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-45)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[hg_branch]\nformat = 'on [🌱 $branch](bold purple)'\ntruncation_length = 4\ntruncation_symbol = ''\n```\n## Mercurial State [](https:\/\/starship.rs\/config\/#mercurial-state)\nThe `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: *REBASING*, *BISECTING*, etc.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-57)\n| Option | Default | Description |\n|---|---|---|\n| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |\n| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |\n| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |\n| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |\n| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |\n| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |\n| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |\n| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `format` | `'\$[$state]($style)\$ '` | The format for the module. |\n| `disabled` | `true` | Disables the `hg_state` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-51)\n| Variable | Example | Description |\n|---|---|---|\n| state | `REBASING` | The current state of the repo |\n| progress\\_current | `1` | The current operation progress |\n| progress\\_total | `2` | The total operation progress |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Mise [](https:\/\/starship.rs\/config\/#mise)\nThe `mise` module shows the current mise health as reported by running `mise doctor`.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-58)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'mise '` | The symbol used before displaying *mise* health. |\n| `style` | `'bold purple'` | The style for the module. |\n| `format` | `'on [$symbol$health]($style) '` | The format for the module. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['mise.toml', 'mise.local.toml', '.mise.toml', '.mise.local.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `['.mise']` | Which folders should trigger this module. |\n| `healthy_symbol` | `healthy` | The message displayed when *mise* is healthy. |\n| `unhealthy_symbol` | `unhealthy` | The message displayed when *mise* is unhealthy. |\n| `disabled` | `true` | Disables the `mise` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-52)\n| Variable | Example | Description |\n|---|---|---|\n| health | `healthy` | The health of *mise* |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-46)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[mise]\nhealth = 'ready'\n```\n## Mojo [](https:\/\/starship.rs\/config\/#mojo)\nThe `mojo` module shows the current version of [Mojo programming language](https:\/\/www.modular.com\/mojo) installed\n\n### Options [](https:\/\/starship.rs\/config\/#options-59)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'with [$symbol($version )]($style)'` | The format for the module. |\n| `symbol` | `'🔥 '` | The symbol used before displaying the version of Mojo. |\n| `style` | `'bold 208'` | The style for the module. |\n| `disabled` | `false` | Disables the `mojo` module. |\n| `detect_extensions` | `['mojo', '🔥']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-53)\n| Variable | Example | Description |\n|---|---|---|\n| version | `24.4.0` | The version of `mojo` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-47)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[mojo]\nformat = 'via [mojo ($version )($hash )]($style)'\n```\n## NATS [](https:\/\/starship.rs\/config\/#nats)\nThe `nats` module shows the name of the current [NATS](https:\/\/nats.io\/) context.\n\n### Options [](https:\/\/starship.rs\/config\/#options-60)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'✉️ '` | The symbol used before the NATS context (defaults to empty). |\n| `style` | `'bold purple'` | The style for the module. |\n| `format` | `'[$symbol$name]($style)'` | The format for the module. |\n| `disabled` | `false` | Disables the `nats` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-54)\n| Variable | Example | Description |\n|---|---|---|\n| name | `localhost` | The name of the NATS context |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-48)\ntoml\n```\n[nats]\nformat = '[$symbol]($style)'\nstyle = 'bold purple'\n```\n## Network Namespace [](https:\/\/starship.rs\/config\/#network-namespace)\nThe `netns` module shows the current network namespace. This uses `ip netns identify` to get the network namespace, so only network namespaces mounted at `\/var\/run\/netns` will be detected.\n\n### Options [](https:\/\/starship.rs\/config\/#options-61)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[$symbol \\[$name\\]]($style)'` | The format for the module. |\n| `symbol` | `'🛜 '` | The symbol used before the network namespace (defaults to empty). |\n| `style` | `'blue bold dimmed'` | The style for the module. |\n| `disabled` | `false` | Disables the `netns` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-55)\n| Variable | Example | Description |\n|---|---|---|\n| name | `my-netns` | The name of the current network namespace |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-49)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[netns]\nstyle = 'bold yellow'\nsymbol = '🌐 '\n```\n## Nim [](https:\/\/starship.rs\/config\/#nim)\nThe `nim` module shows the currently installed version of [Nim](https:\/\/nim-lang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `nim.cfg` file\n- The current directory contains a file with the `.nim` extension\n- The current directory contains a file with the `.nims` extension\n- The current directory contains a file with the `.nimble` extension\n### Options [](https:\/\/starship.rs\/config\/#options-62)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. |\n| `detect_extensions` | `['nim', 'nims', 'nimble']` | Which extensions should trigger this module. |\n| `detect_files` | `['nim.cfg']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `false` | Disables the `nim` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-56)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.2.0` | The version of `nimc` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-50)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[nim]\nstyle = 'yellow'\nsymbol = '🎣 '\n```\n## Nix-shell [](https:\/\/starship.rs\/config\/#nix-shell)\nThe `nix_shell` module shows the [nix-shell](https:\/\/nixos.org\/guides\/nix-pills\/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment.\n\n### Options [](https:\/\/starship.rs\/config\/#options-63)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol$state( \$$name\$)]($style) '` | The format for the module. |\n| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |\n| `style` | `'bold blue'` | The style for the module. |\n| `impure_msg` | `'impure'` | A format string shown when the shell is impure. |\n| `pure_msg` | `'pure'` | A format string shown when the shell is pure. |\n| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure\/impure. |\n| `disabled` | `false` | Disables the `nix_shell` module. |\n| `heuristic` | `false` | Attempts to detect new `nix shell`\\-style shells with a heuristic. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-57)\n| Variable | Example | Description |\n|---|---|---|\n| state | `pure` | The state of the nix-shell |\n| name | `lorri` | The name of the nix-shell |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-51)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[nix_shell]\ndisabled = true\nimpure_msg = '[impure shell](bold red)'\npure_msg = '[pure shell](bold green)'\nunknown_msg = '[unknown shell](bold yellow)'\nformat = 'via [☃️ $state( \$$name\$)](bold blue) '\n```\n## Node.js [](https:\/\/starship.rs\/config\/#node-js)\nThe `nodejs` module shows the currently installed version of [Node.js](https:\/\/nodejs.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `package.json` file\n- The current directory contains a `.node-version` file\n- The current directory contains a `.nvmrc` file\n- The current directory contains a `node_modules` directory\n- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension\n- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension\n\nAdditionally, the module will be hidden by default if the directory contains a `bunfig.toml`, `bun.lock`, or `bun.lockb` file, overriding the above conditions.\n\n### Options [](https:\/\/starship.rs\/config\/#options-64)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `' '` | A format string representing the symbol of Node.js. |\n| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Which extensions should trigger this module. |\n| `detect_files` | `['package.json', '.node-version', '.nvmrc']` | Which filenames should trigger this module. |\n| `detect_folders` | `['node_modules']` | Which folders should trigger this module. |\n| `style` | `'bold green'` | The style for the module. |\n| `disabled` | `false` | Disables the `nodejs` module. |\n| `not_capable_style` | `'bold red'` | The style for the module when an engines property in package.json does not match the Node.js version. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-58)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v13.12.0` | The version of `node` |\n| engines\\_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-52)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[nodejs]\nformat = 'via [🤖 $version](bold green) '\n```\n## OCaml [](https:\/\/starship.rs\/config\/#ocaml)\nThe `ocaml` module shows the currently installed version of [OCaml](https:\/\/ocaml.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with `.opam` extension or `_opam` directory\n- The current directory contains a `esy.lock` directory\n- The current directory contains a `dune` or `dune-project` file\n- The current directory contains a `jbuild` or `jbuild-ignore` file\n- The current directory contains a `.merlin` file\n- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension\n### Options [](https:\/\/starship.rs\/config\/#options-65)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )(\$$switch_indicator$switch_name\$ )]($style)'` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐫 '` | The symbol used before displaying the version of OCaml. |\n| `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. |\n| `local_switch_indicator` | `'*'` | The format string used to represent local OPAM switch. |\n| `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Which extensions should trigger this module. |\n| `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | Which filenames should trigger this module. |\n| `detect_folders` | `['_opam', 'esy.lock']` | Which folders should trigger this module. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `false` | Disables the `ocaml` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-59)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v4.10.0` | The version of `ocaml` |\n| switch\\_name | `my-project` | The active OPAM switch |\n| switch\\_indicator |   | Mirrors the value of `indicator` for currently active OPAM switch |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-53)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[ocaml]\nformat = 'via [🐪 $version]($style) '\n```\n## Odin [](https:\/\/starship.rs\/config\/#odin)\nThe `odin` module shows the currently installed version of [Odin](https:\/\/odin-lang.org\/). By default the module will be shown if the current directory contains a `.odin` file.\n\n### Options [](https:\/\/starship.rs\/config\/#options-66)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `show_commit` | `false` | Shows the commit as part of the version. |\n| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |\n| `style` | `'bold bright-blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `odin` module. |\n| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-60)\n| Variable | Example | Description |\n|---|---|---|\n| version | `dev-2024-03` | The version of `odin` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-54)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[odin]\nformat = 'via [󰹩 ($version )]($style)'\nshow_commit = true\n```\n## Open Policy Agent [](https:\/\/starship.rs\/config\/#open-policy-agent)\nThe `opa` module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a `.rego` file.\n\n### Options [](https:\/\/starship.rs\/config\/#options-67)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🪖 '` | A format string representing the symbol of OPA. |\n| `detect_extensions` | `['rego']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `opa` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-61)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.44.0` | The version of `opa` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-55)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[opa]\nformat = 'via [⛑️  $version](bold red) '\n```\n## OpenStack [](https:\/\/starship.rs\/config\/#openstack)\nThe `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https:\/\/docs.openstack.org\/python-openstackclient\/latest\/configuration\/index.html#configuration-files). to fetch the current project in use.\n\n### Options [](https:\/\/starship.rs\/config\/#options-68)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'on [$symbol$cloud(\$$project\$)]($style) '` | The format for the module. |\n| `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `false` | Disables the `openstack` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-62)\n| Variable | Example | Description |\n|---|---|---|\n| cloud | `corp` | The current OpenStack cloud |\n| project | `dev` | The current OpenStack project |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-56)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[openstack]\nformat = 'on [$symbol$cloud(\$$project\$)]($style) '\nstyle = 'bold yellow'\nsymbol = '☁️ '\n```\n## OS [](https:\/\/starship.rs\/config\/#os)\nThe `os` module shows the current operating system. OS information is detected via the [os\\_info](https:\/\/lib.rs\/crates\/os_info) crate.\n\nWARNING\n\nThe [os\\_info](https:\/\/lib.rs\/crates\/os_info) crate used by this module is known to be inaccurate on some systems.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-69)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[$symbol]($style)'` | The format for the module. |\n| `style` | `'bold white'` | The style for the module. |\n| `disabled` | `true` | Disables the `os` module. |\n| `symbols` |   | A table that maps each operating system to its symbol. |\n\n`symbols` allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a [feature request](https:\/\/github.com\/starship\/starship\/issues\/new\/choose).\n\ntoml\n```\n# This is the default symbols table.\n[os.symbols]\nAIX = \"➿ \"\nAlpaquita = \"🔔 \"\nAlmaLinux = \"💠 \"\nAlpine = \"🏔️ \"\nALTLinux = \"Ⓐ \"\nAmazon = \"🙂 \"\nAndroid = \"🤖 \"\nAOSC = \"🐱 \"\nArch = \"🎗️ \"\nArtix = \"🎗️ \"\nBluefin = \"🐟 \"\nCachyOS = \"🎗️ \"\nCentOS = \"💠 \"\nDebian = \"🌀 \"\nDragonFly = \"🐉 \"\nElementary = \"🍏 \"\nEmscripten = \"🔗 \"\nEndeavourOS = \"🚀 \"\nFedora = \"🎩 \"\nFreeBSD = \"😈 \"\nGaruda = \"🦅 \"\nGentoo = \"🗜️ \"\nHardenedBSD = \"🛡️ \"\nIllumos = \"🐦 \"\nIos = \"📱 \"\nInstantOS = \"⏲️ \"\nKali = \"🐉 \"\nLinux = \"🐧 \"\nMabox = \"📦 \"\nMacos = \"🍎 \"\nManjaro = \"🥭 \"\nMariner = \"🌊 \"\nMidnightBSD = \"🌘 \"\nMint = \"🌿 \"\nNetBSD = \"🚩 \"\nNixOS = \"❄️ \"\nNobara = \"🎩 \"\nOpenBSD = \"🐡 \"\nOpenCloudOS = \"☁️ \"\nopenEuler = \"🦉 \"\nopenSUSE = \"🦎 \"\nOracleLinux = \"🦴 \"\nPikaOS = \"🐤 \"\nPop = \"🍭 \"\nRaspbian = \"🍓 \"\nRedhat = \"🎩 \"\nRedHatEnterprise = \"🎩 \"\nRockyLinux = \"💠 \"\nRedox = \"🧪 \"\nSolus = \"⛵ \"\nSUSE = \"🦎 \"\nUbuntu = \"🎯 \"\nUltramarine = \"🔷 \"\nUnknown = \"❓ \"\nUos = \"🐲 \"\nVoid = \" \"\nWindows = \"🪟 \"\nZorin = \"🔹 \"\n```\n### Variables [](https:\/\/starship.rs\/config\/#variables-63)\n| Variable | Example | Description |\n|---|---|---|\n| symbol | `🎗️` | The current operating system symbol from advanced option `symbols` |\n| name | `Arch Linux` | The current operating system name |\n| type | `Arch` | The current operating system type |\n| codename |   | The current operating system codename, if applicable |\n| edition |   | The current operating system edition, if applicable |\n| version |   | The current operating system version, if applicable |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-57)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[os]\nformat = \"on [($name )]($style)\"\nstyle = \"bold blue\"\ndisabled = false\n\n[os.symbols]\nWindows = \" \"\nArch = \"Arch is the best! \"\n```\n## Package Version [](https:\/\/starship.rs\/config\/#package-version)\nThe `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.\n\n- [**npm**](https:\/\/docs.npmjs.com\/cli\/commands\/npm) – The `npm` package version is extracted from the `package.json` present in the current directory\n- [**JSR**](https:\/\/jsr.io\/) – The `jsr` package version is extracted from the `jsr.json`\/`jsr.jsonc` or `deno.json`\/`deno.jsonc` present in the current directory\n- [**Cargo**](https:\/\/doc.rust-lang.org\/cargo\/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory\n- [**Nimble**](https:\/\/github.com\/nim-lang\/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command\n- [**Poetry**](https:\/\/python-poetry.org\/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory\n- [**Python**](https:\/\/www.python.org\/) - The `python` package version is extracted from a [PEP 621](https:\/\/peps.python.org\/pep-0621\/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory\n- [**Composer**](https:\/\/getcomposer.org\/) – The `composer` package version is extracted from the `composer.json` present in the current directory\n- [**Gradle**](https:\/\/gradle.org\/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory\n- [**Julia**](https:\/\/docs.julialang.org\/en\/v1\/stdlib\/Pkg\/) - The package version is extracted from the `Project.toml` present in the current directory\n- [**Mix**](https:\/\/hexdocs.pm\/mix\/) - The `mix` package version is extracted from the `mix.exs` present in the current directory\n- [**Helm**](https:\/\/helm.sh\/docs\/helm\/helm_package\/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory\n- [**Maven**](https:\/\/maven.apache.org\/) - The `maven` package version is extracted from the `pom.xml` present in the current directory\n- [**Meson**](https:\/\/mesonbuild.com\/) - The `meson` package version is extracted from the `meson.build` present in the current directory\n- [**Shards**](https:\/\/crystal-lang.org\/reference\/the_shards_command\/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory\n- [**Galaxy**](https:\/\/galaxy.ansible.com\/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory\n- [**V**](https:\/\/vlang.io\/) - The `vlang` package version is extracted from the `v.mod` present in the current directory\n- [**SBT**](https:\/\/scala-sbt.org\/) - The `sbt` package version is extracted from the `build.sbt` present in the current directory\n- [**Daml**](https:\/\/www.digitalasset.com\/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory\n- [**Dart**](https:\/\/pub.dev\/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory\n\n> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.\n### Options [](https:\/\/starship.rs\/config\/#options-70)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'is [$symbol$version]($style) '` | The format for the module. |\n| `symbol` | `'📦 '` | The symbol used before displaying the version the package. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `style` | `'bold 208'` | The style for the module. |\n| `display_private` | `false` | Enable displaying version for packages marked as private. |\n| `disabled` | `false` | Disables the `package` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-64)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.0.0` | The version of your package |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-58)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[package]\nformat = 'via [🎁 $version](208 bold) '\n```\n## Perl [](https:\/\/starship.rs\/config\/#perl)\nThe `perl` module shows the currently installed version of [Perl](https:\/\/www.perl.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Makefile.PL` or `Build.PL` file\n- The current directory contains a `cpanfile` or `cpanfile.snapshot` file\n- The current directory contains a `META.json` file or `META.yml` file\n- The current directory contains a `.perl-version` file\n- The current directory contains a `.pl`, `.pm` or `.pod`\n### Options [](https:\/\/starship.rs\/config\/#options-71)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl |\n| `detect_extensions` | `['pl', 'pm', 'pod']` | Which extensions should trigger this module. |\n| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold 149'` | The style for the module. |\n| `disabled` | `false` | Disables the `perl` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-65)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v5.26.1` | The version of `perl` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-59)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[perl]\nformat = 'via [🦪 $version]($style) '\n```\n## PHP [](https:\/\/starship.rs\/config\/#php)\nThe `php` module shows the currently installed version of [PHP](https:\/\/www.php.net\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `composer.json` file\n- The current directory contains a `.php-version` file\n- The current directory contains a `.php` extension\n### Options [](https:\/\/starship.rs\/config\/#options-72)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. |\n| `detect_extensions` | `['php']` | Which extensions should trigger this module. |\n| `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'147 bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `php` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-66)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v7.3.8` | The version of `php` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-60)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[php]\nformat = 'via [🔹 $version](147 bold) '\n```\n## Pijul Channel [](https:\/\/starship.rs\/config\/#pijul-channel)\nThe `pijul_channel` module shows the active channel of the repo in your current directory.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-73)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. |\n| `style` | `'bold purple'` | The style for the module. |\n| `format` | `'on [$symbol$channel]($style) '` | The format for the module. |\n| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes |\n| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |\n| `disabled` | `true` | Disables the `pijul` module. |\n## Pixi [](https:\/\/starship.rs\/config\/#pixi)\nThe `pixi` module shows the installed [pixi](https:\/\/pixi.sh\/) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.\n\nTIP\n\nThis does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.\n### Options [](https:\/\/starship.rs\/config\/#options-74)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )(\$$environment\$ )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. |\n| `symbol` | `'🧚 '` | The symbol used before the environment name. |\n| `style` | `'yellow bold'` | The style for the module. |\n| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |\n| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `pixi` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-67)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.33.0` | The version of `pixi` |\n| environment | `py311` | The current pixi environment |\n| symbol |   | Mirrors the value of option `symbol` |\n| style |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-61)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[pixi]\nformat = '[$symbol$environment](yellow) '\n```\n## Pulumi [](https:\/\/starship.rs\/config\/#pulumi)\nThe `pulumi` module shows the current username, selected [Pulumi Stack](https:\/\/www.pulumi.com\/docs\/intro\/concepts\/stack\/), and version.\n\nTIP\n\nBy default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](https:\/\/starship.rs\/config\/#with-pulumi-version).\n\nBy default the module will be shown if any of the following conditions are met:\n\n- The current directory contains either `Pulumi.yaml` or `Pulumi.yml`\n- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` unless `search_upwards` is set to `false`\n### Options [](https:\/\/starship.rs\/config\/#options-75)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($username@)$stack]($style) '` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `' '` | A format string shown before the Pulumi stack. |\n| `style` | `'bold 5'` | The style for the module. |\n| `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. |\n| `disabled` | `false` | Disables the `pulumi` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-68)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.12.24` | The version of `pulumi` |\n| stack | `dev` | The current Pulumi stack |\n| username | `alice` | The current Pulumi username |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-62)\n#### With Pulumi Version [](https:\/\/starship.rs\/config\/#with-pulumi-version)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[pulumi]\nformat = '[🛥 ($version )$stack]($style) '\n```\n#### Without Pulumi version [](https:\/\/starship.rs\/config\/#without-pulumi-version)\ntoml\n```\n# ~\/.config\/starship.toml\n[pulumi]\nsymbol = '🛥 '\nformat = '[$symbol$stack]($style) '\n```\n## PureScript [](https:\/\/starship.rs\/config\/#purescript)\nThe `purescript` module shows the currently installed version of [PureScript](https:\/\/www.purescript.org\/) version. By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `spago.dhall` file\n- The current directory contains a `spago.yaml` file\n- The current directory contains a `spago.lock` file\n- The current directory contains a file with the `.purs` extension\n### Options [](https:\/\/starship.rs\/config\/#options-76)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. |\n| `detect_extensions` | `['purs']` | Which extensions should trigger this module. |\n| `detect_files` | `['spago.dhall', 'spago.yaml', 'spago.lock']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold white'` | The style for the module. |\n| `disabled` | `false` | Disables the `purescript` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-69)\n| Variable | Example | Description |\n|---|---|---|\n| version | `0.13.5` | The version of `purescript` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-63)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[purescript]\nformat = 'via [$symbol$version](bold white)'\n```\n## Python [](https:\/\/starship.rs\/config\/#python)\nThe `python` module shows the currently installed version of [Python](https:\/\/www.python.org\/) and the current [Python virtual environment](https:\/\/docs.python.org\/tutorial\/venv.html) if one is activated.\n\nIf `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.\n\nBy default, the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `.python-version` file\n- The current directory contains a `Pipfile` file\n- The current directory contains a `__init__.py` file\n- The current directory contains a `pyproject.toml` file\n- The current directory contains a `requirements.txt` file\n- The current directory contains a `setup.py` file\n- The current directory contains a `tox.ini` file\n- The current directory contains a file with the `.py` extension.\n- The current directory contains a file with the `.ipynb` extension.\n- A virtual environment is currently activated\n### Options [](https:\/\/starship.rs\/config\/#options-77)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\$$virtualenv\$ )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐍 '` | A format string representing the symbol of Python |\n| `style` | `'yellow bold'` | The style for the module. |\n| `pyenv_version_name` | `false` | Use pyenv to get Python version |\n| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used |\n| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should execute when getting the version. |\n| `detect_extensions` | `['py', 'ipynb']` | Which extensions should trigger this module |\n| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |\n| `detect_folders` | `[]` | Which folders should trigger this module |\n| `disabled` | `false` | Disables the `python` module. |\n\nTIP\n\nThe `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.\n\nThe default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv\/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `\/usr\/bin\/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.\n### Variables [](https:\/\/starship.rs\/config\/#variables-70)\n| Variable | Example | Description |\n|---|---|---|\n| version | `'v3.8.1'` | The version of `python` |\n| symbol | `'🐍 '` | Mirrors the value of option `symbol` |\n| style | `'yellow bold'` | Mirrors the value of option `style` |\n| pyenv\\_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` |\n| virtualenv | `'venv'` | The current `virtualenv` name |\n### Example [](https:\/\/starship.rs\/config\/#example-64)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[python]\nsymbol = '👾 '\npyenv_version_name = true\n```\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[python]\n# Only use the `python3` binary to get the version.\npython_binary = 'python3'\n```\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[python]\n# Don't trigger for files with the py extension\ndetect_extensions = []\n```\n## Quarto [](https:\/\/starship.rs\/config\/#quarto)\nThe `quarto` module shows the current installed version of Quarto used in a project.\n\nBy default, the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `_quarto.yml` file\n- The current directory contains any `*.qmd` file\n### Options [](https:\/\/starship.rs\/config\/#options-78)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'⨁ '` | A format string representing the symbol of Quarto |\n| `style` | `'bold #75AADB'` | The style for the module. |\n| `detect_extensions` | `['.qmd']` | Which extensions should trigger this module. |\n| `detect_files` | `['_quarto.yml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `quarto` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-71)\n| Variable | Example | Description |\n|---|---|---|\n| version | `1.4.549` | The version of `quarto` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## R [](https:\/\/starship.rs\/config\/#r)\nThe `rlang` module shows the currently installed version of [R](https:\/\/www.r-project.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with the `.R` extension.\n- The current directory contains a file with the `.Rd` extension.\n- The current directory contains a file with the `.Rmd` extension.\n- The current directory contains a file with the `.Rproj` extension.\n- The current directory contains a file with the `.Rsx` extension.\n- The current directory contains a `.Rprofile` file\n- The current directory contains a `.Rproj.user` folder\n### Options [](https:\/\/starship.rs\/config\/#options-79)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'📐'` | A format string representing the symbol of R. |\n| `style` | `'blue bold'` | The style for the module. |\n| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Which extensions should trigger this module |\n| `detect_files` | `['.Rprofile']` | Which filenames should trigger this module |\n| `detect_folders` | `['.Rproj.user']` | Which folders should trigger this module |\n| `disabled` | `false` | Disables the `r` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-72)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v4.0.5` | The version of `R` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style | `'blue bold'` | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-65)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[rlang]\nformat = 'with [📐 $version](blue bold) '\n```\n## Raku [](https:\/\/starship.rs\/config\/#raku)\nThe `raku` module shows the currently installed version of [Raku](https:\/\/www.raku.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `META6.json` file\n- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`\n### Options [](https:\/\/starship.rs\/config\/#options-80)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku |\n| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Which extensions should trigger this module. |\n| `detect_files` | `['META6.json']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold 149'` | The style for the module. |\n| `disabled` | `false` | Disables the `raku` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-73)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v6.d` | The version of `raku` |\n| vm\\_version | `moar` | The version of VM `raku` is built on |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-66)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[raku]\nformat = 'via [🦪 $version]($style) '\n```\n## Red [](https:\/\/starship.rs\/config\/#red)\nBy default the `red` module shows the currently installed version of [Red](https:\/\/www.red-lang.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with `.red` or `.reds` extension\n### Options [](https:\/\/starship.rs\/config\/#options-81)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🔺 '` | A format string representing the symbol of Red. |\n| `detect_extensions` | `['red']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'red bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `red` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-74)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v2.5.1` | The version of `red` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-67)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[red]\nsymbol = '🔴 '\n```\n## Ruby [](https:\/\/starship.rs\/config\/#ruby)\nBy default the `ruby` module shows the currently installed version of [Ruby](https:\/\/www.ruby-lang.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Gemfile` file\n- The current directory contains a `.ruby-version` file\n- The current directory contains a `.rb` file\n- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set\n\nStarship gets the current Ruby version by running `ruby -v`.\n\n### Options [](https:\/\/starship.rs\/config\/#options-82)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'💎 '` | A format string representing the symbol of Ruby. |\n| `detect_extensions` | `['rb']` | Which extensions should trigger this module. |\n| `detect_files` | `['Gemfile', '.ruby-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. |\n| `style` | `'bold red'` | The style for the module. |\n| `disabled` | `false` | Disables the `ruby` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-75)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v2.5.1` | The version of `ruby` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n| gemset | `test` | Optional, gets the current RVM gemset name. |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-68)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[ruby]\nsymbol = '🔺 '\n```\n## Rust [](https:\/\/starship.rs\/config\/#rust)\nBy default the `rust` module shows the currently installed version of [Rust](https:\/\/www.rust-lang.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Cargo.toml` file\n- The current directory contains a file with the `.rs` extension\n### Options [](https:\/\/starship.rs\/config\/#options-83)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🦀 '` | A format string representing the symbol of Rust |\n| `detect_extensions` | `['rs']` | Which extensions should trigger this module. |\n| `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold red'` | The style for the module. |\n| `disabled` | `false` | Disables the `rust` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-76)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.43.0-nightly` | The version of `rustc` |\n| numver | `1.51.0` | The numeric component of the `rustc` version |\n| toolchain | `beta` | The toolchain version |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-69)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[rust]\nformat = 'via [⚙️ $version](red bold)'\n```\n## Scala [](https:\/\/starship.rs\/config\/#scala)\nThe `scala` module shows the currently installed version of [Scala](https:\/\/www.scala-lang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file\n- The current directory contains a file with the `.scala` or `.sbt` extension\n- The current directory contains a directory named `.metals`\n### Options [](https:\/\/starship.rs\/config\/#options-84)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [${symbol}(${version} )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `['sbt', 'scala']` | Which extensions should trigger this module. |\n| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Which filenames should trigger this module. |\n| `detect_folders` | `['.metals']` | Which folders should trigger this modules. |\n| `symbol` | `'🆂 '` | A format string representing the symbol of Scala. |\n| `style` | `'red dimmed'` | The style for the module. |\n| `disabled` | `false` | Disables the `scala` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-77)\n| Variable | Example | Description |\n|---|---|---|\n| version | `2.13.5` | The version of `scala` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-70)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[scala]\nsymbol = '🌟 '\n```\n## Shell [](https:\/\/starship.rs\/config\/#shell)\nThe `shell` module shows an indicator for currently used shell.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-85)\n| Option | Default | Description |\n|---|---|---|\n| `bash_indicator` | `'bsh'` | A format string used to represent bash. |\n| `fish_indicator` | `'fsh'` | A format string used to represent fish. |\n| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |\n| `powershell_indicator` | `'psh'` | A format string used to represent powershell. |\n| `pwsh_indicator` |   | A format string used to represent pwsh. The default value mirrors the value of `powershell_indicator`. |\n| `ion_indicator` | `'ion'` | A format string used to represent ion. |\n| `elvish_indicator` | `'esh'` | A format string used to represent elvish. |\n| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |\n| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. |\n| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. |\n| `nu_indicator` | `'nu'` | A format string used to represent nu. |\n| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. |\n| `format` | `'[$indicator]($style) '` | The format for the module. |\n| `style` | `'white bold'` | The style for the module. |\n| `disabled` | `true` | Disables the `shell` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-78)\n| Variable | Default | Description |\n|---|---|---|\n| indicator |   | Mirrors the value of `indicator` for currently used shell. |\n| style\\* |   | Mirrors the value of option `style`. |\n\n\\*: This variable can only be used as a part of a style string\n\n### Examples [](https:\/\/starship.rs\/config\/#examples-6)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[shell]\nfish_indicator = '󰈺 '\npowershell_indicator = '_'\nunknown_indicator = 'mystery shell'\nstyle = 'cyan bold'\ndisabled = false\n```\n## SHLVL [](https:\/\/starship.rs\/config\/#shlvl)\nThe `shlvl` module shows the current [`SHLVL`](https:\/\/tldp.org\/LDP\/abs\/html\/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-86)\n| Option | Default | Description |\n|---|---|---|\n| `threshold` | `2` | Display threshold. |\n| `format` | `'[$symbol$shlvl]($style) '` | The format for the module. |\n| `symbol` | `'↕️ '` | The symbol used to represent the `SHLVL`. |\n| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |\n| `repeat_offset` | `0` | Decrements number of times `symbol` is repeated by the offset value |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `true` | Disables the `shlvl` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-79)\n| Variable | Example | Description |\n|---|---|---|\n| shlvl | `3` | The current value of `SHLVL` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-71)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[shlvl]\ndisabled = false\nformat = '$shlvl level(s) down'\nthreshold = 3\n```\n\nUsing `repeat` and `repeat_offset` along with `character` module, one can get prompt like `❯❯❯` where last character is colored appropriately for return status code and preceding characters are provided by `shlvl`.\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[shlvl]\ndisabled = false\nformat = '[$symbol]($style)'\nrepeat = true\nsymbol = '❯'\nrepeat_offset = 1\n```\n## Singularity [](https:\/\/starship.rs\/config\/#singularity)\nThe `singularity` module shows the current [Singularity](https:\/\/sylabs.io\/singularity\/) image, if inside a container and `$SINGULARITY_NAME` is set.\n\n### Options [](https:\/\/starship.rs\/config\/#options-87)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[$symbol\\[$env\\]]($style) '` | The format for the module. |\n| `symbol` | `''` | A format string displayed before the image name. |\n| `style` | `'bold dimmed blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `singularity` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-80)\n| Variable | Example | Description |\n|---|---|---|\n| env | `centos.img` | The current Singularity image |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-72)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[singularity]\nformat = '[📦 \\[$env\\]]($style) '\n```\n## Solidity [](https:\/\/starship.rs\/config\/#solidity)\nThe `solidity` module shows the currently installed version of [Solidity](https:\/\/soliditylang.org\/) The module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with the `.sol` extension\n### Options [](https:\/\/starship.rs\/config\/#options-88)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'S '` | A format string representing the symbol of Solidity |\n| \\`compiler | \\['solc'\\] | The default compiler for Solidity. |\n| `detect_extensions` | `['sol']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables this module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-81)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.8.1` | The version of `solidity` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-73)\ntoml\n```\n# ~\/.config\/starship.toml\n[solidity]\nformat = \"via [S $version](blue bold)\"\n```\n## Spack [](https:\/\/starship.rs\/config\/#spack)\nThe `spack` module shows the current [Spack](https:\/\/spack.readthedocs.io\/en\/latest\/) environment, if `$SPACK_ENV` is set.\n\n### Options [](https:\/\/starship.rs\/config\/#options-89)\n| Option | Default | Description |\n|---|---|---|\n| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](https:\/\/starship.rs\/config\/#directory) module. |\n| `symbol` | `'🅢 '` | The symbol used before the environment name. |\n| `style` | `'bold blue'` | The style for the module. |\n| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |\n| `disabled` | `false` | Disables the `spack` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-82)\n| Variable | Example | Description |\n|---|---|---|\n| environment | `astronauts` | The current spack environment |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-74)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[spack]\nformat = '[$symbol$environment](dimmed blue) '\n```\n## Status [](https:\/\/starship.rs\/config\/#status)\nThe `status` module displays the exit code of the previous command. If \\$success\\_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-90)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[$symbol$status]($style) '` | The format of the module |\n| `symbol` | `'❌'` | The symbol displayed on program error |\n| `success_symbol` | `''` | The symbol displayed on program success |\n| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable |\n| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found |\n| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) |\n| `signal_symbol` | `'⚡'` | The symbol displayed on any signal |\n| `style` | `'bold red'` | The style for the module. |\n| `success_style` |   | The style used on program success (defaults to `style` if unset). |\n| `failure_style` |   | The style used on program failure (defaults to `style` if unset). |\n| `recognize_signal_code` | `true` | Enable signal mapping from exit code |\n| `map_symbol` | `false` | Enable symbols mapping from exit code |\n| `pipestatus` | `false` | Enable pipestatus reporting |\n| `pipestatus_separator` | `|` | The symbol used to separate pipestatus segments (supports formatting) |\n| `pipestatus_format` | `'\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) '` | The format of the module when the command is a pipeline |\n| `pipestatus_segment_format` |   | When specified, replaces `format` when formatting pipestatus segments |\n| `disabled` | `true` | Disables the `status` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-83)\n| Variable | Example | Description |\n|---|---|---|\n| status | `127` | The exit code of the last command |\n| hex\\_status | `0x7F` | The exit code of the last command in hex |\n| int | `127` | The exit code of the last command |\n| common\\_meaning | `ERROR` | Meaning of the code if not a signal |\n| signal\\_number | `9` | Signal number corresponding to the exit code, only if signalled |\n| signal\\_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |\n| maybe\\_int | `7` | Contains the exit code number when no meaning has been found |\n| pipestatus |   | Rendering of in pipeline programs' exit codes, this is only available in pipestatus\\_format |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `success_style` on program success and `failure_style` otherwise |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-75)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[status]\nstyle = 'bg:blue'\nsymbol = '🔴 '\nsuccess_symbol = '🟢 SUCCESS'\nformat = '[\\[$symbol$common_meaning$signal_name$maybe_int\\]]($style) '\nmap_symbol = true\ndisabled = false\n```\n## Sudo [](https:\/\/starship.rs\/config\/#sudo)\nThe `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-91)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[as $symbol]($style)'` | The format of the module |\n| `symbol` | `'🧙 '` | The symbol displayed when credentials are cached |\n| `style` | `'bold blue'` | The style for the module. |\n| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |\n| `disabled` | `true` | Disables the `sudo` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-84)\n| Variable | Example | Description |\n|---|---|---|\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-76)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[sudo]\nstyle = 'bold green'\nsymbol = '👩‍💻 '\ndisabled = false\n```\n\ntoml\n```\n# On windows\n# $HOME\\.starship\\config.toml\n\n[sudo]\nallow_windows = true\ndisabled = false\n```\n## Swift [](https:\/\/starship.rs\/config\/#swift)\nBy default the `swift` module shows the currently installed version of [Swift](https:\/\/swift.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Package.swift` file\n- The current directory contains a file with the `.swift` extension\n### Options [](https:\/\/starship.rs\/config\/#options-92)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐦 '` | A format string representing the symbol of Swift |\n| `detect_extensions` | `['swift']` | Which extensions should trigger this module. |\n| `detect_files` | `['Package.swift']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold 202'` | The style for the module. |\n| `disabled` | `false` | Disables the `swift` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-85)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v5.2.4` | The version of `swift` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-77)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[swift]\nformat = 'via [🏎  $version](red bold)'\n```\n## Terraform [](https:\/\/starship.rs\/config\/#terraform)\nThe `terraform` module shows the currently selected [Terraform workspace](https:\/\/www.terraform.io\/docs\/language\/state\/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection.\n\nTIP\n\nBy default the Terraform\/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](https:\/\/starship.rs\/config\/#with-terraform-version).\n\nBy default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `.terraform` folder\n- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions\n### Options [](https:\/\/starship.rs\/config\/#options-93)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'💠'` | A format string shown before the terraform workspace. |\n| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |\n| `style` | `'bold 105'` | The style for the module. |\n| `disabled` | `false` | Disables the `terraform` module. |\n| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-86)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.12.24` | The version of `terraform` |\n| workspace | `default` | The current Terraform workspace |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-78)\n#### With Terraform Version [](https:\/\/starship.rs\/config\/#with-terraform-version)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[terraform]\nformat = 'via [$symbol$version $workspace]($style) '\n```\n#### Without Terraform version [](https:\/\/starship.rs\/config\/#without-terraform-version)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[terraform]\nformat = 'via [$symbol$workspace]($style) '\n```\n## Time [](https:\/\/starship.rs\/config\/#time)\nThe `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https:\/\/crates.io\/crates\/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https:\/\/docs.rs\/chrono\/0.4.7\/chrono\/format\/strftime\/index.html) to see what options are available.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-94)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'at [$time]($style) '` | The format string for the module. |\n| `use_12hr` | `false` | Enables 12 hour formatting |\n| `time_format` | see below | The [chrono format string](https:\/\/docs.rs\/chrono\/0.4.7\/chrono\/format\/strftime\/index.html) used to format the time. |\n| `style` | `'bold yellow'` | The style for the module time |\n| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 \\< x \\< 24. Allows floats to accommodate 30\/45 minute timezone offsets. |\n| `disabled` | `true` | Disables the `time` module. |\n| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |\n\nIf `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting.\n\n### Variables [](https:\/\/starship.rs\/config\/#variables-87)\n| Variable | Example | Description |\n|---|---|---|\n| time | `13:08:10` | The current time. |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-79)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[time]\ndisabled = false\nformat = '🕙[\\[ $time \\]]($style) '\ntime_format = '%T'\nutc_time_offset = '-5'\ntime_range = '10:00:00-14:00:00'\n```\n## Typst [](https:\/\/starship.rs\/config\/#typst)\nThe `typst` module shows the current installed version of Typst used in a project.\n\nBy default, the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `template.typ` file\n- The current directory contains any `*.typ` file\n### Options [](https:\/\/starship.rs\/config\/#options-95)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'t '` | A format string representing the symbol of Typst |\n| `style` | `'bold #0093A7'` | The style for the module. |\n| `detect_extensions` | `['.typ']` | Which extensions should trigger this module. |\n| `detect_files` | `['template.typ']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `typst` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-88)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.9.0` | The version of `typst`, alias for typst\\_version |\n| typst\\_version | `default` | The current Typst version |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Username [](https:\/\/starship.rs\/config\/#username)\nThe `username` module shows active user's username. The module will be shown if any of the following conditions are met:\n\n- The current user is root\/admin\n- The current user isn't the same as the one that is logged in\n- The user is currently connected as an SSH session\n- The variable `show_always` is set to true\n- The array `detect_env_vars` contains at least the name of one environment variable, that is set\n\nTIP\n\nSSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.\n### Options [](https:\/\/starship.rs\/config\/#options-96)\n| Option | Default | Description |\n|---|---|---|\n| `style_root` | `'bold red'` | The style used when the user is root\/admin. |\n| `style_user` | `'bold yellow'` | The style used for non-root users. |\n| `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. |\n| `format` | `'[$user]($style) in '` | The format for the module. |\n| `show_always` | `false` | Always shows the `username` module. |\n| `disabled` | `false` | Disables the `username` module. |\n| `aliases` | `{}` | Translate system usernames to something else. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-89)\n| Variable | Example | Description |\n|---|---|---|\n| `style` | `'red bold'` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |\n| `user` | `'matchai'` | The currently logged-in user ID. |\n### Example [](https:\/\/starship.rs\/config\/#example-80)\n#### Always show the username [](https:\/\/starship.rs\/config\/#always-show-the-username)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[username]\nstyle_user = 'white bold'\nstyle_root = 'black bold'\nformat = 'user: [$user]($style) '\ndisabled = false\nshow_always = true\naliases = { \"corpuser034g\" = \"matchai\" }\n```\n## Vagrant [](https:\/\/starship.rs\/config\/#vagrant)\nThe `vagrant` module shows the currently installed version of [Vagrant](https:\/\/www.vagrantup.com\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Vagrantfile` file\n### Options [](https:\/\/starship.rs\/config\/#options-97)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'⍱ '` | A format string representing the symbol of Vagrant. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['Vagrantfile']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'cyan bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `vagrant` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-90)\n| Variable | Example | Description |\n|---|---|---|\n| version | `Vagrant 2.2.10` | The version of `Vagrant` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-81)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[vagrant]\nformat = 'via [⍱ $version](bold white) '\n```\n## V [](https:\/\/starship.rs\/config\/#v)\nThe `vlang` module shows you your currently installed version of [V](https:\/\/vlang.io\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with `.v` extension\n- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file\n### Options [](https:\/\/starship.rs\/config\/#options-98)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'V '` | A format string representing the symbol of V |\n| `detect_extensions` | `['v']` | Which extensions should trigger this module. |\n| `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'blue bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `vlang` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-91)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.2` | The version of `v` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-82)\ntoml\n```\n# ~\/.config\/starship.toml\n[vlang]\nformat = 'via [V $version](blue bold) '\n```\n## VCSH [](https:\/\/starship.rs\/config\/#vcsh)\nThe `vcsh` module displays the current active [VCSH](https:\/\/github.com\/RichiH\/vcsh) repository. The module will be shown only if a repository is currently in use.\n\n### Options [](https:\/\/starship.rs\/config\/#options-99)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `''` | The symbol used before displaying the repository name. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `format` | `'vcsh [$symbol$repo]($style) '` | The format for the module. |\n| `disabled` | `false` | Disables the `vcsh` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-92)\n| Variable | Example | Description |\n|---|---|---|\n| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* | `black bold dimmed` | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-83)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[vcsh]\nformat = '[🆅 $repo](bold blue) '\n```\n## XMake [](https:\/\/starship.rs\/config\/#xmake)\nThe `xmake` module shows the currently installed version of [XMake](https:\/\/xmake.io\/). By default the module will be activated if any of the following conditions are met:\n\n- The current directory contains a `xmake.lua` file\n### Options [](https:\/\/starship.rs\/config\/#options-100)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'△ '` | The symbol used before the version of cmake. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module |\n| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module |\n| `detect_folders` | `[]` | Which folders should trigger this module |\n| `style` | `'bold green'` | The style for the module. |\n| `disabled` | `false` | Disables the `xmake` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-93)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v2.9.5` | The version of xmake |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Zig [](https:\/\/starship.rs\/config\/#zig)\nBy default the `zig` module shows the currently installed version of [Zig](https:\/\/ziglang.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a `.zig` file\n### Options [](https:\/\/starship.rs\/config\/#options-101)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'↯ '` | The symbol used before displaying the version of Zig. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `false` | Disables the `zig` module. |\n| `detect_extensions` | `['zig']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-94)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.6.0` | The version of `zig` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-84)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[zig]\nsymbol = '⚡️ '\n```\n## Custom commands [](https:\/\/starship.rs\/config\/#custom-commands)\nThe `custom` modules show the output of some arbitrary commands.\n\nThese modules will be shown if any of the following conditions are met:\n\n- The current directory contains a file whose name is in `detect_files`\n- The current directory contains a directory whose name is in `detect_folders`\n- The current directory contains a file whose extension is in `detect_extensions`\n- The `when` command returns 0\n- The current Operating System (std::env::consts::OS) matches with `os` field if defined.\n\nTIP\n\nMultiple custom modules can be defined by using a `.`.\n\nTIP\n\nThe order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined.\n\nTIP\n\n[Issue \\#1252](https:\/\/github.com\/starship\/starship\/discussions\/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there\\!\n\nWARNING\n\nIf `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.\n\nWhatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\\h`, but this module will not work in a fish or zsh shell.\n\nFormat strings can also contain shell specific prompt sequences, e.g. [Bash](https:\/\/www.gnu.org\/software\/bash\/manual\/html_node\/Controlling-the-Prompt.html), [Zsh](https:\/\/zsh.sourceforge.io\/Doc\/Release\/Prompt-Expansion.html).\n### Options [](https:\/\/starship.rs\/config\/#options-102)\n| Option | Default | Description |\n|---|---|---|\n| `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. |\n| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the `shell` returns a `0` status code from executing it. |\n| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |\n| `shell` |   | [See below](https:\/\/starship.rs\/config\/#custom-command-shell) |\n| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |\n| `unsafe_no_escape` | `false` | When set, command output is not escaped of characters that could be interpreted by the shell. |\n| `detect_files` | `[]` | The files that will be searched in the working directory for a match. |\n| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |\n| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |\n| `symbol` | `''` | The symbol used before displaying the command output. |\n| `style` | `'bold green'` | The style for the module. |\n| `format` | `'[$symbol($output )]($style)'` | The format for the module. |\n| `disabled` | `false` | Disables this `custom` module. |\n| `os` |   | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https:\/\/doc.rust-lang.org\/std\/env\/consts\/constant.OS.html). |\n| `use_stdin` |   | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. |\n| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-95)\n| Variable | Description |\n|---|---|\n| output | The output of `command` run in `shell` |\n| symbol | Mirrors the value of option `symbol` |\n| style\\* | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n#### Custom command shell [](https:\/\/starship.rs\/config\/#custom-command-shell)\n`shell` accepts a non-empty list of strings, where:\n\n- The first string is the path to the shell to use to execute the command.\n- Other following arguments are passed to the shell.\n\nIf unset, it will fallback to STARSHIP\\_SHELL and then to 'sh' on Linux, and 'cmd \/C' on Windows.\n\nThe `command` (and `when`, if applicable) will be passed in on stdin.\n\nIf `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `\/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g.\n\ntoml\n```\nshell = ['pwsh', '-Command', '-']\n```\n\nWARNING\n\nMake sure your custom shell configuration exits gracefully\n\nIf you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).\n\nFor example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.\n\nParameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.\n\nAutomatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https:\/\/github.com\/starship\/starship\/issues\/new\/choose) with shell details and starship configuration if you hit such scenario.\n### Example [](https:\/\/starship.rs\/config\/#example-85)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[custom.foo]\ncommand = 'echo foo' # shows output of command\ndetect_files = ['foo'] # can specify filters but wildcards are not supported\nwhen = ''' test \"$HOME\" = \"$PWD\" '''\nformat = ' transcending [$output]($style)'\n\n[custom.time]\ncommand = 'time \/T'\ndetect_extensions = ['pst'] # filters *.pst files\nshell = ['pwsh.exe', '-NoProfile', '-Command', '-']\n\n[custom.time-as-arg]\ncommand = 'time \/T'\ndetect_extensions = ['pst'] # filters *.pst files\nshell = ['pwsh.exe', '-NoProfile', '-Command']\nuse_stdin = false\n```\n\n[Edit this page on GitHub](https:\/\/github.com\/starship\/starship\/edit\/master\/docs\/config\/README.md)\n\nPager\n\n[Previous pageInstallation](https:\/\/starship.rs\/installing\/)\n\n[Next pageAdvanced Configuration](https:\/\/starship.rs\/advanced-config\/)","attrs_readable_markdown":"## Configuration [](https:\/\/starship.rs\/config\/#configuration)\nTo get started configuring starship, create the following file: `~\/.config\/starship.toml`.\n\nsh\n```\nmkdir -p ~\/.config && touch ~\/.config\/starship.toml\n```\n\nAll configuration for starship is done in this [TOML](https:\/\/github.com\/toml-lang\/toml) file:\n\ntoml\n```\n# Get editor completions based on the config schema\n\"$schema\" = 'https:\/\/starship.rs\/config-schema.json'\n\n# Inserts a blank line between shell prompts\nadd_newline = true\n\n# Replace the '❯' symbol in the prompt with '➜'\n[character] # The name of the module we are configuring is 'character'\nsuccess_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'\n\n# Disable the package module, hiding it from the prompt completely\n[package]\ndisabled = true\n```\n### Config File Location [](https:\/\/starship.rs\/config\/#config-file-location)\nYou can change default configuration file location with `STARSHIP_CONFIG` environment variable:\n\nsh\n```\nexport STARSHIP_CONFIG=~\/example\/non\/default\/path\/starship.toml\n```\n\nEquivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:\n\npowershell\n```\n$ENV:STARSHIP_CONFIG = \"$HOME\\example\\non\\default\\path\\starship.toml\"\n```\n\nOr for Cmd (Windows) would be adding this line to your `starship.lua`:\n\nlua\n```\nos.setenv('STARSHIP_CONFIG', 'C:\\\\Users\\\\user\\\\example\\\\non\\\\default\\\\path\\\\starship.toml')\n```\n### Logging [](https:\/\/starship.rs\/config\/#logging)\nBy default starship logs warnings and errors into a file named `~\/.cache\/starship\/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to an instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable:\n\nsh\n```\nexport STARSHIP_CACHE=~\/.starship\/cache\n```\n\nEquivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:\n\npowershell\n```\n$ENV:STARSHIP_CACHE = \"$HOME\\AppData\\Local\\Temp\"\n```\n\nOr for Cmd (Windows) would be adding this line to your `starship.lua`:\n\nlua\n```\nos.setenv('STARSHIP_CACHE', 'C:\\\\Users\\\\user\\\\AppData\\\\Local\\\\Temp')\n```\n### Terminology [](https:\/\/starship.rs\/config\/#terminology)\n**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the \"nodejs\" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project.\n\n**Variable**: Smaller sub-components that contain information provided by the module. For example, the \"version\" variable in the \"nodejs\" module contains the current version of Node.js.\n\nBy convention, most modules have a prefix of default terminal color (e.g. `via` in \"nodejs\") and an empty space as a suffix.\n\n### Strings [](https:\/\/starship.rs\/config\/#strings)\nIn TOML syntax, [text values](https:\/\/toml.io\/en\/v1.0.0#string) are declared with `'`, `\"`, `'''`, or `\"\"\"`.\n\nThe following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`.\n\n| Symbol | Type | Notes |\n|---|---|---|\n| `'` | literal string | less escaping |\n| `\"` | string | more escaping |\n| `'''` | multi-line literal string | less escaping |\n| `\"\"\"` | multi-line string | more escaping, newlines in declarations can be ignored |\n\nFor example:\n\ntoml\n```\n# literal string\nformat = '☺\\☻ '\n\n# regular string\nformat = \"☺\\\\☻ \"\n\n# escaping Starship symbols\nformat = '\\[\\$\\] '\n```\n\nWhen using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent:\n\ntoml\n```\n# with literal string\nformat = '''\n\n\\$'''\n\n# with multiline basic string\nformat = \"\"\"\n\n\\\\$\"\"\"\n\n# with basic string\nformat = \"\\n\\\\$\"\n```\n\nIn multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.\n\ntoml\n```\nformat = \"\"\"\nline1\\\nline1\\\nline1\nline2\\\nline2\\\nline2\n\"\"\"\n```\n### Format Strings [](https:\/\/starship.rs\/config\/#format-strings)\nFormat strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string.\n\n#### Variable [](https:\/\/starship.rs\/config\/#variable)\nA variable contains a `$` symbol followed by the name of the variable. The name of a variable can only contain letters, numbers and `_`.\n\nFor example:\n\n- `'$version'` is a format string with a variable named `version`.\n- `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`.\n- `'$git_branch $git_commit'` has the two variables separated with a space.\n#### Text Group [](https:\/\/starship.rs\/config\/#text-group)\nA text group is made up of two different parts.\n\nThe first part, which is enclosed in a `[]`, is a [format string](https:\/\/starship.rs\/config\/#format-strings). You can add texts, variables, or even nested text groups in it.\n\nIn the second part, which is enclosed in a `()`, is a [style string](https:\/\/starship.rs\/config\/#style-strings). This can be used to style the first part.\n\nFor example:\n\n- `'[on](red bold)'` will print a string `on` with bold text colored red.\n- `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.\n- `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green.\n#### Style Strings [](https:\/\/starship.rs\/config\/#style-strings)\nMost modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](https:\/\/starship.rs\/advanced-config\/).\n\n- `'fg:green bg:blue'` sets green text on a blue background\n- `'bg:blue fg:bright-green'` sets bright green text on a blue background\n- `'bold fg:27'` sets bold text with [ANSI color](https:\/\/i.stack.imgur.com\/KTSQa.png) 27\n- `'underline bg:#bf5700'` sets underlined text on a burnt orange background\n- `'bold italic fg:purple'` sets bold italic purple text\n- `''` explicitly disables all styling\n\nNote that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.\n\n#### Conditional Format Strings [](https:\/\/starship.rs\/config\/#conditional-format-strings)\nA conditional format string wrapped in `(` and `)` will not render if all variables inside are empty.\n\nFor example:\n\n- `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region.\n- `'(some text)'` will always show nothing since there are no variables wrapped in the braces.\n- When `$combined` is a shortcut for `\\[$a$b\\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\\[$a$b\\] )'`.\n### Negative matching [](https:\/\/starship.rs\/config\/#negative-matching)\nMany modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. \"Negative\" options, those which should not be matched, are indicated with a leading '!' character. The presence of *any* negative indicator in the directory will result in the module not being matched.\n\nExtensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all.\n\nTo see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:\n\ntoml\n```\ndetect_extensions = ['ts', '!video.ts', '!audio.ts']\n```\n\nThis is the list of prompt-wide configuration options.\n\n### Options [](https:\/\/starship.rs\/config\/#options)\n| Option | Default | Description |\n|---|---|---|\n| `format` | [link](https:\/\/starship.rs\/config\/#default-prompt-format) | Configure the format of the prompt. |\n| `right_format` | `''` | See [Enable Right Prompt](https:\/\/starship.rs\/advanced-config\/#enable-right-prompt) |\n| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |\n| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |\n| `add_newline` | `true` | Inserts blank line between shell prompts. |\n| `palette` | `''` | Sets which color palette from `palettes` to use. |\n| `palettes` | `{}` | Collection of color palettes that assign [colors](https:\/\/starship.rs\/advanced-config\/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |\n| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |\n\nTIP\n\nIf you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`.\n### Example [](https:\/\/starship.rs\/config\/#example)\ntoml\n```\n# ~\/.config\/starship.toml\n\n# Use custom format\nformat = '''\n[┌───────────────────>](bold green)\n[│](bold green)$directory$rust$package\n[└─>](bold green) '''\n\n# Wait 10 milliseconds for starship to check files under the current directory.\nscan_timeout = 10\n\n# Disable the blank line at the start of the prompt\nadd_newline = false\n\n# Set 'foo' as custom color palette\npalette = 'foo'\n\n# Define custom colors\n[palettes.foo]\n# Overwrite existing color\nblue = '21'\n# Define new color\nmustard = '#af8700'\n```\n### Default Prompt Format [](https:\/\/starship.rs\/config\/#default-prompt-format)\nThe default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:\n\ntoml\n```\nformat = '$all'\n\n# Which is equivalent to\nformat = \"\"\"\n$username\\\n$hostname\\\n$localip\\\n$shlvl\\\n$singularity\\\n$kubernetes\\\n$directory\\\n$vcsh\\\n$fossil_branch\\\n$fossil_metrics\\\n$git_branch\\\n$git_commit\\\n$git_state\\\n$git_metrics\\\n$git_status\\\n$hg_branch\\\n$hg_state\\\n$pijul_channel\\\n$docker_context\\\n$package\\\n$c\\\n$cmake\\\n$cobol\\\n$daml\\\n$dart\\\n$deno\\\n$dotnet\\\n$elixir\\\n$elm\\\n$erlang\\\n$fennel\\\n$fortran\\\n$gleam\\\n$golang\\\n$guix_shell\\\n$haskell\\\n$haxe\\\n$helm\\\n$java\\\n$julia\\\n$kotlin\\\n$gradle\\\n$lua\\\n$nim\\\n$nodejs\\\n$ocaml\\\n$opa\\\n$perl\\\n$php\\\n$pulumi\\\n$purescript\\\n$python\\\n$quarto\\\n$raku\\\n$rlang\\\n$red\\\n$ruby\\\n$rust\\\n$scala\\\n$solidity\\\n$swift\\\n$terraform\\\n$typst\\\n$vlang\\\n$vagrant\\\n$zig\\\n$buf\\\n$nix_shell\\\n$conda\\\n$meson\\\n$spack\\\n$memory_usage\\\n$aws\\\n$gcloud\\\n$openstack\\\n$azure\\\n$nats\\\n$direnv\\\n$env_var\\\n$mise\\\n$crystal\\\n$custom\\\n$sudo\\\n$cmd_duration\\\n$line_break\\\n$jobs\\\n$battery\\\n$time\\\n$status\\\n$os\\\n$container\\\n$netns\\\n$shell\\\n$character\"\"\"\n```\n\nIf you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. Eg.\n\ntoml\n```\n# Move the directory to the second line\nformat = '$all$directory$character'\n```\n## AWS [](https:\/\/starship.rs\/config\/#aws)\nThe `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~\/.aws\/config` and `~\/.aws\/credentials` files as required.\n\nThe module will display a profile only if its credentials are present in `~\/.aws\/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~\/.aws\/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected.\n\nWhen using [aws-vault](https:\/\/github.com\/99designs\/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var.\n\nWhen using [awsu](https:\/\/github.com\/kreuzwerker\/awsu) the profile is read from the `AWSU_PROFILE` env var.\n\nWhen using [AWSume](https:\/\/awsu.me\/) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var.\n\nWhen using [saml2aws](https:\/\/github.com\/Versent\/saml2aws) the expiration information obtained from `~\/.aws\/credentials` falls back to the `x_security_token_expires` key.\n\nWhen using [aws-sso-cli](https:\/\/github.com\/synfinatic\/aws-sso-cli) the profile is read from the `AWS_SSO_PROFILE` env var.\n\n### Options [](https:\/\/starship.rs\/config\/#options-1)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'on [$symbol($profile )(\$$region\$ )(\\[$duration\\] )]($style)'` | The format for the module. |\n| `symbol` | `'☁️ '` | The symbol used before displaying the current AWS profile. |\n| `region_aliases` | `{}` | Table of region aliases to display in addition to the AWS name. |\n| `profile_aliases` | `{}` | Table of profile aliases to display in addition to the AWS name. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `expiration_symbol` | `'X'` | The symbol displayed when the temporary credentials have expired. |\n| `disabled` | `false` | Disables the `AWS` module. |\n| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |\n### Variables [](https:\/\/starship.rs\/config\/#variables)\n| Variable | Example | Description |\n|---|---|---|\n| region | `ap-northeast-1` | The current AWS region |\n| profile | `astronauts` | The current AWS profile |\n| duration | `2h27m20s` | The temporary credentials validity duration |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Examples [](https:\/\/starship.rs\/config\/#examples)\n#### Display everything [](https:\/\/starship.rs\/config\/#display-everything)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[aws]\nformat = 'on [$symbol($profile )(\$$region\$ )]($style)'\nstyle = 'bold blue'\nsymbol = '🅰 '\n[aws.region_aliases]\nap-southeast-2 = 'au'\nus-east-1 = 'va'\n[aws.profile_aliases]\nCompanyGroupFrobozzOnCallAccess = 'Frobozz'\n```\n#### Display region [](https:\/\/starship.rs\/config\/#display-region)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[aws]\nformat = 'on [$symbol$region]($style) '\nstyle = 'bold blue'\nsymbol = '🅰 '\n[aws.region_aliases]\nap-southeast-2 = 'au'\nus-east-1 = 'va'\n```\n#### Display profile [](https:\/\/starship.rs\/config\/#display-profile)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[aws]\nformat = 'on [$symbol$profile]($style) '\nstyle = 'bold blue'\nsymbol = '🅰 '\n[aws.profile_aliases]\nEnterprise_Naming_Scheme-voidstars = 'void**'\n```\n## Azure [](https:\/\/starship.rs\/config\/#azure)\nThe `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~\/.azure\/azureProfile.json` file.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-2)\n| Variable | Default | Description |\n|---|---|---|\n| `format` | `'on [$symbol($subscription)]($style) '` | The format for the Azure module to render. |\n| `symbol` | `'󰠅 '` | The symbol used in the format. |\n| `style` | `'blue bold'` | The style used in the format. |\n| `disabled` | `true` | Disables the `azure` module. |\n| `subscription_aliases` | `{}` | Table of subscription name aliases to display in addition to Azure subscription name. |\n### Examples [](https:\/\/starship.rs\/config\/#examples-1)\n#### Display Subscription Name [](https:\/\/starship.rs\/config\/#display-subscription-name)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[azure]\ndisabled = false\nformat = 'on [$symbol($subscription)]($style) '\nsymbol = '󰠅 '\nstyle = 'blue bold'\n```\n#### Display Username [](https:\/\/starship.rs\/config\/#display-username)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[azure]\ndisabled = false\nformat = \"on [$symbol($username)]($style) \"\nsymbol = \"󰠅 \"\nstyle = \"blue bold\"\n```\n#### Display Subscription Name Alias [](https:\/\/starship.rs\/config\/#display-subscription-name-alias)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[azure.subscription_aliases]\nvery-long-subscription-name = 'vlsn'\n```\n## Battery [](https:\/\/starship.rs\/config\/#battery)\nThe `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.\n\n### Options [](https:\/\/starship.rs\/config\/#options-3)\n| Option | Default | Description |\n|---|---|---|\n| `full_symbol` | `'󰁹 '` | The symbol shown when the battery is full. |\n| `charging_symbol` | `'󰂄 '` | The symbol shown when the battery is charging. |\n| `discharging_symbol` | `'󰂃 '` | The symbol shown when the battery is discharging. |\n| `unknown_symbol` | `'󰁽 '` | The symbol shown when the battery state is unknown. |\n| `empty_symbol` | `'󰂎 '` | The symbol shown when the battery state is empty. |\n| `format` | `'[$symbol$percentage]($style) '` | The format for the module. |\n| `display` | [link](https:\/\/starship.rs\/config\/#battery-display) | Display threshold and style for the module. |\n| `disabled` | `false` | Disables the `battery` module. |\n### Example [](https:\/\/starship.rs\/config\/#example-1)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[battery]\nfull_symbol = '🔋 '\ncharging_symbol = '⚡️ '\ndischarging_symbol = '💀 '\n```\n### Battery Display [](https:\/\/starship.rs\/config\/#battery-display)\nThe `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. The default is as shown:\n\ntoml\n```\n[[battery.display]]\nthreshold = 10\nstyle = 'bold red'\n```\n\nThe default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option.\n\n#### Options [](https:\/\/starship.rs\/config\/#options-4)\nThe `display` option is an array of the following table.\n\n| Option | Default | Description |\n|---|---|---|\n| `threshold` | `10` | The upper bound for the display option. |\n| `style` | `'red bold'` | The style used if the display option is in use. |\n| `charging_symbol` |   | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |\n| `discharging_symbol` |   | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |\n#### Example [](https:\/\/starship.rs\/config\/#example-2)\ntoml\n```\n[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%\nthreshold = 10\nstyle = 'bold red'\n\n[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%\nthreshold = 30\nstyle = 'bold yellow'\ndischarging_symbol = '💦 '\n\n# when capacity is over 30%, the battery indicator will not be displayed\n```\n## Buf [](https:\/\/starship.rs\/config\/#buf)\nThe `buf` module shows the currently installed version of [Buf](https:\/\/buf.build\/). By default, the module is shown if the current directory contains a [`buf.yaml`](https:\/\/docs.buf.build\/configuration\/v1\/buf-yaml), [`buf.gen.yaml`](https:\/\/docs.buf.build\/configuration\/v1\/buf-gen-yaml), or [`buf.work.yaml`](https:\/\/docs.buf.build\/configuration\/v1\/buf-work-yaml) configuration file.\n\n### Options [](https:\/\/starship.rs\/config\/#options-5)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'with [$symbol($version )]($style)'` | The format for the `buf` module. |\n| `version_format` | `'v${raw}'` | The version format. |\n| `symbol` | `'🐃 '` | The symbol used before displaying the version of Buf. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `elixir` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-1)\n| Variable | Example | Description |\n|---|---|---|\n| `version` | `v1.0.0` | The version of `buf` |\n| `symbol` |   | Mirrors the value of option `symbol` |\n| `style`\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-3)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[buf]\nsymbol = '🦬 '\n```\n## Bun [](https:\/\/starship.rs\/config\/#bun)\nThe `bun` module shows the currently installed version of the [bun](https:\/\/bun.sh\/) JavaScript runtime. By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `bun.lock` file\n- The current directory contains a `bun.lockb` file\n- The current directory contains a `bunfig.toml` file\n### Options [](https:\/\/starship.rs\/config\/#options-6)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🥟 '` | A format string representing the symbol of Bun. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['bun.lock', 'bun.lockb', 'bunfig.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold red'` | The style for the module. |\n| `disabled` | `false` | Disables the `bun` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-2)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.1.4` | The version of `bun` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-4)\n#### Customize the format [](https:\/\/starship.rs\/config\/#customize-the-format)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[bun]\nformat = 'via [🍔 $version](bold green) '\n```\n## C [](https:\/\/starship.rs\/config\/#c)\nThe `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file.\n\n### Options [](https:\/\/starship.rs\/config\/#options-7)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'C '` | The symbol used before displaying the compiler details |\n| `detect_extensions` | `['c', 'h']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `commands` | `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` | How to detect what the compiler is |\n| `style` | `'bold 149'` | The style for the module. |\n| `disabled` | `false` | Disables the `c` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-3)\n| Variable | Example | Description |\n|---|---|---|\n| name | clang | The name of the compiler |\n| version | 13\\.0.0 | The version of the compiler |\n| symbol |   | Mirrors the value of option `symbol` |\n| style |   | Mirrors the value of option `style` |\n### Commands [](https:\/\/starship.rs\/config\/#commands)\nThe `commands` option accepts a list of commands to determine the compiler version and name.\n\nEach command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT.\n\nIf a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https:\/\/github.com\/starship\/starship\/issues\/new\/choose).\n\n### Example [](https:\/\/starship.rs\/config\/#example-5)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[c]\nformat = 'via [$name $version]($style)'\n```\n## CPP [](https:\/\/starship.rs\/config\/#cpp)\nThe `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`\\-related files.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-8)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version(-$name) )]($style)'` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'C++ '` | The symbol used before displaying the compiler details |\n| `detect_extensions` | `['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `commands` | `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` | How to detect what the compiler is |\n| `style` | `'bold 149'` | The style for the module. |\n| `disabled` | `true` | Disables the `cpp` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-4)\n| Variable | Example | Description |\n|---|---|---|\n| name | clang++ | The name of the compiler |\n| version | 13\\.0.0 | The version of the compiler |\n| symbol |   | Mirrors the value of option `symbol` |\n| style |   | Mirrors the value of option `style` |\n### Commands [](https:\/\/starship.rs\/config\/#commands-1)\nThe `commands` option accepts a list of commands to determine the compiler version and name.\n\nEach command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT.\n\nIf a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https:\/\/github.com\/starship\/starship\/issues\/new\/choose).\n\n### Example [](https:\/\/starship.rs\/config\/#example-6)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[cpp]\ndisabled = false\nformat = 'via [$name $version]($style)'\n```\n## Character [](https:\/\/starship.rs\/config\/#character)\nThe `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.\n\nThe character will tell you whether the last command was successful or not. It can do this in two ways:\n\n- changing color (`red`\/`green`)\n- changing shape (`❯`\/`✖`)\n\nBy default it only changes color. If you also want to change its shape take a look at [this example](https:\/\/starship.rs\/config\/#with-custom-error-shape).\n\nWARNING\n\n`vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https:\/\/github.com\/starship\/starship\/issues\/625#issuecomment-732454148).\n### Options [](https:\/\/starship.rs\/config\/#options-9)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'$symbol '` | The format string used before the text input. |\n| `success_symbol` | `'[❯](bold green)'` | The format string used before the text input if the previous command succeeded. |\n| `error_symbol` | `'[❯](bold red)'` | The format string used before the text input if the previous command failed. |\n| `vimcmd_symbol` | `'[❮](bold green)'` | The format string used before the text input if the shell is in vim normal mode. |\n| `vimcmd_replace_one_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim `replace_one` mode. |\n| `vimcmd_replace_symbol` | `'[❮](bold purple)'` | The format string used before the text input if the shell is in vim replace mode. |\n| `vimcmd_visual_symbol` | `'[❮](bold yellow)'` | The format string used before the text input if the shell is in vim visual mode. |\n| `disabled` | `false` | Disables the `character` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-5)\n| Variable | Example | Description |\n|---|---|---|\n| symbol |   | A mirror of either `success_symbol`, `error_symbol`, `vimcmd_symbol` or `vimcmd_replace_one_symbol` etc. |\n### Examples [](https:\/\/starship.rs\/config\/#examples-2)\n#### With custom error shape [](https:\/\/starship.rs\/config\/#with-custom-error-shape)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[character]\nsuccess_symbol = '[➜](bold green) '\nerror_symbol = '[✗](bold red) '\n```\n#### Without custom error shape [](https:\/\/starship.rs\/config\/#without-custom-error-shape)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[character]\nsuccess_symbol = '[➜](bold green) '\nerror_symbol = '[➜](bold red) '\n```\n#### With custom vim shape [](https:\/\/starship.rs\/config\/#with-custom-vim-shape)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[character]\nvimcmd_symbol = '[V](bold green) '\n```\n## CMake [](https:\/\/starship.rs\/config\/#cmake)\nThe `cmake` module shows the currently installed version of [CMake](https:\/\/cmake.org\/). By default the module will be activated if any of the following conditions are met:\n\n- The current directory contains a `CMakeLists.txt` file\n- The current directory contains a `CMakeCache.txt` file\n### Options [](https:\/\/starship.rs\/config\/#options-10)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'△ '` | The symbol used before the version of cmake. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module |\n| `detect_files` | `['CMakeLists.txt', 'CMakeCache.txt']` | Which filenames should trigger this module |\n| `detect_folders` | `[]` | Which folders should trigger this module |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `cmake` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-6)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v3.17.3` | The version of cmake |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## COBOL \/ GNUCOBOL [](https:\/\/starship.rs\/config\/#cobol-gnucobol)\nThe `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:\n\n- The current directory contains any files ending in `.cob` or `.COB`\n- The current directory contains any files ending in `.cbl` or `.CBL`\n### Options [](https:\/\/starship.rs\/config\/#options-11)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'⚙️ '` | The symbol used before displaying the version of COBOL. |\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `style` | `'bold blue'` | The style for the module. |\n| `detect_extensions` | `['cbl', 'cob', 'CBL', 'COB']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `cobol` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-7)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v3.1.2.0` | The version of `cobol` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Command Duration [](https:\/\/starship.rs\/config\/#command-duration)\nThe `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.\n\nWARNING\n\nDo not hook the DEBUG trap in Bash\n\nIf you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.\n\nBash users who need preexec-like functionality can use [rcaloras's bash\\_preexec framework](https:\/\/github.com\/rcaloras\/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal.\n\n### Options [](https:\/\/starship.rs\/config\/#options-12)\n| Option | Default | Description |\n|---|---|---|\n| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |\n| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |\n| `format` | `'took [$duration]($style) '` | The format for the module. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `false` | Disables the `cmd_duration` module. |\n| `show_notifications` | `false` | Show desktop notifications when command completes. |\n| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |\n| `notification_timeout` |   | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-8)\n| Variable | Example | Description |\n|---|---|---|\n| duration | `16m40s` | The time it took to execute the command |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-7)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[cmd_duration]\nmin_time = 500\nformat = 'underwent [$duration](bold yellow)'\n```\n## Conda [](https:\/\/starship.rs\/config\/#conda)\nThe `conda` module shows the current [Conda](https:\/\/docs.conda.io\/en\/latest\/) environment, if `$CONDA_DEFAULT_ENV` is set.\n\nTIP\n\nThis does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https:\/\/pixi.sh\/), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`.\n### Options [](https:\/\/starship.rs\/config\/#options-13)\n| Option | Default | Description |\n|---|---|---|\n| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](https:\/\/starship.rs\/config\/#directory) module. |\n| `symbol` | `'🅒 '` | The symbol used before the environment name. |\n| `style` | `'bold green'` | The style for the module. |\n| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |\n| `ignore_base` | `true` | Ignores `base` environment when activated. |\n| `detect_env_vars` | `[\"!PIXI_ENVIRONMENT_NAME\"]` | Which environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default. |\n| `disabled` | `false` | Disables the `conda` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-9)\n| Variable | Example | Description |\n|---|---|---|\n| environment | `astronauts` | The current conda environment |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-8)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[conda]\nformat = '[$symbol$environment](dimmed green) '\n```\n## Container [](https:\/\/starship.rs\/config\/#container)\nThe `container` module displays a symbol and container name, if inside a container.\n\n### Options [](https:\/\/starship.rs\/config\/#options-14)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'⬢'` | The symbol shown, when inside a container |\n| `style` | `'bold red dimmed'` | The style for the module. |\n| `format` | `'[$symbol \\[$name\\]]($style) '` | The format for the module. |\n| `disabled` | `false` | Disables the `container` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-10)\n| Variable | Example | Description |\n|---|---|---|\n| name | `fedora-toolbox:35` | The name of the container |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-9)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[container]\nformat = '[$symbol \\[$name\\]]($style) '\n```\n## Crystal [](https:\/\/starship.rs\/config\/#crystal)\nThe `crystal` module shows the currently installed version of [Crystal](https:\/\/crystal-lang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `shard.yml` file\n- The current directory contains a `.cr` file\n### Options [](https:\/\/starship.rs\/config\/#options-15)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'🔮 '` | The symbol used before displaying the version of crystal. |\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `style` | `'bold red'` | The style for the module. |\n| `detect_extensions` | `['cr']` | Which extensions should trigger this module. |\n| `detect_files` | `['shard.yml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `crystal` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-11)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.32.1` | The version of `crystal` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-10)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[crystal]\nformat = 'via [✨ $version](bold blue) '\n```\n## Daml [](https:\/\/starship.rs\/config\/#daml)\nThe `daml` module shows the currently used [Daml](https:\/\/www.digitalasset.com\/developers) SDK version when you are in the root directory of your Daml project. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `daml.yaml` file\n### Options [](https:\/\/starship.rs\/config\/#options-16)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'Λ '` | A format string representing the symbol of Daml |\n| `style` | `'bold cyan'` | The style for the module. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['daml.yaml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `daml` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-12)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v2.2.0` | The version of `daml` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-11)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[daml]\nformat = 'via [D $version](bold bright-green) '\n```\n## Dart [](https:\/\/starship.rs\/config\/#dart)\nThe `dart` module shows the currently installed version of [Dart](https:\/\/dart.dev\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with `.dart` extension\n- The current directory contains a `.dart_tool` directory\n- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file\n### Options [](https:\/\/starship.rs\/config\/#options-17)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🎯 '` | A format string representing the symbol of Dart |\n| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |\n| `detect_files` | `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` | Which filenames should trigger this module. |\n| `detect_folders` | `['.dart_tool']` | Which folders should trigger this module. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `dart` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-13)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v2.8.4` | The version of `dart` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-12)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[dart]\nformat = 'via [🔰 $version](bold red) '\n```\n## Deno [](https:\/\/starship.rs\/config\/#deno)\nThe `deno` module shows you your currently installed version of [Deno](https:\/\/deno.land\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file\n### Options [](https:\/\/starship.rs\/config\/#options-18)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🦕 '` | A format string representing the symbol of Deno |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['deno.json', 'deno.jsonc', 'deno.lock', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'green bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `deno` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-14)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.8.3` | The version of `deno` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-13)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[deno]\nformat = 'via [🦕 $version](green bold) '\n```\n## Directory [](https:\/\/starship.rs\/config\/#directory)\nThe `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.\n\nWhen using the `fish_style_pwd_dir_length` option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.\n\nFor example, given `~\/Dev\/Nix\/nixpkgs\/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~\/D\/N\/nixpkgs\/pkgs`, whereas before it would have been `nixpkgs\/pkgs`.\n\n### Options [](https:\/\/starship.rs\/config\/#options-19)\n| Option | Default | Description |\n|---|---|---|\n| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |\n| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |\n| `format` | `'[$path]($style)[$read_only]($read_only_style) '` | The format for the module. |\n| `style` | `'bold cyan'` | The style for the module. |\n| `disabled` | `false` | Disables the `directory` module. |\n| `read_only` | `'🔒'` | The symbol indicating current directory is read only. |\n| `read_only_style` | `'red'` | The style for the read only symbol. |\n| `truncation_symbol` | `''` | The symbol to prefix to truncated paths. eg: '…\/' |\n| `before_repo_root_style` |   | The style for the path segment above the root of the git repo. The default value is equivalent to `style`. |\n| `repo_root_style` |   | The style for the root of the git repo. The default value is equivalent to `style`. |\n| `repo_root_format` | `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` | The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. |\n| `home_symbol` | `'~'` | The symbol indicating home directory. |\n| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `\/` (e.g. `\\` on Windows) |\n\nThis module has a few advanced configuration options that control how the directory is displayed.\n\n| Advanced Option | Default | Description |\n|---|---|---|\n| `substitutions` |   | A table of substitutions to be made to the path. |\n| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |\n| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. |\n\n`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories of Java. Note that this will disable the fish style PWD.\n\ntoml\n```\n[directory.substitutions]\n'\/Volumes\/network\/path' = '\/net'\n'src\/com\/long\/java\/path' = 'mypath'\n```\n\n`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `\/built\/this\/city\/on\/rock\/and\/roll`, which would normally be displayed as `rock\/and\/roll`, would be displayed as `\/b\/t\/c\/o\/rock\/and\/roll` with `fish_style_pwd_dir_length = 1`\\--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `\/bu\/th\/ci\/on\/rock\/and\/roll`.\n### Variables [](https:\/\/starship.rs\/config\/#variables-15)\n| Variable | Example | Description |\n|---|---|---|\n| path | `'D:\/Projects'` | The current directory path |\n| style\\* | `'black bold dimmed'` | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\nThe git repos have additional variables.\n\nLet us consider the path `\/path\/to\/home\/git_repo\/src\/lib`\n\n| Variable | Example | Description |\n|---|---|---|\n| before\\_root\\_path | `'\/path\/to\/home\/'` | The path before git root directory path |\n| repo\\_root | `'git_repo'` | The git root directory name |\n| path | `'\/src\/lib'` | The remaining path |\n| style | `'black bold dimmed'` | Mirrors the value of option `style` |\n| repo\\_root\\_style | `'underline white'` | Style for git root directory name |\n### Example [](https:\/\/starship.rs\/config\/#example-14)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[directory]\ntruncation_length = 8\ntruncation_symbol = '…\/'\n```\n## Direnv [](https:\/\/starship.rs\/config\/#direnv)\nThe `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-20)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[$symbol$loaded\/$allowed]($style) '` | The format for the module. |\n| `symbol` | `'direnv '` | The symbol used before displaying the direnv context. |\n| `style` | `'bold orange'` | The style for the module. |\n| `disabled` | `true` | Disables the `direnv` module. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['.envrc']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `detect_env_vars` | `['DIRENV_FILE']` | Which environment variables should trigger this module. |\n| `allowed_msg` | `'allowed'` | The message displayed when an rc file is allowed. |\n| `not_allowed_msg` | `'not allowed'` | The message displayed when an rc file is not\\_allowed. |\n| `denied_msg` | `'denied'` | The message displayed when an rc file is denied. |\n| `loaded_msg` | `'loaded'` | The message displayed when an rc file is loaded. |\n| `unloaded_msg` | `'not loaded'` | The message displayed when an rc file is not loaded. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-16)\n| Variable | Example | Description |\n|---|---|---|\n| loaded | `loaded` | Whether the current rc file is loaded. |\n| allowed | `denied` | Whether the current rc file is allowed. |\n| rc\\_path | `\/home\/test\/.envrc` | The current rc file path. |\n| symbol |   | Mirrors the value of option `symbol`. |\n| style\\* | `red bold` | Mirrors the value of option `style`. |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-15)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[direnv]\ndisabled = false\n```\n## Docker Context [](https:\/\/starship.rs\/config\/#docker-context)\nThe `docker_context` module shows the currently active [Docker context](https:\/\/docs.docker.com\/engine\/context\/working-with-contexts\/) if it's not set to `default` or `desktop-linux`, or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use).\n\n### Options [](https:\/\/starship.rs\/config\/#options-21)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol$context]($style) '` | The format for the module. |\n| `symbol` | `'🐳 '` | The symbol used before displaying the Docker context. |\n| `only_with_files` | `true` | Only show when there's a match |\n| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |\n| `detect_files` | `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` | Which filenames should trigger this module (needs `only_with_files` to be true). |\n| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |\n| `style` | `'blue bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `docker_context` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-17)\n| Variable | Example | Description |\n|---|---|---|\n| context | `test_context` | The current docker context |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-16)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[docker_context]\nformat = 'via [🐋 $context](blue bold)'\n```\n## Dotnet [](https:\/\/starship.rs\/config\/#dotnet)\nThe `dotnet` module shows the relevant version of the [.NET Core SDK](https:\/\/dotnet.microsoft.com\/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.\n\nBy default this module will only be shown in your prompt when one or more of the following files are present in the current directory:\n\n- `global.json`\n- `project.json`\n- `Directory.Build.props`\n- `Directory.Build.targets`\n- `Packages.props`\n- `*.csproj`\n- `*.fsproj`\n- `*.xproj`\n\nYou'll also need the .NET Core SDK installed in order to use it correctly.\n\nInternally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options.\n\nThe module will also show the Target Framework Moniker (<https:\/\/docs.microsoft.com\/en-us\/dotnet\/standard\/frameworks#supported-target-frameworks>) when there is a `.csproj` file in the current directory.\n\n### Options [](https:\/\/starship.rs\/config\/#options-22)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )(🎯 $tfm )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'.NET '` | The symbol used before displaying the version of dotnet. |\n| `heuristic` | `true` | Use faster version detection to keep starship snappy. |\n| `detect_extensions` | `['csproj', 'fsproj', 'xproj']` | Which extensions should trigger this module. |\n| `detect_files` | `['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `dotnet` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-18)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v3.1.201` | The version of `dotnet` sdk |\n| tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-17)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[dotnet]\nsymbol = '🥅 '\nstyle = 'green'\nheuristic = false\n```\n## Elixir [](https:\/\/starship.rs\/config\/#elixir)\nThe `elixir` module shows the currently installed version of [Elixir](https:\/\/elixir-lang.org\/) and [Erlang\/OTP](https:\/\/erlang.org\/doc\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `mix.exs` file.\n### Options [](https:\/\/starship.rs\/config\/#options-23)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version \$OTP $otp_version\$ )]($style)'` | The format for the module elixir. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'💧 '` | The symbol used before displaying the version of Elixir\/Erlang. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['mix.exs']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `style` | `'bold purple'` | The style for the module. |\n| `disabled` | `false` | Disables the `elixir` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-19)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.10` | The version of `elixir` |\n| otp\\_version |   | The otp version of `elixir` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-18)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[elixir]\nsymbol = '🔮 '\n```\n## Elm [](https:\/\/starship.rs\/config\/#elm)\nThe `elm` module shows the currently installed version of [Elm](https:\/\/elm-lang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `elm.json` file\n- The current directory contains a `elm-package.json` file\n- The current directory contains a `.elm-version` file\n- The current directory contains a `elm-stuff` folder\n- The current directory contains `*.elm` files\n### Options [](https:\/\/starship.rs\/config\/#options-24)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🌳 '` | A format string representing the symbol of Elm. |\n| `detect_extensions` | `['elm']` | Which extensions should trigger this module. |\n| `detect_files` | `['elm.json', 'elm-package.json', '.elm-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `['elm-stuff']` | Which folders should trigger this modules. |\n| `style` | `'cyan bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `elm` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-20)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.19.1` | The version of `elm` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-19)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[elm]\nformat = 'via [ $version](cyan bold) '\n```\n## Environment Variable [](https:\/\/starship.rs\/config\/#environment-variable)\nThe `env_var` module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met:\n\n- The `variable` configuration option matches an existing environment variable\n- The `variable` configuration option is not defined, but the `default` configuration option is\n\nTIP\n\nThe order in which env\\_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env\\_var modules in the order they were defined.\n\nTIP\n\nMultiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.\n\nExample: following configuration will display value of USER environment variable\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[env_var.USER]\ndefault = 'unknown user'\n```\n### Options [](https:\/\/starship.rs\/config\/#options-25)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `\"\"` | The symbol used before displaying the variable value. |\n| `variable` |   | The environment variable to be displayed. |\n| `default` |   | The default value to be displayed when the selected variable is not defined. |\n| `format` | `\"with [$env_value]($style) \"` | The format for the module. |\n| `description` | `\"<env_var module>\"` | The description of the module that is shown when running `starship explain`. |\n| `disabled` | `false` | Disables the `env_var` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-21)\n| Variable | Example | Description |\n|---|---|---|\n| env\\_value | `Windows NT` (if *variable* would be `$OS`) | The environment value of option `variable` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* | `black bold dimmed` | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-20)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[env_var]\nvariable = 'SHELL'\ndefault = 'unknown shell'\n```\n\nDisplaying multiple environmental variables:\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[env_var.SHELL]\nvariable = 'SHELL'\ndefault = 'unknown shell'\n[env_var.USER]\ndefault = 'unknown user'\n```\n## Erlang [](https:\/\/starship.rs\/config\/#erlang)\nThe `erlang` module shows the currently installed version of [Erlang\/OTP](https:\/\/erlang.org\/doc\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `rebar.config` file.\n- The current directory contains a `erlang.mk` file.\n### Options [](https:\/\/starship.rs\/config\/#options-26)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `' '` | The symbol used before displaying the version of erlang. |\n| `style` | `'bold red'` | The style for the module. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['rebar.config', 'elang.mk']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `disabled` | `false` | Disables the `erlang` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-22)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v22.1.3` | The version of `erlang` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-21)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[erlang]\nformat = 'via [e $version](bold red) '\n```\n## Fennel [](https:\/\/starship.rs\/config\/#fennel)\nThe `fennel` module shows the currently installed version of [Fennel](https:\/\/fennel-lang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with the `.fnl` extension\n### Options [](https:\/\/starship.rs\/config\/#options-27)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. |\n| `style` | `'bold green'` | The style for the module. |\n| `detect_extensions` | `['fnl']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `disabled` | `false` | Disables the `fennel` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-23)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.2.1` | The version of `fennel` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-22)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[fennel]\nsymbol = '⫰ '\n```\n## Fill [](https:\/\/starship.rs\/config\/#fill)\nThe `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.\n\n### Options [](https:\/\/starship.rs\/config\/#options-28)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'.'` | The symbol used to fill the line. |\n| `style` | `'bold black'` | The style for the module. |\n| `disabled` | `false` | Disables the `fill` module |\n### Example [](https:\/\/starship.rs\/config\/#example-23)\ntoml\n```\n# ~\/.config\/starship.toml\nformat = 'AA $fill BB $fill CC'\n\n[fill]\nsymbol = '-'\nstyle = 'bold green'\n```\n\nProduces a prompt that looks like:\n```\nAA -------------------------------------------- BB -------------------------------------------- CC\n```\n## Fortran [](https:\/\/starship.rs\/config\/#fortran)\nThe `fortran` module shows the current compiler version of Fortran.\n\n### Options [](https:\/\/starship.rs\/config\/#options-29)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `' '` | The symbol used before displaying the version of Fortran. |\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `style` | `'bold purple'` | The style for the module. |\n| `detect_extensions` | `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` | Which extensions should trigger this module. |\n| `detect_files` | `['fpm.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `commands` | `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` | How to detect what the compiler is |\n| `disabled` | `false` | Disables the `fortran` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-24)\n| Variable | Example | Description |\n|---|---|---|\n| name | gfortran | The name of the compiler |\n| version | `14.2.0` | The version of the Fortran compiler |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Commands [](https:\/\/starship.rs\/config\/#commands-2)\nThe `commands` option accepts a list of commands to determine the compiler version and name.\n\nEach command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT.\n\nIf a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https:\/\/github.com\/starship\/starship\/).\n\n## Fossil Branch [](https:\/\/starship.rs\/config\/#fossil-branch)\nThe `fossil_branch` module shows the name of the active branch of the check-out in your current directory.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-30)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. |\n| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. |\n| `style` | `'bold purple'` | The style for the module. |\n| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes |\n| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |\n| `disabled` | `true` | Disables the `fossil_branch` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-25)\n| Variable | Example | Description |\n|---|---|---|\n| branch | `trunk` | The active Fossil branch |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-24)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[fossil_branch]\nsymbol = '🦎 '\ntruncation_length = 4\ntruncation_symbol = ''\n```\n## Fossil Metrics [](https:\/\/starship.rs\/config\/#fossil-metrics)\nThe `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-31)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |\n| `added_style` | `'bold green'` | The style for the added count. |\n| `deleted_style` | `'bold red'` | The style for the deleted count. |\n| `only_nonzero_diffs` | `true` | Render status only for changed items. |\n| `disabled` | `true` | Disables the `fossil_metrics` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-26)\n| Variable | Example | Description |\n|---|---|---|\n| added | `1` | The current number of added lines |\n| deleted | `2` | The current number of deleted lines |\n| added\\_style\\* |   | Mirrors the value of option `added_style` |\n| deleted\\_style\\* |   | Mirrors the value of option `deleted_style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-25)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[fossil_metrics]\nadded_style = 'bold blue'\nformat = '[+$added]($added_style)\/[-$deleted]($deleted_style) '\n```\n## Google Cloud (`gcloud`) [](https:\/\/starship.rs\/config\/#google-cloud-gcloud)\nThe `gcloud` module shows the current configuration for [`gcloud`](https:\/\/cloud.google.com\/sdk\/gcloud) CLI. This is based on the `~\/.config\/gcloud\/active_config` file and the `~\/.config\/gcloud\/configurations\/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var.\n\nWhen the module is enabled it will always be active, unless `detect_env_vars` has been set in which case the module will only be active when one of the environment variables has been set.\n\n### Options [](https:\/\/starship.rs\/config\/#options-32)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'on [$symbol$account(@$domain)(\$$region\$)]($style) '` | The format for the module. |\n| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. |\n| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. |\n| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. |\n| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `gcloud` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-27)\n| Variable | Example | Description |\n|---|---|---|\n| region | `us-central1` | The current GCP region |\n| account | `foo` | The current GCP profile |\n| domain | `example.com` | The current GCP profile domain |\n| project |   | The current GCP project |\n| active | `default` | The active config name written in `~\/.config\/gcloud\/active_config` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Examples [](https:\/\/starship.rs\/config\/#examples-3)\n#### Display account and project [](https:\/\/starship.rs\/config\/#display-account-and-project)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[gcloud]\nformat = 'on [$symbol$account(@$domain)(\$$project\$)]($style) '\n```\n#### Display active config name only [](https:\/\/starship.rs\/config\/#display-active-config-name-only)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[gcloud]\nformat = '[$symbol$active]($style) '\nstyle = 'bold yellow'\n```\n#### Display account and aliased region [](https:\/\/starship.rs\/config\/#display-account-and-aliased-region)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[gcloud]\nsymbol = '️🇬️ '\n[gcloud.region_aliases]\nus-central1 = 'uc1'\nasia-northeast1 = 'an1'\n```\n#### Display account and aliased project [](https:\/\/starship.rs\/config\/#display-account-and-aliased-project)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[gcloud]\nformat = 'on [$symbol$account(@$domain)(\$$project\$)]($style) '\n[gcloud.project_aliases]\nvery-long-project-name = 'vlpn'\n```\n## Git Branch [](https:\/\/starship.rs\/config\/#git-branch)\nThe `git_branch` module shows the active branch of the repo in your current directory.\n\n### Options [](https:\/\/starship.rs\/config\/#options-33)\n| Option | Default | Description |\n|---|---|---|\n| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |\n| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. |\n| `symbol` | `' '` | A format string representing the symbol of git branch. |\n| `style` | `'bold purple'` | The style for the module. |\n| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |\n| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. |\n| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |\n| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. |\n| `ignore_bare_repo` | `false` | Do not show when in a bare repo. |\n| `disabled` | `false` | Disables the `git_branch` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-28)\n| Variable | Example | Description |\n|---|---|---|\n| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). |\n| remote\\_name | `origin` | The remote name. |\n| remote\\_branch | `master` | The name of the branch tracked on `remote_name`. |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-26)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_branch]\nsymbol = '🌱 '\ntruncation_length = 4\ntruncation_symbol = ''\nignore_branches = ['master', 'main']\n```\n## Git Commit [](https:\/\/starship.rs\/config\/#git-commit)\nThe `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.\n\n### Options [](https:\/\/starship.rs\/config\/#options-34)\n| Option | Default | Description |\n|---|---|---|\n| `commit_hash_length` | `7` | The length of the displayed git commit hash. |\n| `format` | `'[\$$hash$tag\$]($style) '` | The format for the module. |\n| `style` | `'bold green'` | The style for the module. |\n| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |\n| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |\n| `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. |\n| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown |\n| `disabled` | `false` | Disables the `git_commit` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-29)\n| Variable | Example | Description |\n|---|---|---|\n| hash | `b703eb3` | The current git commit hash |\n| tag | `v1.0.0` | The tag name if showing tag info is enabled. |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-27)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_commit]\ncommit_hash_length = 4\ntag_symbol = '🔖 '\n```\n## Git State [](https:\/\/starship.rs\/config\/#git-state)\nThe `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: *REBASING*, *BISECTING*, etc. If there is progress information (e.g., REBASING 3\/10), that information will be shown too.\n\n### Options [](https:\/\/starship.rs\/config\/#options-35)\n| Option | Default | Description |\n|---|---|---|\n| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |\n| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |\n| `revert` | `'REVERTING'` | A format string displayed when a `revert` is in progress. |\n| `cherry_pick` | `'CHERRY-PICKING'` | A format string displayed when a `cherry-pick` is in progress. |\n| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |\n| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. |\n| `am_or_rebase` | `'AM\/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `format` | `'\$[$state( $progress_current\/$progress_total)]($style)\$ '` | The format for the module. |\n| `disabled` | `false` | Disables the `git_state` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-30)\n| Variable | Example | Description |\n|---|---|---|\n| state | `REBASING` | The current state of the repo |\n| progress\\_current | `1` | The current operation progress |\n| progress\\_total | `2` | The total operation progress |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-28)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_state]\nformat = '[\$$state( $progress_current of $progress_total)\$]($style) '\ncherry_pick = '[🍒 PICKING](bold red)'\n```\n## Git Metrics [](https:\/\/starship.rs\/config\/#git-metrics)\nThe `git_metrics` module will show the number of added and deleted lines in the current git repository.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-36)\n| Option | Default | Description |\n|---|---|---|\n| `added_style` | `'bold green'` | The style for the added count. |\n| `deleted_style` | `'bold red'` | The style for the deleted count. |\n| `only_nonzero_diffs` | `true` | Render status only for changed items. |\n| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | The format for the module. |\n| `disabled` | `true` | Disables the `git_metrics` module. |\n| `ignore_submodules` | `false` | Ignore changes to submodules |\n### Variables [](https:\/\/starship.rs\/config\/#variables-31)\n| Variable | Example | Description |\n|---|---|---|\n| added | `1` | The current number of added lines |\n| deleted | `2` | The current number of deleted lines |\n| added\\_style\\* |   | Mirrors the value of option `added_style` |\n| deleted\\_style\\* |   | Mirrors the value of option `deleted_style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-29)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_metrics]\nadded_style = 'bold blue'\nformat = '[+$added]($added_style)\/[-$deleted]($deleted_style) '\n```\n## Git Status [](https:\/\/starship.rs\/config\/#git-status)\nThe `git_status` module shows symbols representing the state of the repo in your current directory.\n\nTIP\n\nThe Git Status module is very slow in Windows directories (for example under `\/mnt\/c\/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths.\n### Options [](https:\/\/starship.rs\/config\/#options-37)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'([\\[$all_status$ahead_behind\\]]($style) )'` | The default format for `git_status` |\n| `conflicted` | `'='` | This branch has merge conflicts. |\n| `ahead` | `'⇡'` | The format of `ahead` |\n| `behind` | `'⇣'` | The format of `behind` |\n| `diverged` | `'⇕'` | The format of `diverged` |\n| `up_to_date` | `''` | The format of `up_to_date` |\n| `untracked` | `'?'` | The format of `untracked` |\n| `stashed` | `'\\$'` | The format of `stashed` |\n| `modified` | `'!'` | The format of `modified` |\n| `staged` | `'+'` | The format of `staged` |\n| `renamed` | `'»'` | The format of `renamed` |\n| `deleted` | `'✘'` | The format of `deleted` |\n| `typechanged` | `\"\"` | The format of `typechanged` |\n| `style` | `'bold red'` | The style for the module. |\n| `ignore_submodules` | `false` | Ignore changes to submodules. |\n| `disabled` | `false` | Disables the `git_status` module. |\n| `windows_starship` |   | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |\n| `use_git_executable` | `false` | Do not use `gitoxide` for computing the status, but use the `git` executable instead. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-32)\nThe following variables can be used in `format`:\n\n| Variable | Description |\n|---|---|\n| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked` |\n| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. |\n| `conflicted` | Displays `conflicted` when this branch has merge conflicts. |\n| `untracked` | Displays `untracked` when there are untracked files in the working directory. |\n| `stashed` | Displays `stashed` when a stash exists for the local repository. |\n| `modified` | Displays `modified` when there are file modifications in the working directory. |\n| `staged` | Displays `staged` when a new file has been added to the staging area. |\n| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. |\n| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |\n| `typechanged` | Displays `typechanged` when a file's type has been changed in the staging area. |\n| style\\* | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\nThe following variables can be used in `diverged`:\n\n| Variable | Description |\n|---|---|\n| `ahead_count` | Number of commits ahead of the tracking branch |\n| `behind_count` | Number of commits behind the tracking branch |\n\nThe following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`:\n\n| Variable | Description |\n|---|---|\n| `count` | Show the number of files |\n### Example [](https:\/\/starship.rs\/config\/#example-30)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_status]\nconflicted = '🏳'\nahead = '🏎💨'\nbehind = '😰'\ndiverged = '😵'\nup_to_date = '✓'\nuntracked = '🤷'\nstashed = '📦'\nmodified = '📝'\nstaged = '[++\$$count\$](green)'\nrenamed = '👅'\ndeleted = '🗑'\n```\n\nShow ahead\/behind count of the branch being tracked\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_status]\nahead = '⇡${count}'\ndiverged = '⇕⇡${ahead_count}⇣${behind_count}'\nbehind = '⇣${count}'\n```\n\nUse Windows Starship executable on Windows paths in WSL\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[git_status]\nwindows_starship = '\/mnt\/c\/Users\/username\/scoop\/apps\/starship\/current\/starship.exe'\n```\n## Gleam [](https:\/\/starship.rs\/config\/#gleam)\nThe `gleam` module shows the currently installed version of [Gleam](https:\/\/gleam.run\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `gleam.toml` file\n- The current directory contains a file with the `.gleam` extension\n### Options [](https:\/\/starship.rs\/config\/#options-38)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'⭐ '` | A format string representing the symbol of Gleam. |\n| `detect_extensions` | `['gleam']` | Which extensions should trigger this module. |\n| `detect_files` | `['gleam.toml']` | Which filenames should trigger this module. |\n| `style` | `'bold #FFAFF3'` | The style for the module. |\n| `disabled` | `false` | Disables the `gleam` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-33)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.0.0` | The version of `gleam` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-31)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[gleam]\nformat = 'via [⭐ $version](bold red) '\n```\n## Go [](https:\/\/starship.rs\/config\/#go)\nThe `golang` module shows the currently installed version of [Go](https:\/\/golang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `go.mod` file\n- The current directory contains a `go.sum` file\n- The current directory contains a `go.work` file\n- The current directory contains a `glide.yaml` file\n- The current directory contains a `Gopkg.yml` file\n- The current directory contains a `Gopkg.lock` file\n- The current directory contains a `.go-version` file\n- The current directory contains a `Godeps` directory\n- The current directory contains a file with the `.go` extension\n### Options [](https:\/\/starship.rs\/config\/#options-39)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐹 '` | A format string representing the symbol of Go. |\n| `detect_extensions` | `['go']` | Which extensions should trigger this module. |\n| `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `['Godeps']` | Which folders should trigger this module. |\n| `style` | `'bold cyan'` | The style for the module. |\n| `not_capable_style` | `'bold red'` | The style for the module when the go directive in the go.mod file does not match the installed Go version. |\n| `disabled` | `false` | Disables the `golang` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-34)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.12.1` | The version of `go` |\n| mod\\_version | `1.16` | `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-32)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[golang]\nformat = 'via [🏎💨 $version](bold cyan) '\n```\n### Using `mod_version` [](https:\/\/starship.rs\/config\/#using-mod-version)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[golang]\nformat = 'via [$symbol($version )($mod_version )]($style)'\n```\n## Guix-shell [](https:\/\/starship.rs\/config\/#guix-shell)\nThe `guix_shell` module shows the [guix-shell](https:\/\/guix.gnu.org\/manual\/devel\/en\/html_node\/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment.\n\n### Options [](https:\/\/starship.rs\/config\/#options-40)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol]($style) '` | The format for the module. |\n| `symbol` | `'🐃 '` | A format string representing the symbol of guix-shell. |\n| `style` | `'yellow bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `guix_shell` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-35)\n| Variable | Example | Description |\n|---|---|---|\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-33)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[guix_shell]\ndisabled = true\nformat = 'via [🐂](yellow bold) '\n```\n## Gradle [](https:\/\/starship.rs\/config\/#gradle)\nThe `gradle` module shows the version of the [Gradle Wrapper](https:\/\/docs.gradle.org\/current\/userguide\/gradle_wrapper.html) currently used in the project directory.\n\nBy default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `gradle\/wrapper\/gradle-wrapper.properties` directory.\n- The current directory contains a file ending with `.gradle` or `.gradle.kts`.\n\nThe `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns.\n\n### Options [](https:\/\/starship.rs\/config\/#options-41)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🅶 '` | A format string representing the symbol of Gradle. |\n| `detect_extensions` | `['gradle', 'gradle.kts']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `['gradle']` | Which folders should trigger this module. |\n| `style` | `'bold bright-cyan'` | The style for the module. |\n| `disabled` | `false` | Disables the `gradle` module. |\n| `recursive` | `false` | Enables recursive finding for the `gradle` directory. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-36)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v7.5.1` | The version of `gradle` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Haskell [](https:\/\/starship.rs\/config\/#haskell)\nThe `haskell` module finds the current selected GHC version and\/or the selected Stack snapshot.\n\nBy default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `stack.yaml` file\n- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file\n### Options [](https:\/\/starship.rs\/config\/#options-42)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `symbol` | `'λ '` | A format string representing the symbol of Haskell |\n| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Which extensions should trigger this module. |\n| `detect_files` | `['stack.yaml', 'cabal.project']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold purple'` | The style for the module. |\n| `disabled` | `false` | Disables the `haskell` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-37)\n| Variable | Example | Description |\n|---|---|---|\n| version |   | `ghc_version` or `snapshot` depending on whether the current project is a Stack project |\n| snapshot | `lts-18.12` | Currently selected Stack snapshot |\n| ghc\\_version | `9.2.1` | Currently installed GHC version |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Haxe [](https:\/\/starship.rs\/config\/#haxe)\nThe `haxe` module shows the currently installed version of [Haxe](https:\/\/haxe.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `project.xml`, `Project.xml`, `application.xml`, `haxelib.json`, `hxformat.json` or `.haxerc` file\n- The current directory contains a `.haxelib` or a `haxe_libraries` directory\n- The current directory contains a file with the `.hx` or `.hxml` extension\n### Options [](https:\/\/starship.rs\/config\/#options-43)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `['hx', 'hxml']` | Which extensions should trigger this module. |\n| `detect_files` | `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` | Which filenames should trigger this module. |\n| `detect_folders` | `['.haxelib', 'haxe_libraries']` | Which folders should trigger this modules. |\n| `symbol` | `'⌘ '` | A format string representing the symbol of Haxe. |\n| `style` | `'bold fg:202'` | The style for the module. |\n| `disabled` | `false` | Disables the `haxe` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-38)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v4.2.5` | The version of `haxe` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-34)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[haxe]\nformat = \"via [⌘ $version](bold fg:202) \"\n```\n## Helm [](https:\/\/starship.rs\/config\/#helm)\nThe `helm` module shows the currently installed version of [Helm](https:\/\/helm.sh\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `helmfile.yaml` file\n- The current directory contains a `Chart.yaml` file\n### Options [](https:\/\/starship.rs\/config\/#options-44)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `symbol` | `'⎈ '` | A format string representing the symbol of Helm. |\n| `style` | `'bold white'` | The style for the module. |\n| `disabled` | `false` | Disables the `helm` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-39)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v3.1.1` | The version of `helm` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-35)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[helm]\nformat = 'via [⎈ $version](bold white) '\n```\n## Hostname [](https:\/\/starship.rs\/config\/#hostname)\nThe `hostname` module shows the system hostname.\n\n### Options [](https:\/\/starship.rs\/config\/#options-45)\n| Option | Default | Description |\n|---|---|---|\n| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |\n| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. |\n| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation. |\n| `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. |\n| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. |\n| `style` | `'bold dimmed green'` | The style for the module. |\n| `disabled` | `false` | Disables the `hostname` module. |\n| `aliases` | `{}` | Translate system hostnames to something else. If `trim_at` is specified, only the first part will be matched and replaced. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-40)\n| Variable | Example | Description |\n|---|---|---|\n| hostname | `computer` | The hostname of the computer |\n| style\\* |   | Mirrors the value of option `style` |\n| ssh\\_symbol | `'🌏 '` | The symbol to represent when connected to SSH session |\n\n\\*: This variable can only be used as a part of a style string\n\n### Examples [](https:\/\/starship.rs\/config\/#examples-4)\n#### Always show the hostname [](https:\/\/starship.rs\/config\/#always-show-the-hostname)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[hostname]\nssh_only = false\nformat = '[$ssh_symbol](bold blue) on [$hostname](bold red) '\ntrim_at = '.companyname.com'\ndisabled = false\n```\n#### Hide the hostname in remote tmux sessions [](https:\/\/starship.rs\/config\/#hide-the-hostname-in-remote-tmux-sessions)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[hostname]\nssh_only = false\ndetect_env_vars = ['!TMUX', 'SSH_CONNECTION']\ndisabled = false\n```\n#### Replace the hostname with a nickname [](https:\/\/starship.rs\/config\/#replace-the-hostname-with-a-nickname)\ntoml\n```\n# ~\/.config\/starship.toml\n[hostname]\naliases = { \"Max's MacBook Pro\" = \"home\" }\n```\n## Java [](https:\/\/starship.rs\/config\/#java)\nThe `java` module shows the currently installed version of [Java](https:\/\/www.oracle.com\/java\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, `build.boot`, or `.sdkmanrc` file\n- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension\n### Options [](https:\/\/starship.rs\/config\/#options-46)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [${symbol}(${version} )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Which extensions should trigger this module. |\n| `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `symbol` | `'☕ '` | A format string representing the symbol of Java |\n| `style` | `'red dimmed'` | The style for the module. |\n| `disabled` | `false` | Disables the `java` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-41)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v14` | The version of `java` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-36)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[java]\nsymbol = '🌟 '\n```\n## Jobs [](https:\/\/starship.rs\/config\/#jobs)\nThe `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to *always* show the symbol and number of jobs, even if there are 0 jobs running.\n\nThe default functionality is:\n\n- 0 jobs -\\> Nothing is shown.\n- 1 job -\\> `symbol` is shown.\n- 2 jobs or more -\\> `symbol` + `number` are shown.\n\nWARNING\n\nThis module is not supported on tcsh.\n\nWARNING\n\nThe `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.\n### Options [](https:\/\/starship.rs\/config\/#options-47)\n| Option | Default | Description |\n|---|---|---|\n| `threshold`\\* | `1` | Show number of jobs if exceeded. |\n| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. |\n| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. |\n| `format` | `'[$symbol$number]($style) '` | The format for the module. |\n| `symbol` | `'✦'` | The string used to represent the `symbol` variable. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `jobs` module. |\n\n\\*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead.\n\n### Variables [](https:\/\/starship.rs\/config\/#variables-42)\n| Variable | Example | Description |\n|---|---|---|\n| number | `1` | The number of jobs |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Examples [](https:\/\/starship.rs\/config\/#examples-5)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[jobs]\nsymbol = '+ '\nnumber_threshold = 4\nsymbol_threshold = 0\n```\n#### Changing process grouping behavior in fish [](https:\/\/starship.rs\/config\/#changing-process-grouping-behavior-in-fish)\nWhen using the Fish shell, Starship counts **job groups** instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config:\n\nfish\n```\nset -g __starship_fish_use_job_groups \"false\"\n```\n## Julia [](https:\/\/starship.rs\/config\/#julia)\nThe `julia` module shows the currently installed version of [Julia](https:\/\/julialang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Project.toml` file\n- The current directory contains a `Manifest.toml` file\n- The current directory contains a file with the `.jl` extension\n### Options [](https:\/\/starship.rs\/config\/#options-48)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `['jl']` | Which extensions should trigger this module. |\n| `detect_files` | `['Project.toml', 'Manifest.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. |\n| `style` | `'bold purple'` | The style for the module. |\n| `disabled` | `false` | Disables the `julia` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-43)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.4.0` | The version of `julia` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-37)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[julia]\nsymbol = '∴ '\n```\n## Kotlin [](https:\/\/starship.rs\/config\/#kotlin)\nThe `kotlin` module shows the currently installed version of [Kotlin](https:\/\/kotlinlang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `.kt` or a `.kts` file\n### Options [](https:\/\/starship.rs\/config\/#options-49)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `['kt', 'kts']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. |\n| `style` | `'bold blue'` | The style for the module. |\n| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. |\n| `disabled` | `false` | Disables the `kotlin` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-44)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.4.21` | The version of `kotlin` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-38)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[kotlin]\nsymbol = '🅺 '\n```\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[kotlin]\n# Uses the Kotlin Compiler binary to get the installed version\nkotlin_binary = 'kotlinc'\n```\n## Kubernetes [](https:\/\/starship.rs\/config\/#kubernetes)\nDisplays the current [Kubernetes context](https:\/\/kubernetes.io\/docs\/concepts\/configuration\/organize-cluster-access-kubeconfig\/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~\/.kube\/config`.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n\nWhen the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set.\n### Options [](https:\/\/starship.rs\/config\/#options-50)\nWARNING\n\nThe `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead.\n\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. |\n| `format` | `'[$symbol$context( \$$namespace\$)]($style) in '` | The format for the module. |\n| `style` | `'cyan bold'` | The style for the module. |\n| `context_aliases`\\* | `{}` | Table of context aliases to display. |\n| `user_aliases`\\* | `{}` | Table of user aliases to display. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this modules. |\n| `detect_env_vars` | `[]` | Which environmental variables should trigger this module |\n| `contexts` | `[]` | Customized styles and symbols for specific contexts. |\n| `disabled` | `true` | Disables the `kubernetes` module. |\n\n\\*: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead.\n\nTo customize the style of the module for specific environments, use the following configuration as part of the `contexts` list:\n\n| Variable | Description |\n|---|---|\n| `context_pattern` | **Required** Regular expression to match current Kubernetes context name. |\n| `user_pattern` | Regular expression to match current Kubernetes user name. |\n| `context_alias` | Context alias to display instead of the full context name. |\n| `user_alias` | User alias to display instead of the full user name. |\n| `style` | The style for the module when using this context. If not set, will use module's style. |\n| `symbol` | The symbol for the module when using this context. If not set, will use module's symbol. |\n\nNote that all regular expression are anchored with `^<pattern>$` and so must match the whole string. The `*_pattern` regular expressions may contain capture groups, which can be referenced in the corresponding alias via `$name` and `$N` (see example below and the [rust Regex::replace() documentation](https:\/\/docs.rs\/regex\/latest\/regex\/struct.Regex.html#method.replace)).\n\n### Variables [](https:\/\/starship.rs\/config\/#variables-45)\n| Variable | Example | Description |\n|---|---|---|\n| context | `starship-context` | The current kubernetes context name |\n| namespace | `starship-namespace` | If set, the current kubernetes namespace |\n| user | `starship-user` | If set, the current kubernetes user |\n| cluster | `starship-cluster` | If set, the current kubernetes cluster |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-39)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[kubernetes]\nformat = 'on [⛵ ($user on )($cluster in )$context \$$namespace\$](dimmed green) '\ndisabled = false\ncontexts = [\n  { context_pattern = \"dev.local.cluster.k8s\", style = \"green\", symbol = \"💔 \" },\n]\n```\n\nOnly show the module in directories that contain a `k8s` file.\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[kubernetes]\ndisabled = false\ndetect_files = ['k8s']\n```\n#### Kubernetes Context specific config [](https:\/\/starship.rs\/config\/#kubernetes-context-specific-config)\nThe `contexts` configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[[kubernetes.contexts]]\n# \"bold red\" style + default symbol when Kubernetes current context name equals \"production\" *and* the current user\n# equals \"admin_user\"\ncontext_pattern = \"production\"\nuser_pattern = \"admin_user\"\nstyle = \"bold red\"\ncontext_alias = \"prod\"\nuser_alias = \"admin\"\n\n[[kubernetes.contexts]]\n# \"green\" style + a different symbol when Kubernetes current context name contains openshift\ncontext_pattern = \".*openshift.*\"\nstyle = \"green\"\nsymbol = \"💔 \"\ncontext_alias = \"openshift\"\n\n[[kubernetes.contexts]]\n# Using capture groups\n# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region\/zone.\n# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)\n# and renames every matching kube context into a more readable format (`gke-cluster-name`):\ncontext_pattern = \"gke_.*_(?P<cluster>[\\\\w-]+)\"\ncontext_alias = \"gke-$cluster\"\n```\n## Line Break [](https:\/\/starship.rs\/config\/#line-break)\nThe `line_break` module separates the prompt into two lines.\n\n### Options [](https:\/\/starship.rs\/config\/#options-51)\n| Option | Default | Description |\n|---|---|---|\n| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |\n### Example [](https:\/\/starship.rs\/config\/#example-40)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[line_break]\ndisabled = true\n```\n## Local IP [](https:\/\/starship.rs\/config\/#local-ip)\nThe `localip` module shows the IPv4 address of the primary network interface.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-52)\n| Option | Default | Description |\n|---|---|---|\n| `ssh_only` | `true` | Only show IP address when connected to an SSH session. |\n| `format` | `'[$localipv4]($style) '` | The format for the module. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `true` | Disables the `localip` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-46)\n| Variable | Example | Description |\n|---|---|---|\n| localipv4 | 192\\.168.1.13 | Contains the primary IPv4 address |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-41)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[localip]\nssh_only = false\nformat = '@[$localipv4](bold red) '\ndisabled = false\n```\n## Lua [](https:\/\/starship.rs\/config\/#lua)\nThe `lua` module shows the currently installed version of [Lua](http:\/\/www.lua.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `.lua-version` file\n- The current directory contains a `lua` directory\n- The current directory contains a file with the `.lua` extension\n### Options [](https:\/\/starship.rs\/config\/#options-53)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. |\n| `detect_extensions` | `['lua']` | Which extensions should trigger this module. |\n| `detect_files` | `['.lua-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `['lua']` | Which folders should trigger this module. |\n| `style` | `'bold blue'` | The style for the module. |\n| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. |\n| `disabled` | `false` | Disables the `lua` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-47)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v5.4.0` | The version of `lua` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-42)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[lua]\nformat = 'via [🌕 $version](bold blue) '\n```\n## Memory Usage [](https:\/\/starship.rs\/config\/#memory-usage)\nThe `memory_usage` module shows current system memory and swap usage.\n\nBy default the swap usage is displayed if the total system swap is non-zero.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-54)\n| Option | Default | Description |\n|---|---|---|\n| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |\n| `format` | `'via $symbol [${ram}( | ${swap})]($style) '` | The format for the module. |\n| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. |\n| `style` | `'bold dimmed white'` | The style for the module. |\n| `disabled` | `true` | Disables the `memory_usage` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-48)\n| Variable | Example | Description |\n|---|---|---|\n| ram | `31GiB\/65GiB` | The usage\/total RAM of the current system memory. |\n| ram\\_pct | `48%` | The percentage of the current system memory. |\n| swap\\*\\* | `1GiB\/4GiB` | The swap memory size of the current system swap memory file. |\n| swap\\_pct\\*\\* | `77%` | The swap memory percentage of the current system swap memory file. |\n| symbol | `🐏` | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string \\*\\*: The SWAP file information is only displayed if detected on the current system\n\n### Example [](https:\/\/starship.rs\/config\/#example-43)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[memory_usage]\ndisabled = false\nthreshold = -1\nsymbol = ' '\nstyle = 'bold dimmed green'\n```\n## Meson [](https:\/\/starship.rs\/config\/#meson)\nThe `meson` module shows the current Meson developer environment status.\n\nBy default the Meson project name is displayed, if `$MESON_DEVENV` is set.\n\n### Options [](https:\/\/starship.rs\/config\/#options-55)\n| Option | Default | Description |\n|---|---|---|\n| `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. |\n| `truncation_symbol` | `'…'` | The symbol used to indicate a project name was truncated. You can use `''` for no symbol. |\n| `format` | `'via [$symbol$project]($style) '` | The format for the module. |\n| `symbol` | `'⬢ '` | The symbol used before displaying the project name. |\n| `style` | `'blue bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `meson` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-49)\n| Variable | Example | Description |\n|---|---|---|\n| project | `starship` | The current Meson project name |\n| symbol | `🐏` | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-44)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[meson]\ndisabled = false\ntruncation_symbol = '--'\nsymbol = ' '\nstyle = 'bold dimmed green'\n```\n## Mercurial Branch [](https:\/\/starship.rs\/config\/#mercurial-branch)\nThe `hg_branch` module shows the active branch and topic of the repo in your current directory.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-56)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |\n| `style` | `'bold purple'` | The style for the module. |\n| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. |\n| `truncation_length` | `2^63 - 1` | Truncates the hg branch \/ topic name to `N` graphemes |\n| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |\n| `disabled` | `true` | Disables the `hg_branch` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-50)\n| Variable | Example | Description |\n|---|---|---|\n| branch | `master` | The active mercurial branch |\n| topic | `feature` | The active mercurial topic |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-45)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[hg_branch]\nformat = 'on [🌱 $branch](bold purple)'\ntruncation_length = 4\ntruncation_symbol = ''\n```\n## Mercurial State [](https:\/\/starship.rs\/config\/#mercurial-state)\nThe `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: *REBASING*, *BISECTING*, etc.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-57)\n| Option | Default | Description |\n|---|---|---|\n| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. |\n| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. |\n| `update` | `'UPDATING'` | A format string displayed when a `update` is in progress. |\n| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. |\n| `shelve` | `'SHELVING'` | A format string displayed when a `shelve` is in progress. |\n| `graft` | `'GRAFTING'` | A format string displayed when a `graft` is in progress. |\n| `transplant` | `'TRANSPLANTING'` | A format string displayed when a `transplant` is in progress. |\n| `histedit` | `'HISTEDITING'` | A format string displayed when a `histedit` is in progress. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `format` | `'\$[$state]($style)\$ '` | The format for the module. |\n| `disabled` | `true` | Disables the `hg_state` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-51)\n| Variable | Example | Description |\n|---|---|---|\n| state | `REBASING` | The current state of the repo |\n| progress\\_current | `1` | The current operation progress |\n| progress\\_total | `2` | The total operation progress |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Mise [](https:\/\/starship.rs\/config\/#mise)\nThe `mise` module shows the current mise health as reported by running `mise doctor`.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-58)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'mise '` | The symbol used before displaying *mise* health. |\n| `style` | `'bold purple'` | The style for the module. |\n| `format` | `'on [$symbol$health]($style) '` | The format for the module. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['mise.toml', 'mise.local.toml', '.mise.toml', '.mise.local.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `['.mise']` | Which folders should trigger this module. |\n| `healthy_symbol` | `healthy` | The message displayed when *mise* is healthy. |\n| `unhealthy_symbol` | `unhealthy` | The message displayed when *mise* is unhealthy. |\n| `disabled` | `true` | Disables the `mise` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-52)\n| Variable | Example | Description |\n|---|---|---|\n| health | `healthy` | The health of *mise* |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-46)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[mise]\nhealth = 'ready'\n```\n## Mojo [](https:\/\/starship.rs\/config\/#mojo)\nThe `mojo` module shows the current version of [Mojo programming language](https:\/\/www.modular.com\/mojo) installed\n\n### Options [](https:\/\/starship.rs\/config\/#options-59)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'with [$symbol($version )]($style)'` | The format for the module. |\n| `symbol` | `'🔥 '` | The symbol used before displaying the version of Mojo. |\n| `style` | `'bold 208'` | The style for the module. |\n| `disabled` | `false` | Disables the `mojo` module. |\n| `detect_extensions` | `['mojo', '🔥']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-53)\n| Variable | Example | Description |\n|---|---|---|\n| version | `24.4.0` | The version of `mojo` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-47)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[mojo]\nformat = 'via [mojo ($version )($hash )]($style)'\n```\n## NATS [](https:\/\/starship.rs\/config\/#nats)\nThe `nats` module shows the name of the current [NATS](https:\/\/nats.io\/) context.\n\n### Options [](https:\/\/starship.rs\/config\/#options-60)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `'✉️ '` | The symbol used before the NATS context (defaults to empty). |\n| `style` | `'bold purple'` | The style for the module. |\n| `format` | `'[$symbol$name]($style)'` | The format for the module. |\n| `disabled` | `false` | Disables the `nats` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-54)\n| Variable | Example | Description |\n|---|---|---|\n| name | `localhost` | The name of the NATS context |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-48)\ntoml\n```\n[nats]\nformat = '[$symbol]($style)'\nstyle = 'bold purple'\n```\n## Network Namespace [](https:\/\/starship.rs\/config\/#network-namespace)\nThe `netns` module shows the current network namespace. This uses `ip netns identify` to get the network namespace, so only network namespaces mounted at `\/var\/run\/netns` will be detected.\n\n### Options [](https:\/\/starship.rs\/config\/#options-61)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[$symbol \\[$name\\]]($style)'` | The format for the module. |\n| `symbol` | `'🛜 '` | The symbol used before the network namespace (defaults to empty). |\n| `style` | `'blue bold dimmed'` | The style for the module. |\n| `disabled` | `false` | Disables the `netns` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-55)\n| Variable | Example | Description |\n|---|---|---|\n| name | `my-netns` | The name of the current network namespace |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-49)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[netns]\nstyle = 'bold yellow'\nsymbol = '🌐 '\n```\n## Nim [](https:\/\/starship.rs\/config\/#nim)\nThe `nim` module shows the currently installed version of [Nim](https:\/\/nim-lang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `nim.cfg` file\n- The current directory contains a file with the `.nim` extension\n- The current directory contains a file with the `.nims` extension\n- The current directory contains a file with the `.nimble` extension\n### Options [](https:\/\/starship.rs\/config\/#options-62)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. |\n| `detect_extensions` | `['nim', 'nims', 'nimble']` | Which extensions should trigger this module. |\n| `detect_files` | `['nim.cfg']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `false` | Disables the `nim` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-56)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.2.0` | The version of `nimc` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-50)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[nim]\nstyle = 'yellow'\nsymbol = '🎣 '\n```\n## Nix-shell [](https:\/\/starship.rs\/config\/#nix-shell)\nThe `nix_shell` module shows the [nix-shell](https:\/\/nixos.org\/guides\/nix-pills\/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment.\n\n### Options [](https:\/\/starship.rs\/config\/#options-63)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol$state( \$$name\$)]($style) '` | The format for the module. |\n| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. |\n| `style` | `'bold blue'` | The style for the module. |\n| `impure_msg` | `'impure'` | A format string shown when the shell is impure. |\n| `pure_msg` | `'pure'` | A format string shown when the shell is pure. |\n| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure\/impure. |\n| `disabled` | `false` | Disables the `nix_shell` module. |\n| `heuristic` | `false` | Attempts to detect new `nix shell`\\-style shells with a heuristic. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-57)\n| Variable | Example | Description |\n|---|---|---|\n| state | `pure` | The state of the nix-shell |\n| name | `lorri` | The name of the nix-shell |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-51)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[nix_shell]\ndisabled = true\nimpure_msg = '[impure shell](bold red)'\npure_msg = '[pure shell](bold green)'\nunknown_msg = '[unknown shell](bold yellow)'\nformat = 'via [☃️ $state( \$$name\$)](bold blue) '\n```\n## Node.js [](https:\/\/starship.rs\/config\/#node-js)\nThe `nodejs` module shows the currently installed version of [Node.js](https:\/\/nodejs.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `package.json` file\n- The current directory contains a `.node-version` file\n- The current directory contains a `.nvmrc` file\n- The current directory contains a `node_modules` directory\n- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension\n- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension\n\nAdditionally, the module will be hidden by default if the directory contains a `bunfig.toml`, `bun.lock`, or `bun.lockb` file, overriding the above conditions.\n\n### Options [](https:\/\/starship.rs\/config\/#options-64)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `' '` | A format string representing the symbol of Node.js. |\n| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Which extensions should trigger this module. |\n| `detect_files` | `['package.json', '.node-version', '.nvmrc']` | Which filenames should trigger this module. |\n| `detect_folders` | `['node_modules']` | Which folders should trigger this module. |\n| `style` | `'bold green'` | The style for the module. |\n| `disabled` | `false` | Disables the `nodejs` module. |\n| `not_capable_style` | `'bold red'` | The style for the module when an engines property in package.json does not match the Node.js version. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-58)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v13.12.0` | The version of `node` |\n| engines\\_version | `>=12.0.0` | `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-52)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[nodejs]\nformat = 'via [🤖 $version](bold green) '\n```\n## OCaml [](https:\/\/starship.rs\/config\/#ocaml)\nThe `ocaml` module shows the currently installed version of [OCaml](https:\/\/ocaml.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with `.opam` extension or `_opam` directory\n- The current directory contains a `esy.lock` directory\n- The current directory contains a `dune` or `dune-project` file\n- The current directory contains a `jbuild` or `jbuild-ignore` file\n- The current directory contains a `.merlin` file\n- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension\n### Options [](https:\/\/starship.rs\/config\/#options-65)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )(\$$switch_indicator$switch_name\$ )]($style)'` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐫 '` | The symbol used before displaying the version of OCaml. |\n| `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. |\n| `local_switch_indicator` | `'*'` | The format string used to represent local OPAM switch. |\n| `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Which extensions should trigger this module. |\n| `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | Which filenames should trigger this module. |\n| `detect_folders` | `['_opam', 'esy.lock']` | Which folders should trigger this module. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `false` | Disables the `ocaml` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-59)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v4.10.0` | The version of `ocaml` |\n| switch\\_name | `my-project` | The active OPAM switch |\n| switch\\_indicator |   | Mirrors the value of `indicator` for currently active OPAM switch |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-53)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[ocaml]\nformat = 'via [🐪 $version]($style) '\n```\n## Odin [](https:\/\/starship.rs\/config\/#odin)\nThe `odin` module shows the currently installed version of [Odin](https:\/\/odin-lang.org\/). By default the module will be shown if the current directory contains a `.odin` file.\n\n### Options [](https:\/\/starship.rs\/config\/#options-66)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `show_commit` | `false` | Shows the commit as part of the version. |\n| `symbol` | `'Ø '` | The symbol used before displaying the version of Odin. |\n| `style` | `'bold bright-blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `odin` module. |\n| `detect_extensions` | `['odin']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-60)\n| Variable | Example | Description |\n|---|---|---|\n| version | `dev-2024-03` | The version of `odin` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-54)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[odin]\nformat = 'via [󰹩 ($version )]($style)'\nshow_commit = true\n```\n## Open Policy Agent [](https:\/\/starship.rs\/config\/#open-policy-agent)\nThe `opa` module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a `.rego` file.\n\n### Options [](https:\/\/starship.rs\/config\/#options-67)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🪖 '` | A format string representing the symbol of OPA. |\n| `detect_extensions` | `['rego']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `opa` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-61)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.44.0` | The version of `opa` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-55)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[opa]\nformat = 'via [⛑️  $version](bold red) '\n```\n## OpenStack [](https:\/\/starship.rs\/config\/#openstack)\nThe `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https:\/\/docs.openstack.org\/python-openstackclient\/latest\/configuration\/index.html#configuration-files). to fetch the current project in use.\n\n### Options [](https:\/\/starship.rs\/config\/#options-68)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'on [$symbol$cloud(\$$project\$)]($style) '` | The format for the module. |\n| `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `false` | Disables the `openstack` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-62)\n| Variable | Example | Description |\n|---|---|---|\n| cloud | `corp` | The current OpenStack cloud |\n| project | `dev` | The current OpenStack project |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-56)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[openstack]\nformat = 'on [$symbol$cloud(\$$project\$)]($style) '\nstyle = 'bold yellow'\nsymbol = '☁️ '\n```\n## OS [](https:\/\/starship.rs\/config\/#os)\nThe `os` module shows the current operating system. OS information is detected via the [os\\_info](https:\/\/lib.rs\/crates\/os_info) crate.\n\nWARNING\n\nThe [os\\_info](https:\/\/lib.rs\/crates\/os_info) crate used by this module is known to be inaccurate on some systems.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-69)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[$symbol]($style)'` | The format for the module. |\n| `style` | `'bold white'` | The style for the module. |\n| `disabled` | `true` | Disables the `os` module. |\n| `symbols` |   | A table that maps each operating system to its symbol. |\n\n`symbols` allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a [feature request](https:\/\/github.com\/starship\/starship\/issues\/new\/choose).\n\ntoml\n```\n# This is the default symbols table.\n[os.symbols]\nAIX = \"➿ \"\nAlpaquita = \"🔔 \"\nAlmaLinux = \"💠 \"\nAlpine = \"🏔️ \"\nALTLinux = \"Ⓐ \"\nAmazon = \"🙂 \"\nAndroid = \"🤖 \"\nAOSC = \"🐱 \"\nArch = \"🎗️ \"\nArtix = \"🎗️ \"\nBluefin = \"🐟 \"\nCachyOS = \"🎗️ \"\nCentOS = \"💠 \"\nDebian = \"🌀 \"\nDragonFly = \"🐉 \"\nElementary = \"🍏 \"\nEmscripten = \"🔗 \"\nEndeavourOS = \"🚀 \"\nFedora = \"🎩 \"\nFreeBSD = \"😈 \"\nGaruda = \"🦅 \"\nGentoo = \"🗜️ \"\nHardenedBSD = \"🛡️ \"\nIllumos = \"🐦 \"\nIos = \"📱 \"\nInstantOS = \"⏲️ \"\nKali = \"🐉 \"\nLinux = \"🐧 \"\nMabox = \"📦 \"\nMacos = \"🍎 \"\nManjaro = \"🥭 \"\nMariner = \"🌊 \"\nMidnightBSD = \"🌘 \"\nMint = \"🌿 \"\nNetBSD = \"🚩 \"\nNixOS = \"❄️ \"\nNobara = \"🎩 \"\nOpenBSD = \"🐡 \"\nOpenCloudOS = \"☁️ \"\nopenEuler = \"🦉 \"\nopenSUSE = \"🦎 \"\nOracleLinux = \"🦴 \"\nPikaOS = \"🐤 \"\nPop = \"🍭 \"\nRaspbian = \"🍓 \"\nRedhat = \"🎩 \"\nRedHatEnterprise = \"🎩 \"\nRockyLinux = \"💠 \"\nRedox = \"🧪 \"\nSolus = \"⛵ \"\nSUSE = \"🦎 \"\nUbuntu = \"🎯 \"\nUltramarine = \"🔷 \"\nUnknown = \"❓ \"\nUos = \"🐲 \"\nVoid = \" \"\nWindows = \"🪟 \"\nZorin = \"🔹 \"\n```\n### Variables [](https:\/\/starship.rs\/config\/#variables-63)\n| Variable | Example | Description |\n|---|---|---|\n| symbol | `🎗️` | The current operating system symbol from advanced option `symbols` |\n| name | `Arch Linux` | The current operating system name |\n| type | `Arch` | The current operating system type |\n| codename |   | The current operating system codename, if applicable |\n| edition |   | The current operating system edition, if applicable |\n| version |   | The current operating system version, if applicable |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-57)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[os]\nformat = \"on [($name )]($style)\"\nstyle = \"bold blue\"\ndisabled = false\n\n[os.symbols]\nWindows = \" \"\nArch = \"Arch is the best! \"\n```\n## Package Version [](https:\/\/starship.rs\/config\/#package-version)\nThe `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages.\n\n- [**npm**](https:\/\/docs.npmjs.com\/cli\/commands\/npm) – The `npm` package version is extracted from the `package.json` present in the current directory\n- [**JSR**](https:\/\/jsr.io\/) – The `jsr` package version is extracted from the `jsr.json`\/`jsr.jsonc` or `deno.json`\/`deno.jsonc` present in the current directory\n- [**Cargo**](https:\/\/doc.rust-lang.org\/cargo\/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory\n- [**Nimble**](https:\/\/github.com\/nim-lang\/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command\n- [**Poetry**](https:\/\/python-poetry.org\/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory\n- [**Python**](https:\/\/www.python.org\/) - The `python` package version is extracted from a [PEP 621](https:\/\/peps.python.org\/pep-0621\/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory\n- [**Composer**](https:\/\/getcomposer.org\/) – The `composer` package version is extracted from the `composer.json` present in the current directory\n- [**Gradle**](https:\/\/gradle.org\/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory\n- [**Julia**](https:\/\/docs.julialang.org\/en\/v1\/stdlib\/Pkg\/) - The package version is extracted from the `Project.toml` present in the current directory\n- [**Mix**](https:\/\/hexdocs.pm\/mix\/) - The `mix` package version is extracted from the `mix.exs` present in the current directory\n- [**Helm**](https:\/\/helm.sh\/docs\/helm\/helm_package\/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory\n- [**Maven**](https:\/\/maven.apache.org\/) - The `maven` package version is extracted from the `pom.xml` present in the current directory\n- [**Meson**](https:\/\/mesonbuild.com\/) - The `meson` package version is extracted from the `meson.build` present in the current directory\n- [**Shards**](https:\/\/crystal-lang.org\/reference\/the_shards_command\/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory\n- [**Galaxy**](https:\/\/galaxy.ansible.com\/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory\n- [**V**](https:\/\/vlang.io\/) - The `vlang` package version is extracted from the `v.mod` present in the current directory\n- [**SBT**](https:\/\/scala-sbt.org\/) - The `sbt` package version is extracted from the `build.sbt` present in the current directory\n- [**Daml**](https:\/\/www.digitalasset.com\/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory\n- [**Dart**](https:\/\/pub.dev\/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory\n\n> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.\n### Options [](https:\/\/starship.rs\/config\/#options-70)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'is [$symbol$version]($style) '` | The format for the module. |\n| `symbol` | `'📦 '` | The symbol used before displaying the version the package. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `style` | `'bold 208'` | The style for the module. |\n| `display_private` | `false` | Enable displaying version for packages marked as private. |\n| `disabled` | `false` | Disables the `package` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-64)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.0.0` | The version of your package |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-58)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[package]\nformat = 'via [🎁 $version](208 bold) '\n```\n## Perl [](https:\/\/starship.rs\/config\/#perl)\nThe `perl` module shows the currently installed version of [Perl](https:\/\/www.perl.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Makefile.PL` or `Build.PL` file\n- The current directory contains a `cpanfile` or `cpanfile.snapshot` file\n- The current directory contains a `META.json` file or `META.yml` file\n- The current directory contains a `.perl-version` file\n- The current directory contains a `.pl`, `.pm` or `.pod`\n### Options [](https:\/\/starship.rs\/config\/#options-71)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl |\n| `detect_extensions` | `['pl', 'pm', 'pod']` | Which extensions should trigger this module. |\n| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold 149'` | The style for the module. |\n| `disabled` | `false` | Disables the `perl` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-65)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v5.26.1` | The version of `perl` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-59)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[perl]\nformat = 'via [🦪 $version]($style) '\n```\n## PHP [](https:\/\/starship.rs\/config\/#php)\nThe `php` module shows the currently installed version of [PHP](https:\/\/www.php.net\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `composer.json` file\n- The current directory contains a `.php-version` file\n- The current directory contains a `.php` extension\n### Options [](https:\/\/starship.rs\/config\/#options-72)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. |\n| `detect_extensions` | `['php']` | Which extensions should trigger this module. |\n| `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'147 bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `php` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-66)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v7.3.8` | The version of `php` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-60)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[php]\nformat = 'via [🔹 $version](147 bold) '\n```\n## Pijul Channel [](https:\/\/starship.rs\/config\/#pijul-channel)\nThe `pijul_channel` module shows the active channel of the repo in your current directory.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-73)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. |\n| `style` | `'bold purple'` | The style for the module. |\n| `format` | `'on [$symbol$channel]($style) '` | The format for the module. |\n| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes |\n| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. |\n| `disabled` | `true` | Disables the `pijul` module. |\n## Pixi [](https:\/\/starship.rs\/config\/#pixi)\nThe `pixi` module shows the installed [pixi](https:\/\/pixi.sh\/) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set.\n\nTIP\n\nThis does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`.\n### Options [](https:\/\/starship.rs\/config\/#options-74)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )(\$$environment\$ )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch`. |\n| `symbol` | `'🧚 '` | The symbol used before the environment name. |\n| `style` | `'yellow bold'` | The style for the module. |\n| `show_default_environment` | `true` | Whether to indicate that the `default` environment of your project is activated. |\n| `pixi_binary` | `['pixi']` | Configures the pixi binary that Starship should execute when getting the version. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['pixi.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `pixi` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-67)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.33.0` | The version of `pixi` |\n| environment | `py311` | The current pixi environment |\n| symbol |   | Mirrors the value of option `symbol` |\n| style |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-61)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[pixi]\nformat = '[$symbol$environment](yellow) '\n```\n## Pulumi [](https:\/\/starship.rs\/config\/#pulumi)\nThe `pulumi` module shows the current username, selected [Pulumi Stack](https:\/\/www.pulumi.com\/docs\/intro\/concepts\/stack\/), and version.\n\nTIP\n\nBy default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](https:\/\/starship.rs\/config\/#with-pulumi-version).\n\nBy default the module will be shown if any of the following conditions are met:\n\n- The current directory contains either `Pulumi.yaml` or `Pulumi.yml`\n- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` unless `search_upwards` is set to `false`\n### Options [](https:\/\/starship.rs\/config\/#options-75)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($username@)$stack]($style) '` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `' '` | A format string shown before the Pulumi stack. |\n| `style` | `'bold 5'` | The style for the module. |\n| `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. |\n| `disabled` | `false` | Disables the `pulumi` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-68)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.12.24` | The version of `pulumi` |\n| stack | `dev` | The current Pulumi stack |\n| username | `alice` | The current Pulumi username |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-62)\n#### With Pulumi Version [](https:\/\/starship.rs\/config\/#with-pulumi-version)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[pulumi]\nformat = '[🛥 ($version )$stack]($style) '\n```\n#### Without Pulumi version [](https:\/\/starship.rs\/config\/#without-pulumi-version)\ntoml\n```\n# ~\/.config\/starship.toml\n[pulumi]\nsymbol = '🛥 '\nformat = '[$symbol$stack]($style) '\n```\n## PureScript [](https:\/\/starship.rs\/config\/#purescript)\nThe `purescript` module shows the currently installed version of [PureScript](https:\/\/www.purescript.org\/) version. By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `spago.dhall` file\n- The current directory contains a `spago.yaml` file\n- The current directory contains a `spago.lock` file\n- The current directory contains a file with the `.purs` extension\n### Options [](https:\/\/starship.rs\/config\/#options-76)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. |\n| `detect_extensions` | `['purs']` | Which extensions should trigger this module. |\n| `detect_files` | `['spago.dhall', 'spago.yaml', 'spago.lock']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold white'` | The style for the module. |\n| `disabled` | `false` | Disables the `purescript` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-69)\n| Variable | Example | Description |\n|---|---|---|\n| version | `0.13.5` | The version of `purescript` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-63)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[purescript]\nformat = 'via [$symbol$version](bold white)'\n```\n## Python [](https:\/\/starship.rs\/config\/#python)\nThe `python` module shows the currently installed version of [Python](https:\/\/www.python.org\/) and the current [Python virtual environment](https:\/\/docs.python.org\/tutorial\/venv.html) if one is activated.\n\nIf `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`.\n\nBy default, the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `.python-version` file\n- The current directory contains a `Pipfile` file\n- The current directory contains a `__init__.py` file\n- The current directory contains a `pyproject.toml` file\n- The current directory contains a `requirements.txt` file\n- The current directory contains a `setup.py` file\n- The current directory contains a `tox.ini` file\n- The current directory contains a file with the `.py` extension.\n- The current directory contains a file with the `.ipynb` extension.\n- A virtual environment is currently activated\n### Options [](https:\/\/starship.rs\/config\/#options-77)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\$$virtualenv\$ )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐍 '` | A format string representing the symbol of Python |\n| `style` | `'yellow bold'` | The style for the module. |\n| `pyenv_version_name` | `false` | Use pyenv to get Python version |\n| `pyenv_prefix` | `'pyenv'` | Prefix before pyenv version display, only used if pyenv is used |\n| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should execute when getting the version. |\n| `detect_extensions` | `['py', 'ipynb']` | Which extensions should trigger this module |\n| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module |\n| `detect_folders` | `[]` | Which folders should trigger this module |\n| `disabled` | `false` | Disables the `python` module. |\n\nTIP\n\nThe `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.\n\nThe default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv\/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `\/usr\/bin\/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below.\n### Variables [](https:\/\/starship.rs\/config\/#variables-70)\n| Variable | Example | Description |\n|---|---|---|\n| version | `'v3.8.1'` | The version of `python` |\n| symbol | `'🐍 '` | Mirrors the value of option `symbol` |\n| style | `'yellow bold'` | Mirrors the value of option `style` |\n| pyenv\\_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` |\n| virtualenv | `'venv'` | The current `virtualenv` name |\n### Example [](https:\/\/starship.rs\/config\/#example-64)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[python]\nsymbol = '👾 '\npyenv_version_name = true\n```\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[python]\n# Only use the `python3` binary to get the version.\npython_binary = 'python3'\n```\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[python]\n# Don't trigger for files with the py extension\ndetect_extensions = []\n```\n## Quarto [](https:\/\/starship.rs\/config\/#quarto)\nThe `quarto` module shows the current installed version of Quarto used in a project.\n\nBy default, the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `_quarto.yml` file\n- The current directory contains any `*.qmd` file\n### Options [](https:\/\/starship.rs\/config\/#options-78)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'⨁ '` | A format string representing the symbol of Quarto |\n| `style` | `'bold #75AADB'` | The style for the module. |\n| `detect_extensions` | `['.qmd']` | Which extensions should trigger this module. |\n| `detect_files` | `['_quarto.yml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `quarto` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-71)\n| Variable | Example | Description |\n|---|---|---|\n| version | `1.4.549` | The version of `quarto` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## R [](https:\/\/starship.rs\/config\/#r)\nThe `rlang` module shows the currently installed version of [R](https:\/\/www.r-project.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with the `.R` extension.\n- The current directory contains a file with the `.Rd` extension.\n- The current directory contains a file with the `.Rmd` extension.\n- The current directory contains a file with the `.Rproj` extension.\n- The current directory contains a file with the `.Rsx` extension.\n- The current directory contains a `.Rprofile` file\n- The current directory contains a `.Rproj.user` folder\n### Options [](https:\/\/starship.rs\/config\/#options-79)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'📐'` | A format string representing the symbol of R. |\n| `style` | `'blue bold'` | The style for the module. |\n| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Which extensions should trigger this module |\n| `detect_files` | `['.Rprofile']` | Which filenames should trigger this module |\n| `detect_folders` | `['.Rproj.user']` | Which folders should trigger this module |\n| `disabled` | `false` | Disables the `r` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-72)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v4.0.5` | The version of `R` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style | `'blue bold'` | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-65)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[rlang]\nformat = 'with [📐 $version](blue bold) '\n```\n## Raku [](https:\/\/starship.rs\/config\/#raku)\nThe `raku` module shows the currently installed version of [Raku](https:\/\/www.raku.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `META6.json` file\n- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`\n### Options [](https:\/\/starship.rs\/config\/#options-80)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku |\n| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Which extensions should trigger this module. |\n| `detect_files` | `['META6.json']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold 149'` | The style for the module. |\n| `disabled` | `false` | Disables the `raku` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-73)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v6.d` | The version of `raku` |\n| vm\\_version | `moar` | The version of VM `raku` is built on |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-66)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[raku]\nformat = 'via [🦪 $version]($style) '\n```\n## Red [](https:\/\/starship.rs\/config\/#red)\nBy default the `red` module shows the currently installed version of [Red](https:\/\/www.red-lang.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with `.red` or `.reds` extension\n### Options [](https:\/\/starship.rs\/config\/#options-81)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🔺 '` | A format string representing the symbol of Red. |\n| `detect_extensions` | `['red']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'red bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `red` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-74)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v2.5.1` | The version of `red` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-67)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[red]\nsymbol = '🔴 '\n```\n## Ruby [](https:\/\/starship.rs\/config\/#ruby)\nBy default the `ruby` module shows the currently installed version of [Ruby](https:\/\/www.ruby-lang.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Gemfile` file\n- The current directory contains a `.ruby-version` file\n- The current directory contains a `.rb` file\n- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set\n\nStarship gets the current Ruby version by running `ruby -v`.\n\n### Options [](https:\/\/starship.rs\/config\/#options-82)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'💎 '` | A format string representing the symbol of Ruby. |\n| `detect_extensions` | `['rb']` | Which extensions should trigger this module. |\n| `detect_files` | `['Gemfile', '.ruby-version']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. |\n| `style` | `'bold red'` | The style for the module. |\n| `disabled` | `false` | Disables the `ruby` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-75)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v2.5.1` | The version of `ruby` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n| gemset | `test` | Optional, gets the current RVM gemset name. |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-68)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[ruby]\nsymbol = '🔺 '\n```\n## Rust [](https:\/\/starship.rs\/config\/#rust)\nBy default the `rust` module shows the currently installed version of [Rust](https:\/\/www.rust-lang.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Cargo.toml` file\n- The current directory contains a file with the `.rs` extension\n### Options [](https:\/\/starship.rs\/config\/#options-83)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🦀 '` | A format string representing the symbol of Rust |\n| `detect_extensions` | `['rs']` | Which extensions should trigger this module. |\n| `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold red'` | The style for the module. |\n| `disabled` | `false` | Disables the `rust` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-76)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v1.43.0-nightly` | The version of `rustc` |\n| numver | `1.51.0` | The numeric component of the `rustc` version |\n| toolchain | `beta` | The toolchain version |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-69)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[rust]\nformat = 'via [⚙️ $version](red bold)'\n```\n## Scala [](https:\/\/starship.rs\/config\/#scala)\nThe `scala` module shows the currently installed version of [Scala](https:\/\/www.scala-lang.org\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file\n- The current directory contains a file with the `.scala` or `.sbt` extension\n- The current directory contains a directory named `.metals`\n### Options [](https:\/\/starship.rs\/config\/#options-84)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [${symbol}(${version} )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `detect_extensions` | `['sbt', 'scala']` | Which extensions should trigger this module. |\n| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Which filenames should trigger this module. |\n| `detect_folders` | `['.metals']` | Which folders should trigger this modules. |\n| `symbol` | `'🆂 '` | A format string representing the symbol of Scala. |\n| `style` | `'red dimmed'` | The style for the module. |\n| `disabled` | `false` | Disables the `scala` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-77)\n| Variable | Example | Description |\n|---|---|---|\n| version | `2.13.5` | The version of `scala` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-70)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[scala]\nsymbol = '🌟 '\n```\n## Shell [](https:\/\/starship.rs\/config\/#shell)\nThe `shell` module shows an indicator for currently used shell.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-85)\n| Option | Default | Description |\n|---|---|---|\n| `bash_indicator` | `'bsh'` | A format string used to represent bash. |\n| `fish_indicator` | `'fsh'` | A format string used to represent fish. |\n| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. |\n| `powershell_indicator` | `'psh'` | A format string used to represent powershell. |\n| `pwsh_indicator` |   | A format string used to represent pwsh. The default value mirrors the value of `powershell_indicator`. |\n| `ion_indicator` | `'ion'` | A format string used to represent ion. |\n| `elvish_indicator` | `'esh'` | A format string used to represent elvish. |\n| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. |\n| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. |\n| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. |\n| `nu_indicator` | `'nu'` | A format string used to represent nu. |\n| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. |\n| `format` | `'[$indicator]($style) '` | The format for the module. |\n| `style` | `'white bold'` | The style for the module. |\n| `disabled` | `true` | Disables the `shell` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-78)\n| Variable | Default | Description |\n|---|---|---|\n| indicator |   | Mirrors the value of `indicator` for currently used shell. |\n| style\\* |   | Mirrors the value of option `style`. |\n\n\\*: This variable can only be used as a part of a style string\n\n### Examples [](https:\/\/starship.rs\/config\/#examples-6)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[shell]\nfish_indicator = '󰈺 '\npowershell_indicator = '_'\nunknown_indicator = 'mystery shell'\nstyle = 'cyan bold'\ndisabled = false\n```\n## SHLVL [](https:\/\/starship.rs\/config\/#shlvl)\nThe `shlvl` module shows the current [`SHLVL`](https:\/\/tldp.org\/LDP\/abs\/html\/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-86)\n| Option | Default | Description |\n|---|---|---|\n| `threshold` | `2` | Display threshold. |\n| `format` | `'[$symbol$shlvl]($style) '` | The format for the module. |\n| `symbol` | `'↕️ '` | The symbol used to represent the `SHLVL`. |\n| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |\n| `repeat_offset` | `0` | Decrements number of times `symbol` is repeated by the offset value |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `true` | Disables the `shlvl` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-79)\n| Variable | Example | Description |\n|---|---|---|\n| shlvl | `3` | The current value of `SHLVL` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-71)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[shlvl]\ndisabled = false\nformat = '$shlvl level(s) down'\nthreshold = 3\n```\n\nUsing `repeat` and `repeat_offset` along with `character` module, one can get prompt like `❯❯❯` where last character is colored appropriately for return status code and preceding characters are provided by `shlvl`.\n\ntoml\n```\n# ~\/.config\/starship.toml\n\n[shlvl]\ndisabled = false\nformat = '[$symbol]($style)'\nrepeat = true\nsymbol = '❯'\nrepeat_offset = 1\n```\n## Singularity [](https:\/\/starship.rs\/config\/#singularity)\nThe `singularity` module shows the current [Singularity](https:\/\/sylabs.io\/singularity\/) image, if inside a container and `$SINGULARITY_NAME` is set.\n\n### Options [](https:\/\/starship.rs\/config\/#options-87)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[$symbol\\[$env\\]]($style) '` | The format for the module. |\n| `symbol` | `''` | A format string displayed before the image name. |\n| `style` | `'bold dimmed blue'` | The style for the module. |\n| `disabled` | `false` | Disables the `singularity` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-80)\n| Variable | Example | Description |\n|---|---|---|\n| env | `centos.img` | The current Singularity image |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-72)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[singularity]\nformat = '[📦 \\[$env\\]]($style) '\n```\n## Solidity [](https:\/\/starship.rs\/config\/#solidity)\nThe `solidity` module shows the currently installed version of [Solidity](https:\/\/soliditylang.org\/) The module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with the `.sol` extension\n### Options [](https:\/\/starship.rs\/config\/#options-88)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${major}.${minor}.${patch}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'S '` | A format string representing the symbol of Solidity |\n| \\`compiler | \\['solc'\\] | The default compiler for Solidity. |\n| `detect_extensions` | `['sol']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold blue'` | The style for the module. |\n| `disabled` | `false` | Disables this module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-81)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.8.1` | The version of `solidity` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-73)\ntoml\n```\n# ~\/.config\/starship.toml\n[solidity]\nformat = \"via [S $version](blue bold)\"\n```\n## Spack [](https:\/\/starship.rs\/config\/#spack)\nThe `spack` module shows the current [Spack](https:\/\/spack.readthedocs.io\/en\/latest\/) environment, if `$SPACK_ENV` is set.\n\n### Options [](https:\/\/starship.rs\/config\/#options-89)\n| Option | Default | Description |\n|---|---|---|\n| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](https:\/\/starship.rs\/config\/#directory) module. |\n| `symbol` | `'🅢 '` | The symbol used before the environment name. |\n| `style` | `'bold blue'` | The style for the module. |\n| `format` | `'via [$symbol$environment]($style) '` | The format for the module. |\n| `disabled` | `false` | Disables the `spack` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-82)\n| Variable | Example | Description |\n|---|---|---|\n| environment | `astronauts` | The current spack environment |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-74)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[spack]\nformat = '[$symbol$environment](dimmed blue) '\n```\n## Status [](https:\/\/starship.rs\/config\/#status)\nThe `status` module displays the exit code of the previous command. If \\$success\\_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-90)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[$symbol$status]($style) '` | The format of the module |\n| `symbol` | `'❌'` | The symbol displayed on program error |\n| `success_symbol` | `''` | The symbol displayed on program success |\n| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable |\n| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found |\n| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) |\n| `signal_symbol` | `'⚡'` | The symbol displayed on any signal |\n| `style` | `'bold red'` | The style for the module. |\n| `success_style` |   | The style used on program success (defaults to `style` if unset). |\n| `failure_style` |   | The style used on program failure (defaults to `style` if unset). |\n| `recognize_signal_code` | `true` | Enable signal mapping from exit code |\n| `map_symbol` | `false` | Enable symbols mapping from exit code |\n| `pipestatus` | `false` | Enable pipestatus reporting |\n| `pipestatus_separator` | `|` | The symbol used to separate pipestatus segments (supports formatting) |\n| `pipestatus_format` | `'\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) '` | The format of the module when the command is a pipeline |\n| `pipestatus_segment_format` |   | When specified, replaces `format` when formatting pipestatus segments |\n| `disabled` | `true` | Disables the `status` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-83)\n| Variable | Example | Description |\n|---|---|---|\n| status | `127` | The exit code of the last command |\n| hex\\_status | `0x7F` | The exit code of the last command in hex |\n| int | `127` | The exit code of the last command |\n| common\\_meaning | `ERROR` | Meaning of the code if not a signal |\n| signal\\_number | `9` | Signal number corresponding to the exit code, only if signalled |\n| signal\\_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |\n| maybe\\_int | `7` | Contains the exit code number when no meaning has been found |\n| pipestatus |   | Rendering of in pipeline programs' exit codes, this is only available in pipestatus\\_format |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `success_style` on program success and `failure_style` otherwise |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-75)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[status]\nstyle = 'bg:blue'\nsymbol = '🔴 '\nsuccess_symbol = '🟢 SUCCESS'\nformat = '[\\[$symbol$common_meaning$signal_name$maybe_int\\]]($style) '\nmap_symbol = true\ndisabled = false\n```\n## Sudo [](https:\/\/starship.rs\/config\/#sudo)\nThe `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-91)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'[as $symbol]($style)'` | The format of the module |\n| `symbol` | `'🧙 '` | The symbol displayed when credentials are cached |\n| `style` | `'bold blue'` | The style for the module. |\n| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |\n| `disabled` | `true` | Disables the `sudo` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-84)\n| Variable | Example | Description |\n|---|---|---|\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-76)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[sudo]\nstyle = 'bold green'\nsymbol = '👩‍💻 '\ndisabled = false\n```\n\ntoml\n```\n# On windows\n# $HOME\\.starship\\config.toml\n\n[sudo]\nallow_windows = true\ndisabled = false\n```\n## Swift [](https:\/\/starship.rs\/config\/#swift)\nBy default the `swift` module shows the currently installed version of [Swift](https:\/\/swift.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Package.swift` file\n- The current directory contains a file with the `.swift` extension\n### Options [](https:\/\/starship.rs\/config\/#options-92)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'🐦 '` | A format string representing the symbol of Swift |\n| `detect_extensions` | `['swift']` | Which extensions should trigger this module. |\n| `detect_files` | `['Package.swift']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'bold 202'` | The style for the module. |\n| `disabled` | `false` | Disables the `swift` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-85)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v5.2.4` | The version of `swift` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-77)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[swift]\nformat = 'via [🏎  $version](red bold)'\n```\n## Terraform [](https:\/\/starship.rs\/config\/#terraform)\nThe `terraform` module shows the currently selected [Terraform workspace](https:\/\/www.terraform.io\/docs\/language\/state\/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection.\n\nTIP\n\nBy default the Terraform\/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](https:\/\/starship.rs\/config\/#with-terraform-version).\n\nBy default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `.terraform` folder\n- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions\n### Options [](https:\/\/starship.rs\/config\/#options-93)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'💠'` | A format string shown before the terraform workspace. |\n| `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `['.terraform']` | Which folders should trigger this module. |\n| `style` | `'bold 105'` | The style for the module. |\n| `disabled` | `false` | Disables the `terraform` module. |\n| `commands` | `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` | How to detect what the Terraform version is. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-86)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.12.24` | The version of `terraform` |\n| workspace | `default` | The current Terraform workspace |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-78)\n#### With Terraform Version [](https:\/\/starship.rs\/config\/#with-terraform-version)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[terraform]\nformat = 'via [$symbol$version $workspace]($style) '\n```\n#### Without Terraform version [](https:\/\/starship.rs\/config\/#without-terraform-version)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[terraform]\nformat = 'via [$symbol$workspace]($style) '\n```\n## Time [](https:\/\/starship.rs\/config\/#time)\nThe `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https:\/\/crates.io\/crates\/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https:\/\/docs.rs\/chrono\/0.4.7\/chrono\/format\/strftime\/index.html) to see what options are available.\n\nTIP\n\nThis module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.\n### Options [](https:\/\/starship.rs\/config\/#options-94)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'at [$time]($style) '` | The format string for the module. |\n| `use_12hr` | `false` | Enables 12 hour formatting |\n| `time_format` | see below | The [chrono format string](https:\/\/docs.rs\/chrono\/0.4.7\/chrono\/format\/strftime\/index.html) used to format the time. |\n| `style` | `'bold yellow'` | The style for the module time |\n| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 \\< x \\< 24. Allows floats to accommodate 30\/45 minute timezone offsets. |\n| `disabled` | `true` | Disables the `time` module. |\n| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |\n\nIf `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting.\n\n### Variables [](https:\/\/starship.rs\/config\/#variables-87)\n| Variable | Example | Description |\n|---|---|---|\n| time | `13:08:10` | The current time. |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-79)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[time]\ndisabled = false\nformat = '🕙[\\[ $time \\]]($style) '\ntime_format = '%T'\nutc_time_offset = '-5'\ntime_range = '10:00:00-14:00:00'\n```\n## Typst [](https:\/\/starship.rs\/config\/#typst)\nThe `typst` module shows the current installed version of Typst used in a project.\n\nBy default, the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `template.typ` file\n- The current directory contains any `*.typ` file\n### Options [](https:\/\/starship.rs\/config\/#options-95)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'t '` | A format string representing the symbol of Typst |\n| `style` | `'bold #0093A7'` | The style for the module. |\n| `detect_extensions` | `['.typ']` | Which extensions should trigger this module. |\n| `detect_files` | `['template.typ']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `disabled` | `false` | Disables the `typst` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-88)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.9.0` | The version of `typst`, alias for typst\\_version |\n| typst\\_version | `default` | The current Typst version |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Username [](https:\/\/starship.rs\/config\/#username)\nThe `username` module shows active user's username. The module will be shown if any of the following conditions are met:\n\n- The current user is root\/admin\n- The current user isn't the same as the one that is logged in\n- The user is currently connected as an SSH session\n- The variable `show_always` is set to true\n- The array `detect_env_vars` contains at least the name of one environment variable, that is set\n\nTIP\n\nSSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.\n### Options [](https:\/\/starship.rs\/config\/#options-96)\n| Option | Default | Description |\n|---|---|---|\n| `style_root` | `'bold red'` | The style used when the user is root\/admin. |\n| `style_user` | `'bold yellow'` | The style used for non-root users. |\n| `detect_env_vars` | `[]` | Which environment variable(s) should trigger this module. |\n| `format` | `'[$user]($style) in '` | The format for the module. |\n| `show_always` | `false` | Always shows the `username` module. |\n| `disabled` | `false` | Disables the `username` module. |\n| `aliases` | `{}` | Translate system usernames to something else. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-89)\n| Variable | Example | Description |\n|---|---|---|\n| `style` | `'red bold'` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |\n| `user` | `'matchai'` | The currently logged-in user ID. |\n### Example [](https:\/\/starship.rs\/config\/#example-80)\n#### Always show the username [](https:\/\/starship.rs\/config\/#always-show-the-username)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[username]\nstyle_user = 'white bold'\nstyle_root = 'black bold'\nformat = 'user: [$user]($style) '\ndisabled = false\nshow_always = true\naliases = { \"corpuser034g\" = \"matchai\" }\n```\n## Vagrant [](https:\/\/starship.rs\/config\/#vagrant)\nThe `vagrant` module shows the currently installed version of [Vagrant](https:\/\/www.vagrantup.com\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a `Vagrantfile` file\n### Options [](https:\/\/starship.rs\/config\/#options-97)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'⍱ '` | A format string representing the symbol of Vagrant. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module. |\n| `detect_files` | `['Vagrantfile']` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'cyan bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `vagrant` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-90)\n| Variable | Example | Description |\n|---|---|---|\n| version | `Vagrant 2.2.10` | The version of `Vagrant` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-81)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[vagrant]\nformat = 'via [⍱ $version](bold white) '\n```\n## V [](https:\/\/starship.rs\/config\/#v)\nThe `vlang` module shows you your currently installed version of [V](https:\/\/vlang.io\/). By default the module will be shown if any of the following conditions are met:\n\n- The current directory contains a file with `.v` extension\n- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file\n### Options [](https:\/\/starship.rs\/config\/#options-98)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'V '` | A format string representing the symbol of V |\n| `detect_extensions` | `['v']` | Which extensions should trigger this module. |\n| `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n| `style` | `'blue bold'` | The style for the module. |\n| `disabled` | `false` | Disables the `vlang` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-91)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.2` | The version of `v` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n### Example [](https:\/\/starship.rs\/config\/#example-82)\ntoml\n```\n# ~\/.config\/starship.toml\n[vlang]\nformat = 'via [V $version](blue bold) '\n```\n## VCSH [](https:\/\/starship.rs\/config\/#vcsh)\nThe `vcsh` module displays the current active [VCSH](https:\/\/github.com\/RichiH\/vcsh) repository. The module will be shown only if a repository is currently in use.\n\n### Options [](https:\/\/starship.rs\/config\/#options-99)\n| Option | Default | Description |\n|---|---|---|\n| `symbol` | `''` | The symbol used before displaying the repository name. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `format` | `'vcsh [$symbol$repo]($style) '` | The format for the module. |\n| `disabled` | `false` | Disables the `vcsh` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-92)\n| Variable | Example | Description |\n|---|---|---|\n| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* | `black bold dimmed` | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-83)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[vcsh]\nformat = '[🆅 $repo](bold blue) '\n```\n## XMake [](https:\/\/starship.rs\/config\/#xmake)\nThe `xmake` module shows the currently installed version of [XMake](https:\/\/xmake.io\/). By default the module will be activated if any of the following conditions are met:\n\n- The current directory contains a `xmake.lua` file\n### Options [](https:\/\/starship.rs\/config\/#options-100)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'△ '` | The symbol used before the version of cmake. |\n| `detect_extensions` | `[]` | Which extensions should trigger this module |\n| `detect_files` | `['xmake.lua']` | Which filenames should trigger this module |\n| `detect_folders` | `[]` | Which folders should trigger this module |\n| `style` | `'bold green'` | The style for the module. |\n| `disabled` | `false` | Disables the `xmake` module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-93)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v2.9.5` | The version of xmake |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n## Zig [](https:\/\/starship.rs\/config\/#zig)\nBy default the `zig` module shows the currently installed version of [Zig](https:\/\/ziglang.org\/). The module will be shown if any of the following conditions are met:\n\n- The current directory contains a `.zig` file\n### Options [](https:\/\/starship.rs\/config\/#options-101)\n| Option | Default | Description |\n|---|---|---|\n| `format` | `'via [$symbol($version )]($style)'` | The format for the module. |\n| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |\n| `symbol` | `'↯ '` | The symbol used before displaying the version of Zig. |\n| `style` | `'bold yellow'` | The style for the module. |\n| `disabled` | `false` | Disables the `zig` module. |\n| `detect_extensions` | `['zig']` | Which extensions should trigger this module. |\n| `detect_files` | `[]` | Which filenames should trigger this module. |\n| `detect_folders` | `[]` | Which folders should trigger this module. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-94)\n| Variable | Example | Description |\n|---|---|---|\n| version | `v0.6.0` | The version of `zig` |\n| symbol |   | Mirrors the value of option `symbol` |\n| style\\* |   | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n### Example [](https:\/\/starship.rs\/config\/#example-84)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[zig]\nsymbol = '⚡️ '\n```\n## Custom commands [](https:\/\/starship.rs\/config\/#custom-commands)\nThe `custom` modules show the output of some arbitrary commands.\n\nThese modules will be shown if any of the following conditions are met:\n\n- The current directory contains a file whose name is in `detect_files`\n- The current directory contains a directory whose name is in `detect_folders`\n- The current directory contains a file whose extension is in `detect_extensions`\n- The `when` command returns 0\n- The current Operating System (std::env::consts::OS) matches with `os` field if defined.\n\nTIP\n\nMultiple custom modules can be defined by using a `.`.\n\nTIP\n\nThe order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined.\n\nTIP\n\n[Issue \\#1252](https:\/\/github.com\/starship\/starship\/discussions\/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there\\!\n\nWARNING\n\nIf `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt.\n\nWhatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\\h`, but this module will not work in a fish or zsh shell.\n\nFormat strings can also contain shell specific prompt sequences, e.g. [Bash](https:\/\/www.gnu.org\/software\/bash\/manual\/html_node\/Controlling-the-Prompt.html), [Zsh](https:\/\/zsh.sourceforge.io\/Doc\/Release\/Prompt-Expansion.html).\n### Options [](https:\/\/starship.rs\/config\/#options-102)\n| Option | Default | Description |\n|---|---|---|\n| `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. |\n| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the `shell` returns a `0` status code from executing it. |\n| `require_repo` | `false` | If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. |\n| `shell` |   | [See below](https:\/\/starship.rs\/config\/#custom-command-shell) |\n| `description` | `'<custom module>'` | The description of the module that is shown when running `starship explain`. |\n| `unsafe_no_escape` | `false` | When set, command output is not escaped of characters that could be interpreted by the shell. |\n| `detect_files` | `[]` | The files that will be searched in the working directory for a match. |\n| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |\n| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |\n| `symbol` | `''` | The symbol used before displaying the command output. |\n| `style` | `'bold green'` | The style for the module. |\n| `format` | `'[$symbol($output )]($style)'` | The format for the module. |\n| `disabled` | `false` | Disables this `custom` module. |\n| `os` |   | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https:\/\/doc.rust-lang.org\/std\/env\/consts\/constant.OS.html). |\n| `use_stdin` |   | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. |\n| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. |\n### Variables [](https:\/\/starship.rs\/config\/#variables-95)\n| Variable | Description |\n|---|---|\n| output | The output of `command` run in `shell` |\n| symbol | Mirrors the value of option `symbol` |\n| style\\* | Mirrors the value of option `style` |\n\n\\*: This variable can only be used as a part of a style string\n\n#### Custom command shell [](https:\/\/starship.rs\/config\/#custom-command-shell)\n`shell` accepts a non-empty list of strings, where:\n\n- The first string is the path to the shell to use to execute the command.\n- Other following arguments are passed to the shell.\n\nIf unset, it will fallback to STARSHIP\\_SHELL and then to 'sh' on Linux, and 'cmd \/C' on Windows.\n\nThe `command` (and `when`, if applicable) will be passed in on stdin.\n\nIf `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `\/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g.\n\ntoml\n```\nshell = ['pwsh', '-Command', '-']\n```\n\nWARNING\n\nMake sure your custom shell configuration exits gracefully\n\nIf you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option).\n\nFor example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.\n\nParameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.\n\nAutomatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https:\/\/github.com\/starship\/starship\/issues\/new\/choose) with shell details and starship configuration if you hit such scenario.\n### Example [](https:\/\/starship.rs\/config\/#example-85)\ntoml\n```\n# ~\/.config\/starship.toml\n\n[custom.foo]\ncommand = 'echo foo' # shows output of command\ndetect_files = ['foo'] # can specify filters but wildcards are not supported\nwhen = ''' test \"$HOME\" = \"$PWD\" '''\nformat = ' transcending [$output]($style)'\n\n[custom.time]\ncommand = 'time \/T'\ndetect_extensions = ['pst'] # filters *.pst files\nshell = ['pwsh.exe', '-NoProfile', '-Command', '-']\n\n[custom.time-as-arg]\ncommand = 'time \/T'\ndetect_extensions = ['pst'] # filters *.pst files\nshell = ['pwsh.exe', '-NoProfile', '-Command']\nuse_stdin = false\n```","meta_canonical":null}

3. Robots.txt Check

Query:

Response:

4. Spam/Ban Check

Query:

Response:

5. Seen Status Check

ℹ️ Skipped - page is already crawled

📄

INDEXABLE

✅

CRAWLED

1 hour ago

🤖

ROBOTS ALLOWED

Page Info Filters

Filter	Status	Condition	Details
HTTP status	PASS	`download_http_code = 200`	HTTP 200
Age cutoff	PASS	`download_stamp > now() - 6 MONTH`	0 months ago
History drop	PASS	`isNull(history_drop_reason)`	No drop reason
Spam/ban	PASS	`fh_dont_index != 1 AND ml_spam_score = 0`	ml_spam_score=0
Canonical	PASS	`meta_canonical IS NULL OR = '' OR = src_unparsed`	Not set

Page Details

Property	Value
URL	https://starship.rs/config/
Last Crawled	2026-04-09 21:59:10 (1 hour ago)
First Indexed	2019-07-23 00:09:06 (6 years ago)
HTTP Status Code	200
Meta Title	Configuration \| Starship
Meta Description	The minimal, blazing-fast, and infinitely customizable prompt for any shell!
Meta Canonical	null
Boilerpipe Text	Configuration To get started configuring starship, create the following file: ~/.config/starship.toml . sh mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this TOML file: toml # Get editor completions based on the config schema "$schema" = 'https://starship.rs/config-schema.json' # Inserts a blank line between shell prompts add_newline = true # Replace the '❯' symbol in the prompt with '➜' [ character ] # The name of the module we are configuring is 'character' success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green' # Disable the package module, hiding it from the prompt completely [ package ] disabled = true Config File Location You can change default configuration file location with STARSHIP_CONFIG environment variable: sh export STARSHIP_CONFIG =~ /example/non/default/path/starship.toml Equivalently in PowerShell (Windows) would be adding this line to your $PROFILE : powershell $ ENV: STARSHIP_CONFIG = " $HOME \example\non\default\path\starship.toml" Or for Cmd (Windows) would be adding this line to your starship.lua : lua os. setenv ( 'STARSHIP_CONFIG' , 'C: \\ Users \\ user \\ example \\ non \\ default \\ path \\ starship.toml' ) Logging By default starship logs warnings and errors into a file named ~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log , where the session key is corresponding to an instance of your terminal. This, however can be changed using the STARSHIP_CACHE environment variable: sh export STARSHIP_CACHE =~ /.starship/cache Equivalently in PowerShell (Windows) would be adding this line to your $PROFILE : powershell $ ENV: STARSHIP_CACHE = " $HOME \AppData\Local\Temp" Or for Cmd (Windows) would be adding this line to your starship.lua : lua os. setenv ( 'STARSHIP_CACHE' , 'C: \\ Users \\ user \\ AppData \\ Local \\ Temp' ) Terminology Module : A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. Variable : Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. via in "nodejs") and an empty space as a suffix. Strings In TOML syntax, text values are declared with ' , " , ''' , or """ . The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: $ [ ] ( ) . Symbol Type Notes ' literal string less escaping " string more escaping ''' multi-line literal string less escaping """ multi-line string more escaping, newlines in declarations can be ignored For example: toml # literal string format = '☺\☻ ' # regular string format = "☺ \\ ☻ " # escaping Starship symbols format = '\[\$\] ' When using line breaks, multi-line declarations can be used. For example, if you want to print a $ symbol on a new line, the following values for format are equivalent: toml # with literal string format = ''' \$''' # with multiline basic string format = """ \\ $""" # with basic string format = " \n\\ $" In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them. toml format = """ line1\ line1\ line1 line2\ line2\ line2 """ Format Strings Format strings are the format that a module prints all its variables with. Most modules have an entry called format that configures the display format of the module. You can use texts, variables and text groups in a format string. Variable A variable contains a $ symbol followed by the name of the variable. The name of a variable can only contain letters, numbers and _ . For example: '$version' is a format string with a variable named version . '$git_branch$git_commit' is a format string with two variables named git_branch and git_commit . '$git_branch $git_commit' has the two variables separated with a space. Text Group A text group is made up of two different parts. The first part, which is enclosed in a [] , is a format string . You can add texts, variables, or even nested text groups in it. In the second part, which is enclosed in a () , is a style string . This can be used to style the first part. For example: '[on](red bold)' will print a string on with bold text colored red. '[⌘ $version](bold green)' will print a symbol ⌘ followed by the content of variable version , with bold text colored green. '[a [b](red) c](green)' will print a b c with b red, and a and c green. Style Strings Most modules in starship allow you to configure their display styles. This is done with an entry (usually called style ) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the advanced config guide . 'fg:green bg:blue' sets green text on a blue background 'bg:blue fg:bright-green' sets bright green text on a blue background 'bold fg:27' sets bold text with ANSI color 27 'underline bg:#bf5700' sets underlined text on a burnt orange background 'bold italic fg:purple' sets bold italic purple text '' explicitly disables all styling Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics. Conditional Format Strings A conditional format string wrapped in ( and ) will not render if all variables inside are empty. For example: '(@$region)' will show nothing if the variable region is None or empty string, otherwise @ followed by the value of region. '(some text)' will always show nothing since there are no variables wrapped in the braces. When $combined is a shortcut for \[$a$b\] , '($combined)' will show nothing only if $a and $b are both None . This works the same as '(\[$a$b\] )' . Negative matching Many modules have detect_extensions , detect_files , and detect_folders variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of any negative indicator in the directory will result in the module not being matched. Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, foo.bar.tar.gz will be matched against bar.tar.gz and gz in the detect_extensions variable. Files whose name begins with a dot are not considered to have extensions at all. To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus: toml detect_extensions = [ 'ts' , '!video.ts' , '!audio.ts' ] This is the list of prompt-wide configuration options. Options Option Default Description format link Configure the format of the prompt. right_format '' See Enable Right Prompt scan_timeout 30 Timeout for starship to scan files (in milliseconds). command_timeout 500 Timeout for commands executed by starship (in milliseconds). add_newline true Inserts blank line between shell prompts. palette '' Sets which color palette from palettes to use. palettes {} Collection of color palettes that assign colors to user-defined names. Note that color palettes cannot reference their own color definitions. follow_symlinks true Follows symlinks to check if they're directories; used in modules such as git. TIP If you have symlinks to networked filesystems, consider setting follow_symlinks to false . Example toml # ~/.config/starship.toml # Use custom format format = ''' [┌───────────────────>](bold green) [│](bold green)$directory$rust$package [└─>](bold green) ''' # Wait 10 milliseconds for starship to check files under the current directory. scan_timeout = 10 # Disable the blank line at the start of the prompt add_newline = false # Set 'foo' as custom color palette palette = 'foo' # Define custom colors [ palettes . foo ] # Overwrite existing color blue = '21' # Define new color mustard = '#af8700' Default Prompt Format The default format is used to define the format of the prompt, if empty or no format is provided. The default is as shown: toml format = '$all' # Which is equivalent to format = """ $username\ $hostname\ $localip\ $shlvl\ $singularity\ $kubernetes\ $directory\ $vcsh\ $fossil_branch\ $fossil_metrics\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ $hg_state\ $pijul_channel\ $docker_context\ $package\ $c\ $cmake\ $cobol\ $daml\ $dart\ $deno\ $dotnet\ $elixir\ $elm\ $erlang\ $fennel\ $fortran\ $gleam\ $golang\ $guix_shell\ $haskell\ $haxe\ $helm\ $java\ $julia\ $kotlin\ $gradle\ $lua\ $nim\ $nodejs\ $ocaml\ $opa\ $perl\ $php\ $pulumi\ $purescript\ $python\ $quarto\ $raku\ $rlang\ $red\ $ruby\ $rust\ $scala\ $solidity\ $swift\ $terraform\ $typst\ $vlang\ $vagrant\ $zig\ $buf\ $nix_shell\ $conda\ $meson\ $spack\ $memory_usage\ $aws\ $gcloud\ $openstack\ $azure\ $nats\ $direnv\ $env_var\ $mise\ $crystal\ $custom\ $sudo\ $cmd_duration\ $line_break\ $jobs\ $battery\ $time\ $status\ $os\ $container\ $netns\ $shell\ $character""" If you just want to extend the default format, you can use $all ; modules you explicitly add to the format will not be duplicated. Eg. toml # Move the directory to the second line format = '$all$directory$character' AWS The aws module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the AWS_REGION , AWS_DEFAULT_REGION , and AWS_PROFILE env vars and the ~/.aws/config and ~/.aws/credentials files as required. The module will display a profile only if its credentials are present in ~/.aws/credentials or if a credential_process , sso_start_url , or sso_session are defined in ~/.aws/config . Alternatively, having any of the AWS_ACCESS_KEY_ID , AWS_SECRET_ACCESS_KEY , or AWS_SESSION_TOKEN env vars defined will also suffice. If the option force_display is set to true , all available information will be displayed even if no credentials per the conditions above are detected. When using aws-vault the profile is read from the AWS_VAULT env var and the credentials expiration date is read from the AWS_SESSION_EXPIRATION env var. When using awsu the profile is read from the AWSU_PROFILE env var. When using AWSume the profile is read from the AWSUME_PROFILE env var and the credentials expiration date is read from the AWSUME_EXPIRATION env var. When using saml2aws the expiration information obtained from ~/.aws/credentials falls back to the x_security_token_expires key. When using aws-sso-cli the profile is read from the AWS_SSO_PROFILE env var. Options Option Default Description format 'on [$symbol($profile )($$region$ )(\[$duration\] )]($style)' The format for the module. symbol '☁️ ' The symbol used before displaying the current AWS profile. region_aliases {} Table of region aliases to display in addition to the AWS name. profile_aliases {} Table of profile aliases to display in addition to the AWS name. style 'bold yellow' The style for the module. expiration_symbol 'X' The symbol displayed when the temporary credentials have expired. disabled false Disables the AWS module. force_display false If true displays info even if credentials , credential_process or sso_start_url have not been setup. Variables Variable Example Description region ap-northeast-1 The current AWS region profile astronauts The current AWS profile duration 2h27m20s The temporary credentials validity duration symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string Examples Display everything toml # ~/.config/starship.toml [ aws ] format = 'on [$symbol($profile )($$region$ )]($style)' style = 'bold blue' symbol = '🅰 ' [ aws . region_aliases ] ap-southeast-2 = 'au' us-east-1 = 'va' [ aws . profile_aliases ] CompanyGroupFrobozzOnCallAccess = 'Frobozz' Display region toml # ~/.config/starship.toml [ aws ] format = 'on [$symbol$region]($style) ' style = 'bold blue' symbol = '🅰 ' [ aws . region_aliases ] ap-southeast-2 = 'au' us-east-1 = 'va' Display profile toml # ~/.config/starship.toml [ aws ] format = 'on [$symbol$profile]($style) ' style = 'bold blue' symbol = '🅰 ' [ aws . profile_aliases ] Enterprise_Naming_Scheme-voidstars = 'void' Azure The azure module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the ~/.azure/azureProfile.json file. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Variable Default Description format 'on [$symbol($subscription)]($style) ' The format for the Azure module to render. symbol '󰠅 ' The symbol used in the format. style 'blue bold' The style used in the format. disabled true Disables the azure module. subscription_aliases {} Table of subscription name aliases to display in addition to Azure subscription name. Examples Display Subscription Name toml # ~/.config/starship.toml [ azure ] disabled = false format = 'on [$symbol($subscription)]($style) ' symbol = '󰠅 ' style = 'blue bold' Display Username toml # ~/.config/starship.toml [ azure ] disabled = false format = "on [$symbol($username)]($style) " symbol = "󰠅 " style = "blue bold" Display Subscription Name Alias toml # ~/.config/starship.toml [ azure . subscription_aliases ] very-long-subscription-name = 'vlsn' Battery The battery module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. Options Option Default Description full_symbol '󰁹 ' The symbol shown when the battery is full. charging_symbol '󰂄 ' The symbol shown when the battery is charging. discharging_symbol '󰂃 ' The symbol shown when the battery is discharging. unknown_symbol '󰁽 ' The symbol shown when the battery state is unknown. empty_symbol '󰂎 ' The symbol shown when the battery state is empty. format '[$symbol$percentage]($style) ' The format for the module. display link Display threshold and style for the module. disabled false Disables the battery module. Example toml # ~/.config/starship.toml [ battery ] full_symbol = '🔋 ' charging_symbol = '⚡️ ' discharging_symbol = '💀 ' Battery Display The display configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no display is provided. The default is as shown: toml [[ battery . display ]] threshold = 10 style = 'bold red' The default value for the charging_symbol and discharging_symbol option is respectively the value of battery 's charging_symbol and discharging_symbol option. Options The display option is an array of the following table. Option Default Description threshold 10 The upper bound for the display option. style 'red bold' The style used if the display option is in use. charging_symbol Optional symbol displayed if display option is in use, defaults to battery's charging_symbol option. discharging_symbol Optional symbol displayed if display option is in use, defaults to battery's discharging_symbol option. Example toml [[ battery . display ]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10% threshold = 10 style = 'bold red' [[ battery . display ]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30% threshold = 30 style = 'bold yellow' discharging_symbol = '💦 ' # when capacity is over 30%, the battery indicator will not be displayed Buf The buf module shows the currently installed version of Buf . By default, the module is shown if the current directory contains a buf.yaml , buf.gen.yaml , or buf.work.yaml configuration file. Options Option Default Description format 'with [$symbol($version )]($style)' The format for the buf module. version_format 'v${raw}' The version format. symbol '🐃 ' The symbol used before displaying the version of Buf. detect_extensions [] Which extensions should trigger this module. detect_files ['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this modules. style 'bold blue' The style for the module. disabled false Disables the elixir module. Variables Variable Example Description version v1.0.0 The version of buf symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ buf ] symbol = '🦬 ' Bun The bun module shows the currently installed version of the bun JavaScript runtime. By default the module will be shown if any of the following conditions are met: The current directory contains a bun.lock file The current directory contains a bun.lockb file The current directory contains a bunfig.toml file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🥟 ' A format string representing the symbol of Bun. detect_extensions [] Which extensions should trigger this module. detect_files ['bun.lock', 'bun.lockb', 'bunfig.toml'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'bold red' The style for the module. disabled false Disables the bun module. Variables Variable Example Description version v0.1.4 The version of bun symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example Customize the format toml # ~/.config/starship.toml [ bun ] format = 'via [🍔 $version](bold green) ' C The c module shows some information about your C compiler. By default the module will be shown if the current directory contains a .c or .h file. Options Option Default Description format 'via [$symbol($version(-$name) )]($style)' The format string for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol 'C ' The symbol used before displaying the compiler details detect_extensions ['c', 'h'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. commands [ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ] How to detect what the compiler is style 'bold 149' The style for the module. disabled false Disables the c module. Variables Variable Example Description name clang The name of the compiler version 13.0.0 The version of the compiler symbol Mirrors the value of option symbol style Mirrors the value of option style Commands The commands option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like ['mycc', '--version'] . Starship will try executing each command until it gets a result on STDOUT. If a C compiler is not supported by this module, you can request it by raising an issue on GitHub . Example toml # ~/.config/starship.toml [ c ] format = 'via [$name $version]($style)' CPP The cpp module shows some information about your C++ compiler. By default, the module will be shown if the current directory contains a .cpp , .hpp , or other C++ -related files. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description format 'via [$symbol($version(-$name) )]($style)' The format string for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol 'C++ ' The symbol used before displaying the compiler details detect_extensions ['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. commands [ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ] How to detect what the compiler is style 'bold 149' The style for the module. disabled true Disables the cpp module. Variables Variable Example Description name clang++ The name of the compiler version 13.0.0 The version of the compiler symbol Mirrors the value of option symbol style Mirrors the value of option style Commands The commands option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like ['mycpp', '--version'] . Starship will try executing each command until it gets a result on STDOUT. If a C++ compiler is not supported by this module, you can request it by raising an issue on GitHub . Example toml # ~/.config/starship.toml [ cpp ] disabled = false format = 'via [$name $version]($style)' Character The character module shows a character (usually an arrow) beside where the text is entered in your terminal. The character will tell you whether the last command was successful or not. It can do this in two ways: changing color ( red / green ) changing shape ( ❯ / ✖ ) By default it only changes color. If you also want to change its shape take a look at this example . WARNING vimcmd_symbol is only supported in cmd, fish and zsh. vimcmd_replace_one_symbol , vimcmd_replace_symbol , and vimcmd_visual_symbol are only supported in fish due to upstream issues with mode detection in zsh . Options Option Default Description format '$symbol ' The format string used before the text input. success_symbol '[❯](bold green)' The format string used before the text input if the previous command succeeded. error_symbol '[❯](bold red)' The format string used before the text input if the previous command failed. vimcmd_symbol '[❮](bold green)' The format string used before the text input if the shell is in vim normal mode. vimcmd_replace_one_symbol '[❮](bold purple)' The format string used before the text input if the shell is in vim replace_one mode. vimcmd_replace_symbol '[❮](bold purple)' The format string used before the text input if the shell is in vim replace mode. vimcmd_visual_symbol '[❮](bold yellow)' The format string used before the text input if the shell is in vim visual mode. disabled false Disables the character module. Variables Variable Example Description symbol A mirror of either success_symbol , error_symbol , vimcmd_symbol or vimcmd_replace_one_symbol etc. Examples With custom error shape toml # ~/.config/starship.toml [ character ] success_symbol = '[➜](bold green) ' error_symbol = '[✗](bold red) ' Without custom error shape toml # ~/.config/starship.toml [ character ] success_symbol = '[➜](bold green) ' error_symbol = '[➜](bold red) ' With custom vim shape toml # ~/.config/starship.toml [ character ] vimcmd_symbol = '[V](bold green) ' CMake The cmake module shows the currently installed version of CMake . By default the module will be activated if any of the following conditions are met: The current directory contains a CMakeLists.txt file The current directory contains a CMakeCache.txt file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '△ ' The symbol used before the version of cmake. detect_extensions [] Which extensions should trigger this module detect_files ['CMakeLists.txt', 'CMakeCache.txt'] Which filenames should trigger this module detect_folders [] Which folders should trigger this module style 'bold blue' The style for the module. disabled false Disables the cmake module. Variables Variable Example Description version v3.17.3 The version of cmake symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string COBOL / GNUCOBOL The cobol module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met: The current directory contains any files ending in .cob or .COB The current directory contains any files ending in .cbl or .CBL Options Option Default Description symbol '⚙️ ' The symbol used before displaying the version of COBOL. format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch style 'bold blue' The style for the module. detect_extensions ['cbl', 'cob', 'CBL', 'COB'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. disabled false Disables the cobol module. Variables Variable Example Description version v3.1.2.0 The version of cobol symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Command Duration The cmd_duration module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the min_time config value, if it exists. WARNING Do not hook the DEBUG trap in Bash If you are running Starship in bash , do not hook the DEBUG trap after running eval $(starship init $0) , or this module will break. Bash users who need preexec-like functionality can use rcaloras's bash_preexec framework . Simply define the arrays preexec_functions and precmd_functions before running eval $(starship init $0) , and then proceed as normal. Options Option Default Description min_time 2_000 Shortest duration to show time for (in milliseconds). show_milliseconds false Show milliseconds in addition to seconds for the duration. format 'took [$duration]($style) ' The format for the module. style 'bold yellow' The style for the module. disabled false Disables the cmd_duration module. show_notifications false Show desktop notifications when command completes. min_time_to_notify 45_000 Shortest duration for notification (in milliseconds). notification_timeout Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. Variables Variable Example Description duration 16m40s The time it took to execute the command style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ cmd_duration ] min_time = 500 format = 'underwent [$duration](bold yellow)' Conda The conda module shows the current Conda environment, if $CONDA_DEFAULT_ENV is set. TIP This does not suppress conda's own prompt modifier, you may want to run conda config --set changeps1 False . If you use pixi , you can disable pixi's prompt modifier by running pixi config set shell.change-ps1 false . Options Option Default Description truncation_length 1 The number of directories the environment path should be truncated to, if the environment was created via conda create -p [path] . 0 means no truncation. Also see the directory module. symbol '🅒 ' The symbol used before the environment name. style 'bold green' The style for the module. format 'via [$symbol$environment]($style) ' The format for the module. ignore_base true Ignores base environment when activated. detect_env_vars ["!PIXI_ENVIRONMENT_NAME"] Which environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default. disabled false Disables the conda module. Variables Variable Example Description environment astronauts The current conda environment symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ conda ] format = '[$symbol$environment](dimmed green) ' Container The container module displays a symbol and container name, if inside a container. Options Option Default Description symbol '⬢' The symbol shown, when inside a container style 'bold red dimmed' The style for the module. format '[$symbol \[$name\]]($style) ' The format for the module. disabled false Disables the container module. Variables Variable Example Description name fedora-toolbox:35 The name of the container symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ container ] format = '[$symbol \[$name\]]($style) ' Crystal The crystal module shows the currently installed version of Crystal . By default the module will be shown if any of the following conditions are met: The current directory contains a shard.yml file The current directory contains a .cr file Options Option Default Description symbol '🔮 ' The symbol used before displaying the version of crystal. format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch style 'bold red' The style for the module. detect_extensions ['cr'] Which extensions should trigger this module. detect_files ['shard.yml'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. disabled false Disables the crystal module. Variables Variable Example Description version v0.32.1 The version of crystal symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ crystal ] format = 'via [✨ $version](bold blue) ' Daml The daml module shows the currently used Daml SDK version when you are in the root directory of your Daml project. The sdk-version in the daml.yaml file will be used, unless it's overridden by the DAML_SDK_VERSION environment variable. By default the module will be shown if any of the following conditions are met: The current directory contains a daml.yaml file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol 'Λ ' A format string representing the symbol of Daml style 'bold cyan' The style for the module. detect_extensions [] Which extensions should trigger this module. detect_files ['daml.yaml'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. disabled false Disables the daml module. Variables Variable Example Description version v2.2.0 The version of daml symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ daml ] format = 'via [D $version](bold bright-green) ' Dart The dart module shows the currently installed version of Dart . By default the module will be shown if any of the following conditions are met: The current directory contains a file with .dart extension The current directory contains a .dart_tool directory The current directory contains a pubspec.yaml , pubspec.yml or pubspec.lock file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🎯 ' A format string representing the symbol of Dart detect_extensions ['dart'] Which extensions should trigger this module. detect_files ['pubspec.yaml', 'pubspec.yml', 'pubspec.lock'] Which filenames should trigger this module. detect_folders ['.dart_tool'] Which folders should trigger this module. style 'bold blue' The style for the module. disabled false Disables the dart module. Variables Variable Example Description version v2.8.4 The version of dart symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ dart ] format = 'via [🔰 $version](bold red) ' Deno The deno module shows you your currently installed version of Deno . By default the module will be shown if any of the following conditions are met: The current directory contains a deno.json , deno.jsonc , deno.lock , mod.ts , mod.js , deps.ts or deps.js file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🦕 ' A format string representing the symbol of Deno detect_extensions [] Which extensions should trigger this module. detect_files ['deno.json', 'deno.jsonc', 'deno.lock', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'green bold' The style for the module. disabled false Disables the deno module. Variables Variable Example Description version v1.8.3 The version of deno symbol Mirrors the value of option symbol style Mirrors the value of option style Example toml # ~/.config/starship.toml [ deno ] format = 'via [🦕 $version](green bold) ' Directory The directory module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. When using the fish_style_pwd_dir_length option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. For example, given ~/Dev/Nix/nixpkgs/pkgs where nixpkgs is the repo root, and the option set to 1 . You will now see ~/D/N/nixpkgs/pkgs , whereas before it would have been nixpkgs/pkgs . Options Option Default Description truncation_length 3 The number of parent folders that the current directory should be truncated to. truncate_to_repo true Whether or not to truncate to the root of the git repo that you're currently in. format '[$path]($style)[$read_only]($read_only_style) ' The format for the module. style 'bold cyan' The style for the module. disabled false Disables the directory module. read_only '🔒' The symbol indicating current directory is read only. read_only_style 'red' The style for the read only symbol. truncation_symbol '' The symbol to prefix to truncated paths. eg: '…/' before_repo_root_style The style for the path segment above the root of the git repo. The default value is equivalent to style . repo_root_style The style for the root of the git repo. The default value is equivalent to style . repo_root_format '[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) ' The format of a git repo when before_repo_root_style and repo_root_style is defined. home_symbol '~' The symbol indicating home directory. use_os_path_sep true Use the OS specific path separator instead of always using / (e.g. \ on Windows) This module has a few advanced configuration options that control how the directory is displayed. Advanced Option Default Description substitutions A table of substitutions to be made to the path. fish_style_pwd_dir_length 0 The number of characters to use when applying fish shell pwd path logic. use_logical_path true If true render the logical path sourced from the shell via PWD or --logical-path . If false instead render the physical filesystem path with symlinks resolved. substitutions allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories of Java. Note that this will disable the fish style PWD. toml [ directory . substitutions ] '/Volumes/network/path' = '/net' 'src/com/long/java/path' = 'mypath' fish_style_pwd_dir_length interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path /built/this/city/on/rock/and/roll , which would normally be displayed as rock/and/roll , would be displayed as /b/t/c/o/rock/and/roll with fish_style_pwd_dir_length = 1 --the path components that would normally be removed are displayed with a single character. For fish_style_pwd_dir_length = 2 , it would be /bu/th/ci/on/rock/and/roll . Variables Variable Example Description path 'D:/Projects' The current directory path style* 'black bold dimmed' Mirrors the value of option style : This variable can only be used as a part of a style string The git repos have additional variables. Let us consider the path /path/to/home/git_repo/src/lib Variable Example Description before_root_path '/path/to/home/' The path before git root directory path repo_root 'git_repo' The git root directory name path '/src/lib' The remaining path style 'black bold dimmed' Mirrors the value of option style repo_root_style 'underline white' Style for git root directory name Example toml # ~/.config/starship.toml [ directory ] truncation_length = 8 truncation_symbol = '…/' Direnv The direnv module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by direnv . TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description format '[$symbol$loaded/$allowed]($style) ' The format for the module. symbol 'direnv ' The symbol used before displaying the direnv context. style 'bold orange' The style for the module. disabled true Disables the direnv module. detect_extensions [] Which extensions should trigger this module. detect_files ['.envrc'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. detect_env_vars ['DIRENV_FILE'] Which environment variables should trigger this module. allowed_msg 'allowed' The message displayed when an rc file is allowed. not_allowed_msg 'not allowed' The message displayed when an rc file is not_allowed. denied_msg 'denied' The message displayed when an rc file is denied. loaded_msg 'loaded' The message displayed when an rc file is loaded. unloaded_msg 'not loaded' The message displayed when an rc file is not loaded. Variables Variable Example Description loaded loaded Whether the current rc file is loaded. allowed denied Whether the current rc file is allowed. rc_path /home/test/.envrc The current rc file path. symbol Mirrors the value of option symbol . style red bold Mirrors the value of option style . : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ direnv ] disabled = false Docker Context The docker_context module shows the currently active Docker context if it's not set to default or desktop-linux , or if the DOCKER_MACHINE_NAME , DOCKER_HOST or DOCKER_CONTEXT environment variables are set (as they are meant to override the context in use). Options Option Default Description format 'via [$symbol$context]($style) ' The format for the module. symbol '🐳 ' The symbol used before displaying the Docker context. only_with_files true Only show when there's a match detect_extensions [] Which extensions should trigger this module (needs only_with_files to be true). detect_files ['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile'] Which filenames should trigger this module (needs only_with_files to be true). detect_folders [] Which folders should trigger this module (needs only_with_files to be true). style 'blue bold' The style for the module. disabled false Disables the docker_context module. Variables Variable Example Description context test_context The current docker context symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ docker_context ] format = 'via [🐋 $context](blue bold)' Dotnet The dotnet module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: global.json project.json Directory.Build.props Directory.Build.targets Packages.props .csproj .fsproj .xproj You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running dotnet --version , but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting heuristic = false in the module options. The module will also show the Target Framework Moniker ( https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks ) when there is a .csproj file in the current directory. Options Option Default Description format 'via [$symbol($version )(🎯 $tfm )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '.NET ' The symbol used before displaying the version of dotnet. heuristic true Use faster version detection to keep starship snappy. detect_extensions ['csproj', 'fsproj', 'xproj'] Which extensions should trigger this module. detect_files ['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this modules. style 'bold blue' The style for the module. disabled false Disables the dotnet module. Variables Variable Example Description version v3.1.201 The version of dotnet sdk tfm netstandard2.0 The Target Framework Moniker that the current project is targeting symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ dotnet ] symbol = '🥅 ' style = 'green' heuristic = false Elixir The elixir module shows the currently installed version of Elixir and Erlang/OTP . By default the module will be shown if any of the following conditions are met: The current directory contains a mix.exs file. Options Option Default Description format 'via [$symbol($version $OTP $otp_version$ )]($style)' The format for the module elixir. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '💧 ' The symbol used before displaying the version of Elixir/Erlang. detect_extensions [] Which extensions should trigger this module. detect_files ['mix.exs'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this modules. style 'bold purple' The style for the module. disabled false Disables the elixir module. Variables Variable Example Description version v1.10 The version of elixir otp_version The otp version of elixir symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ elixir ] symbol = '🔮 ' Elm The elm module shows the currently installed version of Elm . By default the module will be shown if any of the following conditions are met: The current directory contains a elm.json file The current directory contains a elm-package.json file The current directory contains a .elm-version file The current directory contains a elm-stuff folder The current directory contains .elm files Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🌳 ' A format string representing the symbol of Elm. detect_extensions ['elm'] Which extensions should trigger this module. detect_files ['elm.json', 'elm-package.json', '.elm-version'] Which filenames should trigger this module. detect_folders ['elm-stuff'] Which folders should trigger this modules. style 'cyan bold' The style for the module. disabled false Disables the elm module. Variables Variable Example Description version v0.19.1 The version of elm symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ elm ] format = 'via [ $version](cyan bold) ' Environment Variable The env_var module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met: The variable configuration option matches an existing environment variable The variable configuration option is not defined, but the default configuration option is TIP The order in which env_var modules are shown can be individually set by including ${env_var.foo} in the top level format (as it includes a dot, you need to use ${...} ). By default, the env_var module will simply show all env_var modules in the order they were defined. TIP Multiple environmental variables can be displayed by using a . . (see example) If the variable configuration option is not set, the module will display value of variable under the name of text after the . character. Example: following configuration will display value of USER environment variable toml # ~/.config/starship.toml [ env_var . USER ] default = 'unknown user' Options Option Default Description symbol "" The symbol used before displaying the variable value. variable The environment variable to be displayed. default The default value to be displayed when the selected variable is not defined. format "with [$env_value]($style) " The format for the module. description "<env_var module>" The description of the module that is shown when running starship explain . disabled false Disables the env_var module. Variables Variable Example Description env_value Windows NT (if variable would be $OS ) The environment value of option variable symbol Mirrors the value of option symbol style black bold dimmed Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ env_var ] variable = 'SHELL' default = 'unknown shell' Displaying multiple environmental variables: toml # ~/.config/starship.toml [ env_var . SHELL ] variable = 'SHELL' default = 'unknown shell' [ env_var . USER ] default = 'unknown user' Erlang The erlang module shows the currently installed version of Erlang/OTP . By default the module will be shown if any of the following conditions are met: The current directory contains a rebar.config file. The current directory contains a erlang.mk file. Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol ' ' The symbol used before displaying the version of erlang. style 'bold red' The style for the module. detect_extensions [] Which extensions should trigger this module. detect_files ['rebar.config', 'elang.mk'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this modules. disabled false Disables the erlang module. Variables Variable Example Description version v22.1.3 The version of erlang symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ erlang ] format = 'via [e $version](bold red) ' Fennel The fennel module shows the currently installed version of Fennel . By default the module will be shown if any of the following conditions are met: The current directory contains a file with the .fnl extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🧅 ' The symbol used before displaying the version of fennel. style 'bold green' The style for the module. detect_extensions ['fnl'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this modules. disabled false Disables the fennel module. Variables Variable Example Description version v1.2.1 The version of fennel symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ fennel ] symbol = '⫰ ' Fill The fill module fills any extra space on the line with a symbol. If multiple fill modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. Options Option Default Description symbol '.' The symbol used to fill the line. style 'bold black' The style for the module. disabled false Disables the fill module Example toml # ~/.config/starship.toml format = 'AA $fill BB $fill CC' [ fill ] symbol = '-' style = 'bold green' Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC Fortran The fortran module shows the current compiler version of Fortran. Options Option Default Description symbol ' ' The symbol used before displaying the version of Fortran. format 'via [$symbol($version )]($style)' The format for the module. version_format '${raw}' The version format. Available vars are raw , major , minor , & patch style 'bold purple' The style for the module. detect_extensions ['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18'] Which extensions should trigger this module. detect_files ['fpm.toml'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. commands [ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ] How to detect what the compiler is disabled false Disables the fortran module. Variables Variable Example Description name gfortran The name of the compiler version 14.2.0 The version of the Fortran compiler symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Commands The commands option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like ['myfortran', '--version'] . Starship will try executing each command until it gets a result on STDOUT. If a Fortran compiler is not supported by this module, you can request it by raising an issue on GitHub . Fossil Branch The fossil_branch module shows the name of the active branch of the check-out in your current directory. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description format 'on [$symbol$branch]($style) ' The format for the module. Use '$branch' to refer to the current branch name. symbol ' ' The symbol used before the branch name of the check-out in your current directory. style 'bold purple' The style for the module. truncation_length 2^63 - 1 Truncates a Fossil branch name to N graphemes truncation_symbol '…' The symbol used to indicate a branch name was truncated. You can use '' for no symbol. disabled true Disables the fossil_branch module. Variables Variable Example Description branch trunk The active Fossil branch symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ fossil_branch ] symbol = '🦎 ' truncation_length = 4 truncation_symbol = '' Fossil Metrics The fossil_metrics module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description format '([+$added]($added_style) )([-$deleted]($deleted_style) )' The format for the module. added_style 'bold green' The style for the added count. deleted_style 'bold red' The style for the deleted count. only_nonzero_diffs true Render status only for changed items. disabled true Disables the fossil_metrics module. Variables Variable Example Description added 1 The current number of added lines deleted 2 The current number of deleted lines added_style Mirrors the value of option added_style deleted_style* Mirrors the value of option deleted_style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ fossil_metrics ] added_style = 'bold blue' format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' Google Cloud ( gcloud ) The gcloud module shows the current configuration for gcloud CLI. This is based on the ~/.config/gcloud/active_config file and the ~/.config/gcloud/configurations/config_{CONFIG NAME} file and the CLOUDSDK_CONFIG env var. When the module is enabled it will always be active, unless detect_env_vars has been set in which case the module will only be active when one of the environment variables has been set. Options Option Default Description format 'on [$symbol$account(@$domain)($$region$)]($style) ' The format for the module. symbol '☁️ ' The symbol used before displaying the current GCP profile. region_aliases {} Table of region aliases to display in addition to the GCP name. project_aliases {} Table of project aliases to display in addition to the GCP name. detect_env_vars [] Which environmental variables should trigger this module style 'bold blue' The style for the module. disabled false Disables the gcloud module. Variables Variable Example Description region us-central1 The current GCP region account foo The current GCP profile domain example.com The current GCP profile domain project The current GCP project active default The active config name written in ~/.config/gcloud/active_config symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Examples Display account and project toml # ~/.config/starship.toml [ gcloud ] format = 'on [$symbol$account(@$domain)($$project$)]($style) ' Display active config name only toml # ~/.config/starship.toml [ gcloud ] format = '[$symbol$active]($style) ' style = 'bold yellow' Display account and aliased region toml # ~/.config/starship.toml [ gcloud ] symbol = '️🇬️ ' [ gcloud . region_aliases ] us-central1 = 'uc1' asia-northeast1 = 'an1' Display account and aliased project toml # ~/.config/starship.toml [ gcloud ] format = 'on [$symbol$account(@$domain)($$project$)]($style) ' [ gcloud . project_aliases ] very-long-project-name = 'vlpn' Git Branch The git_branch module shows the active branch of the repo in your current directory. Options Option Default Description always_show_remote false Shows the remote tracking branch name, even if it is equal to the local branch name. format 'on [$symbol$branch(:$remote_branch)]($style) ' The format for the module. Use '$branch' to refer to the current branch name. symbol ' ' A format string representing the symbol of git branch. style 'bold purple' The style for the module. truncation_length 2^63 - 1 Truncates a git branch to N graphemes. truncation_symbol '…' The symbol used to indicate a branch name was truncated. You can use '' for no symbol. only_attached false Only show the branch name when not in a detached HEAD state. ignore_branches [] A list of names to avoid displaying. Useful for 'master' or 'main'. ignore_bare_repo false Do not show when in a bare repo. disabled false Disables the git_branch module. Variables Variable Example Description branch master The current branch name, falls back to HEAD if there's no current branch (e.g. git detached HEAD ). remote_name origin The remote name. remote_branch master The name of the branch tracked on remote_name . symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ git_branch ] symbol = '🌱 ' truncation_length = 4 truncation_symbol = '' ignore_branches = [ 'master' , 'main' ] Git Commit The git_commit module shows the current commit hash and also the tag (if any) of the repo in your current directory. Options Option Default Description commit_hash_length 7 The length of the displayed git commit hash. format '[$$hash$tag$]($style) ' The format for the module. style 'bold green' The style for the module. only_detached true Only show git commit hash when in detached HEAD state tag_disabled true Disables showing tag info in git_commit module. tag_max_candidates 0 How many commits to consider for tag display. The default only allows exact matches. tag_symbol ' 🏷 ' Tag symbol prefixing the info shown disabled false Disables the git_commit module. Variables Variable Example Description hash b703eb3 The current git commit hash tag v1.0.0 The tag name if showing tag info is enabled. style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ git_commit ] commit_hash_length = 4 tag_symbol = '🔖 ' Git State The git_state module will show in directories which are part of a git repository, and where there is an operation in progress, such as: REBASING , BISECTING , etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. Options Option Default Description rebase 'REBASING' A format string displayed when a rebase is in progress. merge 'MERGING' A format string displayed when a merge is in progress. revert 'REVERTING' A format string displayed when a revert is in progress. cherry_pick 'CHERRY-PICKING' A format string displayed when a cherry-pick is in progress. bisect 'BISECTING' A format string displayed when a bisect is in progress. am 'AM' A format string displayed when an apply-mailbox ( git am ) is in progress. am_or_rebase 'AM/REBASE' A format string displayed when an ambiguous apply-mailbox or rebase is in progress. style 'bold yellow' The style for the module. format '$[$state( $progress_current/$progress_total)]($style)$ ' The format for the module. disabled false Disables the git_state module. Variables Variable Example Description state REBASING The current state of the repo progress_current 1 The current operation progress progress_total 2 The total operation progress style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ git_state ] format = '[$$state( $progress_current of $progress_total)$]($style) ' cherry_pick = '[🍒 PICKING](bold red)' Git Metrics The git_metrics module will show the number of added and deleted lines in the current git repository. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description added_style 'bold green' The style for the added count. deleted_style 'bold red' The style for the deleted count. only_nonzero_diffs true Render status only for changed items. format '([+$added]($added_style) )([-$deleted]($deleted_style) )' The format for the module. disabled true Disables the git_metrics module. ignore_submodules false Ignore changes to submodules Variables Variable Example Description added 1 The current number of added lines deleted 2 The current number of deleted lines added_style Mirrors the value of option added_style deleted_style* Mirrors the value of option deleted_style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ git_metrics ] added_style = 'bold blue' format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' Git Status The git_status module shows symbols representing the state of the repo in your current directory. TIP The Git Status module is very slow in Windows directories (for example under /mnt/c/ ) when in a WSL environment. You can disable the module or use the windows_starship option to use a Windows-native Starship executable to compute git_status for those paths. Options Option Default Description format '([\[$all_status$ahead_behind\]]($style) )' The default format for git_status conflicted '=' This branch has merge conflicts. ahead '⇡' The format of ahead behind '⇣' The format of behind diverged '⇕' The format of diverged up_to_date '' The format of up_to_date untracked '?' The format of untracked stashed '\$' The format of stashed modified '!' The format of modified staged '+' The format of staged renamed '»' The format of renamed deleted '✘' The format of deleted typechanged "" The format of typechanged style 'bold red' The style for the module. ignore_submodules false Ignore changes to submodules. disabled false Disables the git_status module. windows_starship Use this (Linux) path to a Windows Starship executable to render git_status when on Windows paths in WSL. use_git_executable false Do not use gitoxide for computing the status, but use the git executable instead. Variables The following variables can be used in format : Variable Description all_status Shortcut for $conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked ahead_behind Displays diverged , ahead , behind or up_to_date format string based on the current status of the repo. conflicted Displays conflicted when this branch has merge conflicts. untracked Displays untracked when there are untracked files in the working directory. stashed Displays stashed when a stash exists for the local repository. modified Displays modified when there are file modifications in the working directory. staged Displays staged when a new file has been added to the staging area. renamed Displays renamed when a renamed file has been added to the staging area. deleted Displays deleted when a file's deletion has been added to the staging area. typechanged Displays typechanged when a file's type has been changed in the staging area. style Mirrors the value of option style : This variable can only be used as a part of a style string The following variables can be used in diverged : Variable Description ahead_count Number of commits ahead of the tracking branch behind_count Number of commits behind the tracking branch The following variables can be used in conflicted , ahead , behind , untracked , stashed , modified , staged , renamed and deleted : Variable Description count Show the number of files Example toml # ~/.config/starship.toml [ git_status ] conflicted = '🏳' ahead = '🏎💨' behind = '😰' diverged = '😵' up_to_date = '✓' untracked = '🤷' stashed = '📦' modified = '📝' staged = '[++$$count$](green)' renamed = '👅' deleted = '🗑' Show ahead/behind count of the branch being tracked toml # ~/.config/starship.toml [ git_status ] ahead = '⇡${count}' diverged = '⇕⇡${ahead_count}⇣${behind_count}' behind = '⇣${count}' Use Windows Starship executable on Windows paths in WSL toml # ~/.config/starship.toml [ git_status ] windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe' Gleam The gleam module shows the currently installed version of Gleam . By default the module will be shown if any of the following conditions are met: The current directory contains a gleam.toml file The current directory contains a file with the .gleam extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '⭐ ' A format string representing the symbol of Gleam. detect_extensions ['gleam'] Which extensions should trigger this module. detect_files ['gleam.toml'] Which filenames should trigger this module. style 'bold #FFAFF3' The style for the module. disabled false Disables the gleam module. Variables Variable Example Description version v1.0.0 The version of gleam symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ gleam ] format = 'via [⭐ $version](bold red) ' Go The golang module shows the currently installed version of Go . By default the module will be shown if any of the following conditions are met: The current directory contains a go.mod file The current directory contains a go.sum file The current directory contains a go.work file The current directory contains a glide.yaml file The current directory contains a Gopkg.yml file The current directory contains a Gopkg.lock file The current directory contains a .go-version file The current directory contains a Godeps directory The current directory contains a file with the .go extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🐹 ' A format string representing the symbol of Go. detect_extensions ['go'] Which extensions should trigger this module. detect_files ['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version'] Which filenames should trigger this module. detect_folders ['Godeps'] Which folders should trigger this module. style 'bold cyan' The style for the module. not_capable_style 'bold red' The style for the module when the go directive in the go.mod file does not match the installed Go version. disabled false Disables the golang module. Variables Variable Example Description version v1.12.1 The version of go mod_version 1.16 go version requirement as set in the go directive of go.mod . Will only show if the version requirement does not match the go version. symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ golang ] format = 'via [🏎💨 $version](bold cyan) ' Using mod_version toml # ~/.config/starship.toml [ golang ] format = 'via [$symbol($version )($mod_version )]($style)' Guix-shell The guix_shell module shows the guix-shell environment. The module will be shown when inside a guix-shell environment. Options Option Default Description format 'via [$symbol]($style) ' The format for the module. symbol '🐃 ' A format string representing the symbol of guix-shell. style 'yellow bold' The style for the module. disabled false Disables the guix_shell module. Variables Variable Example Description symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ guix_shell ] disabled = true format = 'via [🐂](yellow bold) ' Gradle The gradle module shows the version of the Gradle Wrapper currently used in the project directory. By default the module will be shown if any of the following conditions are met: The current directory contains a gradle/wrapper/gradle-wrapper.properties directory. The current directory contains a file ending with .gradle or .gradle.kts . The gradle module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🅶 ' A format string representing the symbol of Gradle. detect_extensions ['gradle', 'gradle.kts'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders ['gradle'] Which folders should trigger this module. style 'bold bright-cyan' The style for the module. disabled false Disables the gradle module. recursive false Enables recursive finding for the gradle directory. Variables Variable Example Description version v7.5.1 The version of gradle symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Haskell The haskell module finds the current selected GHC version and/or the selected Stack snapshot. By default the module will be shown if any of the following conditions are met: The current directory contains a stack.yaml file The current directory contains any .hs , .cabal , or .hs-boot file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. symbol 'λ ' A format string representing the symbol of Haskell detect_extensions ['hs', 'cabal', 'hs-boot'] Which extensions should trigger this module. detect_files ['stack.yaml', 'cabal.project'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'bold purple' The style for the module. disabled false Disables the haskell module. Variables Variable Example Description version ghc_version or snapshot depending on whether the current project is a Stack project snapshot lts-18.12 Currently selected Stack snapshot ghc_version 9.2.1 Currently installed GHC version symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Haxe The haxe module shows the currently installed version of Haxe . By default the module will be shown if any of the following conditions are met: The current directory contains a project.xml , Project.xml , application.xml , haxelib.json , hxformat.json or .haxerc file The current directory contains a .haxelib or a haxe_libraries directory The current directory contains a file with the .hx or .hxml extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch detect_extensions ['hx', 'hxml'] Which extensions should trigger this module. detect_files ['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc'] Which filenames should trigger this module. detect_folders ['.haxelib', 'haxe_libraries'] Which folders should trigger this modules. symbol '⌘ ' A format string representing the symbol of Haxe. style 'bold fg:202' The style for the module. disabled false Disables the haxe module. Variables Variable Example Description version v4.2.5 The version of haxe symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ haxe ] format = "via [⌘ $version](bold fg:202) " Helm The helm module shows the currently installed version of Helm . By default the module will be shown if any of the following conditions are met: The current directory contains a helmfile.yaml file The current directory contains a Chart.yaml file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch detect_extensions [] Which extensions should trigger this module. detect_files ['helmfile.yaml', 'Chart.yaml'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this modules. symbol '⎈ ' A format string representing the symbol of Helm. style 'bold white' The style for the module. disabled false Disables the helm module. Variables Variable Example Description version v3.1.1 The version of helm symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ helm ] format = 'via [⎈ $version](bold white) ' Hostname The hostname module shows the system hostname. Options Option Default Description ssh_only true Only show hostname when connected to an SSH session. ssh_symbol '🌐 ' A format string representing the symbol when connected to SSH session. trim_at '.' String that the hostname is cut off at, after the first match. '.' will stop after the first dot. '' will disable any truncation. detect_env_vars [] Which environment variable(s) should trigger this module. format '[$ssh_symbol$hostname]($style) in ' The format for the module. style 'bold dimmed green' The style for the module. disabled false Disables the hostname module. aliases {} Translate system hostnames to something else. If trim_at is specified, only the first part will be matched and replaced. Variables Variable Example Description hostname computer The hostname of the computer style Mirrors the value of option style ssh_symbol '🌏 ' The symbol to represent when connected to SSH session : This variable can only be used as a part of a style string Examples Always show the hostname toml # ~/.config/starship.toml [ hostname ] ssh_only = false format = '[$ssh_symbol](bold blue) on [$hostname](bold red) ' trim_at = '.companyname.com' disabled = false Hide the hostname in remote tmux sessions toml # ~/.config/starship.toml [ hostname ] ssh_only = false detect_env_vars = [ '!TMUX' , 'SSH_CONNECTION' ] disabled = false Replace the hostname with a nickname toml # ~/.config/starship.toml [ hostname ] aliases = { "Max's MacBook Pro" = "home" } Java The java module shows the currently installed version of Java . By default the module will be shown if any of the following conditions are met: The current directory contains a pom.xml , build.gradle.kts , build.sbt , .java-version , deps.edn , project.clj , build.boot , or .sdkmanrc file The current directory contains a file with the .java , .class , .gradle , .jar , .clj , or .cljc extension Options Option Default Description format 'via [${symbol}(${version} )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch detect_extensions ['java', 'class', 'gradle', 'jar', 'cljs', 'cljc'] Which extensions should trigger this module. detect_files ['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this modules. symbol '☕ ' A format string representing the symbol of Java style 'red dimmed' The style for the module. disabled false Disables the java module. Variables Variable Example Description version v14 The version of java symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ java ] symbol = '🌟 ' Jobs The jobs module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the number_threshold config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the symbol_threshold config value, if it exists. You can set both values to 0 in order to always show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: 0 jobs -> Nothing is shown. 1 job -> symbol is shown. 2 jobs or more -> symbol + number are shown. WARNING This module is not supported on tcsh. WARNING The threshold option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the threshold config value, if it exists. If threshold is set to 0, then the module will also show when there are 0 jobs running. Options Option Default Description threshold 1 Show number of jobs if exceeded. symbol_threshold 1 Show symbol if the job count is at least symbol_threshold . number_threshold 2 Show the number of jobs if the job count is at least number_threshold . format '[$symbol$number]($style) ' The format for the module. symbol '✦' The string used to represent the symbol variable. style 'bold blue' The style for the module. disabled false Disables the jobs module. : This option is deprecated, please use the number_threshold and symbol_threshold options instead. Variables Variable Example Description number 1 The number of jobs symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Examples toml # ~/.config/starship.toml [ jobs ] symbol = '+ ' number_threshold = 4 symbol_threshold = 0 Changing process grouping behavior in fish When using the Fish shell, Starship counts job groups instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: fish set -g __starship_fish_use_job_groups "false" Julia The julia module shows the currently installed version of Julia . By default the module will be shown if any of the following conditions are met: The current directory contains a Project.toml file The current directory contains a Manifest.toml file The current directory contains a file with the .jl extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch detect_extensions ['jl'] Which extensions should trigger this module. detect_files ['Project.toml', 'Manifest.toml'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this modules. symbol 'ஃ ' A format string representing the symbol of Julia. style 'bold purple' The style for the module. disabled false Disables the julia module. Variables Variable Example Description version v1.4.0 The version of julia symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ julia ] symbol = '∴ ' Kotlin The kotlin module shows the currently installed version of Kotlin . By default the module will be shown if any of the following conditions are met: The current directory contains a .kt or a .kts file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch detect_extensions ['kt', 'kts'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this modules. symbol '🅺 ' A format string representing the symbol of Kotlin. style 'bold blue' The style for the module. kotlin_binary 'kotlin' Configures the kotlin binary that Starship executes when getting the version. disabled false Disables the kotlin module. Variables Variable Example Description version v1.4.21 The version of kotlin symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ kotlin ] symbol = '🅺 ' toml # ~/.config/starship.toml [ kotlin ] # Uses the Kotlin Compiler binary to get the installed version kotlin_binary = 'kotlinc' Kubernetes Displays the current Kubernetes context name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-context --namespace astronaut . Similarly, the user and cluster can be set with kubectl config set-context starship-context --user starship-user and kubectl config set-context starship-context --cluster starship-cluster . If the $KUBECONFIG env var is set the module will use that if not it will use the ~/.kube/config . TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. When the module is enabled it will always be active, unless any of detect_env_vars , detect_extensions , detect_files or detect_folders have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. Options WARNING The context_aliases and user_aliases options are deprecated. Use contexts and the corresponding context_alias and user_alias options instead. Option Default Description symbol '☸ ' A format string representing the symbol displayed before the Cluster. format '[$symbol$context( $$namespace$)]($style) in ' The format for the module. style 'cyan bold' The style for the module. context_aliases {} Table of context aliases to display. user_aliases * {} Table of user aliases to display. detect_extensions [] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this modules. detect_env_vars [] Which environmental variables should trigger this module contexts [] Customized styles and symbols for specific contexts. disabled true Disables the kubernetes module. : This option is deprecated, please add contexts with the corresponding context_alias and user_alias options instead. To customize the style of the module for specific environments, use the following configuration as part of the contexts list: Variable Description context_pattern Required Regular expression to match current Kubernetes context name. user_pattern Regular expression to match current Kubernetes user name. context_alias Context alias to display instead of the full context name. user_alias User alias to display instead of the full user name. style The style for the module when using this context. If not set, will use module's style. symbol The symbol for the module when using this context. If not set, will use module's symbol. Note that all regular expression are anchored with ^<pattern>$ and so must match the whole string. The _pattern regular expressions may contain capture groups, which can be referenced in the corresponding alias via $name and $N (see example below and the rust Regex::replace() documentation ). Variables Variable Example Description context starship-context The current kubernetes context name namespace starship-namespace If set, the current kubernetes namespace user starship-user If set, the current kubernetes user cluster starship-cluster If set, the current kubernetes cluster symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ kubernetes ] format = 'on [⛵ ($user on )($cluster in )$context $$namespace$](dimmed green) ' disabled = false contexts = [ { context_pattern = "dev.local.cluster.k8s" , style = "green" , symbol = "💔 " }, ] Only show the module in directories that contain a k8s file. toml # ~/.config/starship.toml [ kubernetes ] disabled = false detect_files = [ 'k8s' ] Kubernetes Context specific config The contexts configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression. toml # ~/.config/starship.toml [[ kubernetes . contexts ]] # "bold red" style + default symbol when Kubernetes current context name equals "production" and* the current user # equals "admin_user" context_pattern = "production" user_pattern = "admin_user" style = "bold red" context_alias = "prod" user_alias = "admin" [[ kubernetes . contexts ]] # "green" style + a different symbol when Kubernetes current context name contains openshift context_pattern = ".openshift." style = "green" symbol = "💔 " context_alias = "openshift" [[ kubernetes . contexts ]] # Using capture groups # Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone. # The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`) # and renames every matching kube context into a more readable format (`gke-cluster-name`): context_pattern = "gke_._(?P<cluster>[ \\ w-]+)" context_alias = "gke-$cluster" Line Break The line_break module separates the prompt into two lines. Options Option Default Description disabled false Disables the line_break module, making the prompt a single line. Example toml # ~/.config/starship.toml [ line_break ] disabled = true Local IP The localip module shows the IPv4 address of the primary network interface. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description ssh_only true Only show IP address when connected to an SSH session. format '[$localipv4]($style) ' The format for the module. style 'bold yellow' The style for the module. disabled true Disables the localip module. Variables Variable Example Description localipv4 192.168.1.13 Contains the primary IPv4 address style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ localip ] ssh_only = false format = '@[$localipv4](bold red) ' disabled = false Lua The lua module shows the currently installed version of Lua . By default the module will be shown if any of the following conditions are met: The current directory contains a .lua-version file The current directory contains a lua directory The current directory contains a file with the .lua extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🌙 ' A format string representing the symbol of Lua. detect_extensions ['lua'] Which extensions should trigger this module. detect_files ['.lua-version'] Which filenames should trigger this module. detect_folders ['lua'] Which folders should trigger this module. style 'bold blue' The style for the module. lua_binary 'lua' Configures the lua binary that Starship executes when getting the version. disabled false Disables the lua module. Variables Variable Example Description version v5.4.0 The version of lua symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ lua ] format = 'via [🌕 $version](bold blue) ' Memory Usage The memory_usage module shows current system memory and swap usage. By default the swap usage is displayed if the total system swap is non-zero. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description threshold 75 Hide the memory usage unless it exceeds this percentage. format 'via $symbol [${ram}( \| ${swap})]($style) ' The format for the module. symbol '🐏' The symbol used before displaying the memory usage. style 'bold dimmed white' The style for the module. disabled true Disables the memory_usage module. Variables Variable Example Description ram 31GiB/65GiB The usage/total RAM of the current system memory. ram_pct 48% The percentage of the current system memory. swap* 1GiB/4GiB The swap memory size of the current system swap memory file. swap_pct** 77% The swap memory percentage of the current system swap memory file. symbol 🐏 Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string : The SWAP file information is only displayed if detected on the current system Example toml # ~/.config/starship.toml [ memory_usage ] disabled = false threshold = -1 symbol = ' ' style = 'bold dimmed green' Meson The meson module shows the current Meson developer environment status. By default the Meson project name is displayed, if $MESON_DEVENV is set. Options Option Default Description truncation_length 2^32 - 1 Truncates a project name to N graphemes. truncation_symbol '…' The symbol used to indicate a project name was truncated. You can use '' for no symbol. format 'via [$symbol$project]($style) ' The format for the module. symbol '⬢ ' The symbol used before displaying the project name. style 'blue bold' The style for the module. disabled false Disables the meson module. Variables Variable Example Description project starship The current Meson project name symbol 🐏 Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ meson ] disabled = false truncation_symbol = '--' symbol = ' ' style = 'bold dimmed green' Mercurial Branch The hg_branch module shows the active branch and topic of the repo in your current directory. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description symbol ' ' The symbol used before the hg bookmark or branch name of the repo in your current directory. style 'bold purple' The style for the module. format 'on [$symbol$branch(:$topic)]($style) ' The format for the module. truncation_length 2^63 - 1 Truncates the hg branch / topic name to N graphemes truncation_symbol '…' The symbol used to indicate a branch name was truncated. disabled true Disables the hg_branch module. Variables Variable Example Description branch master The active mercurial branch topic feature The active mercurial topic symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ hg_branch ] format = 'on [🌱 $branch](bold purple)' truncation_length = 4 truncation_symbol = '' Mercurial State The hg_state module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: REBASING , BISECTING , etc. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description merge 'MERGING' A format string displayed when a merge is in progress. rebase 'REBASING' A format string displayed when a rebase is in progress. update 'UPDATING' A format string displayed when a update is in progress. bisect 'BISECTING' A format string displayed when a bisect is in progress. shelve 'SHELVING' A format string displayed when a shelve is in progress. graft 'GRAFTING' A format string displayed when a graft is in progress. transplant 'TRANSPLANTING' A format string displayed when a transplant is in progress. histedit 'HISTEDITING' A format string displayed when a histedit is in progress. style 'bold yellow' The style for the module. format '$[$state]($style)$ ' The format for the module. disabled true Disables the hg_state module. Variables Variable Example Description state REBASING The current state of the repo progress_current 1 The current operation progress progress_total 2 The total operation progress style Mirrors the value of option style : This variable can only be used as a part of a style string Mise The mise module shows the current mise health as reported by running mise doctor . TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description symbol 'mise ' The symbol used before displaying mise health. style 'bold purple' The style for the module. format 'on [$symbol$health]($style) ' The format for the module. detect_extensions [] Which extensions should trigger this module. detect_files ['mise.toml', 'mise.local.toml', '.mise.toml', '.mise.local.toml'] Which filenames should trigger this module. detect_folders ['.mise'] Which folders should trigger this module. healthy_symbol healthy The message displayed when mise is healthy. unhealthy_symbol unhealthy The message displayed when mise is unhealthy. disabled true Disables the mise module. Variables Variable Example Description health healthy The health of mise symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ mise ] health = 'ready' Mojo The mojo module shows the current version of Mojo programming language installed Options Option Default Description format 'with [$symbol($version )]($style)' The format for the module. symbol '🔥 ' The symbol used before displaying the version of Mojo. style 'bold 208' The style for the module. disabled false Disables the mojo module. detect_extensions ['mojo', '🔥'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. Variables Variable Example Description version 24.4.0 The version of mojo symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ mojo ] format = 'via [mojo ($version )($hash )]($style)' NATS The nats module shows the name of the current NATS context. Options Option Default Description symbol '✉️ ' The symbol used before the NATS context (defaults to empty). style 'bold purple' The style for the module. format '[$symbol$name]($style)' The format for the module. disabled false Disables the nats module. Variables Variable Example Description name localhost The name of the NATS context symbol Mirrors the value of option symbol style Mirrors the value of option style Example toml [ nats ] format = '[$symbol]($style)' style = 'bold purple' Network Namespace The netns module shows the current network namespace. This uses ip netns identify to get the network namespace, so only network namespaces mounted at /var/run/netns will be detected. Options Option Default Description format '[$symbol \[$name\]]($style)' The format for the module. symbol '🛜 ' The symbol used before the network namespace (defaults to empty). style 'blue bold dimmed' The style for the module. disabled false Disables the netns module. Variables Variable Example Description name my-netns The name of the current network namespace symbol Mirrors the value of option symbol style* Mirrors the value of option style Example toml # ~/.config/starship.toml [ netns ] style = 'bold yellow' symbol = '🌐 ' Nim The nim module shows the currently installed version of Nim . By default the module will be shown if any of the following conditions are met: The current directory contains a nim.cfg file The current directory contains a file with the .nim extension The current directory contains a file with the .nims extension The current directory contains a file with the .nimble extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '👑 ' The symbol used before displaying the version of Nim. detect_extensions ['nim', 'nims', 'nimble'] Which extensions should trigger this module. detect_files ['nim.cfg'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'bold yellow' The style for the module. disabled false Disables the nim module. Variables Variable Example Description version v1.2.0 The version of nimc symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ nim ] style = 'yellow' symbol = '🎣 ' Nix-shell The nix_shell module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. Options Option Default Description format 'via [$symbol$state( $$name$)]($style) ' The format for the module. symbol '❄️ ' A format string representing the symbol of nix-shell. style 'bold blue' The style for the module. impure_msg 'impure' A format string shown when the shell is impure. pure_msg 'pure' A format string shown when the shell is pure. unknown_msg '' A format string shown when it is unknown if the shell is pure/impure. disabled false Disables the nix_shell module. heuristic false Attempts to detect new nix shell -style shells with a heuristic. Variables Variable Example Description state pure The state of the nix-shell name lorri The name of the nix-shell symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ nix_shell ] disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( $$name$)](bold blue) ' Node.js The nodejs module shows the currently installed version of Node.js . By default the module will be shown if any of the following conditions are met: The current directory contains a package.json file The current directory contains a .node-version file The current directory contains a .nvmrc file The current directory contains a node_modules directory The current directory contains a file with the .js , .mjs or .cjs extension The current directory contains a file with the .ts , .mts or .cts extension Additionally, the module will be hidden by default if the directory contains a bunfig.toml , bun.lock , or bun.lockb file, overriding the above conditions. Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol ' ' A format string representing the symbol of Node.js. detect_extensions ['js', 'mjs', 'cjs', 'ts', 'mts', 'cts'] Which extensions should trigger this module. detect_files ['package.json', '.node-version', '.nvmrc'] Which filenames should trigger this module. detect_folders ['node_modules'] Which folders should trigger this module. style 'bold green' The style for the module. disabled false Disables the nodejs module. not_capable_style 'bold red' The style for the module when an engines property in package.json does not match the Node.js version. Variables Variable Example Description version v13.12.0 The version of node engines_version >=12.0.0 node version requirement as set in the engines property of package.json . Will only show if the version requirement does not match the node version. symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ nodejs ] format = 'via [🤖 $version](bold green) ' OCaml The ocaml module shows the currently installed version of OCaml . By default the module will be shown if any of the following conditions are met: The current directory contains a file with .opam extension or _opam directory The current directory contains a esy.lock directory The current directory contains a dune or dune-project file The current directory contains a jbuild or jbuild-ignore file The current directory contains a .merlin file The current directory contains a file with .ml , .mli , .re or .rei extension Options Option Default Description format 'via [$symbol($version )($$switch_indicator$switch_name$ )]($style)' The format string for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🐫 ' The symbol used before displaying the version of OCaml. global_switch_indicator '' The format string used to represent global OPAM switch. local_switch_indicator '' The format string used to represent local OPAM switch. detect_extensions ['opam', 'ml', 'mli', 're', 'rei'] Which extensions should trigger this module. detect_files ['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin'] Which filenames should trigger this module. detect_folders ['_opam', 'esy.lock'] Which folders should trigger this module. style 'bold yellow' The style for the module. disabled false Disables the ocaml module. Variables Variable Example Description version v4.10.0 The version of ocaml switch_name my-project The active OPAM switch switch_indicator Mirrors the value of indicator for currently active OPAM switch symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ ocaml ] format = 'via [🐪 $version]($style) ' Odin The odin module shows the currently installed version of Odin . By default the module will be shown if the current directory contains a .odin file. Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. show_commit false Shows the commit as part of the version. symbol 'Ø ' The symbol used before displaying the version of Odin. style 'bold bright-blue' The style for the module. disabled false Disables the odin module. detect_extensions ['odin'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. Variables Variable Example Description version dev-2024-03 The version of odin symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ odin ] format = 'via [󰹩 ($version )]($style)' show_commit = true Open Policy Agent The opa module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a .rego file. Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🪖 ' A format string representing the symbol of OPA. detect_extensions ['rego'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'bold blue' The style for the module. disabled false Disables the opa module. Variables Variable Example Description version v0.44.0 The version of opa symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ opa ] format = 'via [⛑️ $version](bold red) ' OpenStack The openstack module shows the current OpenStack cloud and project. The module only active when the OS_CLOUD env var is set, in which case it will read clouds.yaml file from any of the default locations . to fetch the current project in use. Options Option Default Description format 'on [$symbol$cloud($$project$)]($style) ' The format for the module. symbol '☁️ ' The symbol used before displaying the current OpenStack cloud. style 'bold yellow' The style for the module. disabled false Disables the openstack module. Variables Variable Example Description cloud corp The current OpenStack cloud project dev The current OpenStack project symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ openstack ] format = 'on [$symbol$cloud($$project$)]($style) ' style = 'bold yellow' symbol = '☁️ ' OS The os module shows the current operating system. OS information is detected via the os_info crate. WARNING The os_info crate used by this module is known to be inaccurate on some systems. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description format '[$symbol]($style)' The format for the module. style 'bold white' The style for the module. disabled true Disables the os module. symbols A table that maps each operating system to its symbol. symbols allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a feature request . toml # This is the default symbols table. [ os . symbols ] AIX = "➿ " Alpaquita = "🔔 " AlmaLinux = "💠 " Alpine = "🏔️ " ALTLinux = "Ⓐ " Amazon = "🙂 " Android = "🤖 " AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " CachyOS = "🎗️ " CentOS = "💠 " Debian = "🌀 " DragonFly = "🐉 " Elementary = "🍏 " Emscripten = "🔗 " EndeavourOS = "🚀 " Fedora = "🎩 " FreeBSD = "😈 " Garuda = "🦅 " Gentoo = "🗜️ " HardenedBSD = "🛡️ " Illumos = "🐦 " Ios = "📱 " InstantOS = "⏲️ " Kali = "🐉 " Linux = "🐧 " Mabox = "📦 " Macos = "🍎 " Manjaro = "🥭 " Mariner = "🌊 " MidnightBSD = "🌘 " Mint = "🌿 " NetBSD = "🚩 " NixOS = "❄️ " Nobara = "🎩 " OpenBSD = "🐡 " OpenCloudOS = "☁️ " openEuler = "🦉 " openSUSE = "🦎 " OracleLinux = "🦴 " PikaOS = "🐤 " Pop = "🍭 " Raspbian = "🍓 " Redhat = "🎩 " RedHatEnterprise = "🎩 " RockyLinux = "💠 " Redox = "🧪 " Solus = "⛵ " SUSE = "🦎 " Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " Void = " " Windows = "🪟 " Zorin = "🔹 " Variables Variable Example Description symbol 🎗️ The current operating system symbol from advanced option symbols name Arch Linux The current operating system name type Arch The current operating system type codename The current operating system codename, if applicable edition The current operating system edition, if applicable version The current operating system version, if applicable style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ os ] format = "on [($name )]($style)" style = "bold blue" disabled = false [ os . symbols ] Windows = " " Arch = "Arch is the best! " Package Version The package module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm , nimble , cargo , poetry , python , composer , gradle , julia , mix , helm , shards , galaxy , daml and dart packages. npm – The npm package version is extracted from the package.json present in the current directory JSR – The jsr package version is extracted from the jsr.json / jsr.jsonc or deno.json / deno.jsonc present in the current directory Cargo – The cargo package version is extracted from the Cargo.toml present in the current directory Nimble - The nimble package version is extracted from the .nimble file present in the current directory with the nimble dump command Poetry – The poetry package version is extracted from the pyproject.toml present in the current directory Python - The python package version is extracted from a PEP 621 compliant pyproject.toml or a setup.cfg present in the current directory Composer – The composer package version is extracted from the composer.json present in the current directory Gradle – The gradle package version is extracted from the build.gradle present in the current directory Julia - The package version is extracted from the Project.toml present in the current directory Mix - The mix package version is extracted from the mix.exs present in the current directory Helm - The helm chart version is extracted from the Chart.yaml present in the current directory Maven - The maven package version is extracted from the pom.xml present in the current directory Meson - The meson package version is extracted from the meson.build present in the current directory Shards - The shards package version is extracted from the shard.yml present in the current directory Galaxy - The galaxy package version is extracted from the galaxy.yml present in the current directory V - The vlang package version is extracted from the v.mod present in the current directory SBT - The sbt package version is extracted from the build.sbt present in the current directory Daml - The daml package version is extracted from the daml.yaml present in the current directory Dart - The dart package version is extracted from the pubspec.yaml present in the current directory ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. Options Option Default Description format 'is [$symbol$version]($style) ' The format for the module. symbol '📦 ' The symbol used before displaying the version the package. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch style 'bold 208' The style for the module. display_private false Enable displaying version for packages marked as private. disabled false Disables the package module. Variables Variable Example Description version v1.0.0 The version of your package symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ package ] format = 'via [🎁 $version](208 bold) ' Perl The perl module shows the currently installed version of Perl . By default the module will be shown if any of the following conditions are met: The current directory contains a Makefile.PL or Build.PL file The current directory contains a cpanfile or cpanfile.snapshot file The current directory contains a META.json file or META.yml file The current directory contains a .perl-version file The current directory contains a .pl , .pm or .pod Options Option Default Description format 'via [$symbol($version )]($style)' The format string for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🐪 ' The symbol used before displaying the version of Perl detect_extensions ['pl', 'pm', 'pod'] Which extensions should trigger this module. detect_files ['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'bold 149' The style for the module. disabled false Disables the perl module. Variables Variable Example Description version v5.26.1 The version of perl symbol Mirrors the value of option symbol style Mirrors the value of option style Example toml # ~/.config/starship.toml [ perl ] format = 'via [🦪 $version]($style) ' PHP The php module shows the currently installed version of PHP . By default the module will be shown if any of the following conditions are met: The current directory contains a composer.json file The current directory contains a .php-version file The current directory contains a .php extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🐘 ' The symbol used before displaying the version of PHP. detect_extensions ['php'] Which extensions should trigger this module. detect_files ['composer.json', '.php-version'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style '147 bold' The style for the module. disabled false Disables the php module. Variables Variable Example Description version v7.3.8 The version of php symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ php ] format = 'via [🔹 $version](147 bold) ' Pijul Channel The pijul_channel module shows the active channel of the repo in your current directory. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description symbol ' ' The symbol used before the pijul channel name of the repo in your current directory. style 'bold purple' The style for the module. format 'on [$symbol$channel]($style) ' The format for the module. truncation_length 2^63 - 1 Truncates the pijul channel name to N graphemes truncation_symbol '…' The symbol used to indicate a branch name was truncated. disabled true Disables the pijul module. Pixi The pixi module shows the installed pixi version as well as the activated environment, if $PIXI_ENVIRONMENT_NAME is set. TIP This does not suppress pixi's own prompt modifier, you may want to run pixi config set shell.change-ps1 false . Options Option Default Description format 'via [$symbol($version )($$environment$ )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch . symbol '🧚 ' The symbol used before the environment name. style 'yellow bold' The style for the module. show_default_environment true Whether to indicate that the default environment of your project is activated. pixi_binary ['pixi'] Configures the pixi binary that Starship should execute when getting the version. detect_extensions [] Which extensions should trigger this module. detect_files ['pixi.toml'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. disabled false Disables the pixi module. Variables Variable Example Description version v0.33.0 The version of pixi environment py311 The current pixi environment symbol Mirrors the value of option symbol style Mirrors the value of option style Example toml # ~/.config/starship.toml [ pixi ] format = '[$symbol$environment](yellow) ' Pulumi The pulumi module shows the current username, selected Pulumi Stack , and version. TIP By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, follow the example shown below . By default the module will be shown if any of the following conditions are met: The current directory contains either Pulumi.yaml or Pulumi.yml A parent directory contains either Pulumi.yaml or Pulumi.yml unless search_upwards is set to false Options Option Default Description format 'via [$symbol($username@)$stack]($style) ' The format string for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol ' ' A format string shown before the Pulumi stack. style 'bold 5' The style for the module. search_upwards true Enable discovery of pulumi config files in parent directories. disabled false Disables the pulumi module. Variables Variable Example Description version v0.12.24 The version of pulumi stack dev The current Pulumi stack username alice The current Pulumi username symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example With Pulumi Version toml # ~/.config/starship.toml [ pulumi ] format = '[🛥 ($version )$stack]($style) ' Without Pulumi version toml # ~/.config/starship.toml [ pulumi ] symbol = '🛥 ' format = '[$symbol$stack]($style) ' PureScript The purescript module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met: The current directory contains a spago.dhall file The current directory contains a spago.yaml file The current directory contains a spago.lock file The current directory contains a file with the .purs extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '<=> ' The symbol used before displaying the version of PureScript. detect_extensions ['purs'] Which extensions should trigger this module. detect_files ['spago.dhall', 'spago.yaml', 'spago.lock'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'bold white' The style for the module. disabled false Disables the purescript module. Variables Variable Example Description version 0.13.5 The version of purescript symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ purescript ] format = 'via [$symbol$version](bold white)' Python The python module shows the currently installed version of Python and the current Python virtual environment if one is activated. If pyenv_version_name is set to true , it will display the pyenv version name. Otherwise, it will display the version number from python --version . By default, the module will be shown if any of the following conditions are met: The current directory contains a .python-version file The current directory contains a Pipfile file The current directory contains a __init__.py file The current directory contains a pyproject.toml file The current directory contains a requirements.txt file The current directory contains a setup.py file The current directory contains a tox.ini file The current directory contains a file with the .py extension. The current directory contains a file with the .ipynb extension. A virtual environment is currently activated Options Option Default Description format 'via [${symbol}${pyenv_prefix}(${version} )($$virtualenv$ )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🐍 ' A format string representing the symbol of Python style 'yellow bold' The style for the module. pyenv_version_name false Use pyenv to get Python version pyenv_prefix 'pyenv' Prefix before pyenv version display, only used if pyenv is used python_binary ['python', 'python3', 'python2'] Configures the python binaries that Starship should execute when getting the version. detect_extensions ['py', 'ipynb'] Which extensions should trigger this module detect_files ['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini'] Which filenames should trigger this module detect_folders [] Which folders should trigger this module disabled false Disables the python module. TIP The python_binary variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. The default values and order for python_binary was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a python , no matter if it points to python3 or python2 ). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink /usr/bin/python to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to 'python3' will hide any Python version 2, see example below. Variables Variable Example Description version 'v3.8.1' The version of python symbol '🐍 ' Mirrors the value of option symbol style 'yellow bold' Mirrors the value of option style pyenv_prefix 'pyenv ' Mirrors the value of option pyenv_prefix virtualenv 'venv' The current virtualenv name Example toml # ~/.config/starship.toml [ python ] symbol = '👾 ' pyenv_version_name = true toml # ~/.config/starship.toml [ python ] # Only use the `python3` binary to get the version. python_binary = 'python3' toml # ~/.config/starship.toml [ python ] # Don't trigger for files with the py extension detect_extensions = [] Quarto The quarto module shows the current installed version of Quarto used in a project. By default, the module will be shown if any of the following conditions are met: The current directory contains a _quarto.yml file The current directory contains any .qmd file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '⨁ ' A format string representing the symbol of Quarto style 'bold #75AADB' The style for the module. detect_extensions ['.qmd'] Which extensions should trigger this module. detect_files ['_quarto.yml'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. disabled false Disables the quarto module. Variables Variable Example Description version 1.4.549 The version of quarto symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string R The rlang module shows the currently installed version of R . The module will be shown if any of the following conditions are met: The current directory contains a file with the .R extension. The current directory contains a file with the .Rd extension. The current directory contains a file with the .Rmd extension. The current directory contains a file with the .Rproj extension. The current directory contains a file with the .Rsx extension. The current directory contains a .Rprofile file The current directory contains a .Rproj.user folder Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '📐' A format string representing the symbol of R. style 'blue bold' The style for the module. detect_extensions ['R', 'Rd', 'Rmd', 'Rproj', 'Rsx'] Which extensions should trigger this module detect_files ['.Rprofile'] Which filenames should trigger this module detect_folders ['.Rproj.user'] Which folders should trigger this module disabled false Disables the r module. Variables Variable Example Description version v4.0.5 The version of R symbol Mirrors the value of option symbol style 'blue bold' Mirrors the value of option style Example toml # ~/.config/starship.toml [ rlang ] format = 'with [📐 $version](blue bold) ' Raku The raku module shows the currently installed version of Raku . By default the module will be shown if any of the following conditions are met: The current directory contains a META6.json file The current directory contains a .p6 , .pm6 , .raku , .rakumod or .pod6 Options Option Default Description format 'via [$symbol($version-$vm_version )]($style)' The format string for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🦋 ' The symbol used before displaying the version of Raku detect_extensions ['p6', 'pm6', 'pod6', 'raku', 'rakumod'] Which extensions should trigger this module. detect_files ['META6.json'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'bold 149' The style for the module. disabled false Disables the raku module. Variables Variable Example Description version v6.d The version of raku vm_version moar The version of VM raku is built on symbol Mirrors the value of option symbol style Mirrors the value of option style Example toml # ~/.config/starship.toml [ raku ] format = 'via [🦪 $version]($style) ' Red By default the red module shows the currently installed version of Red . The module will be shown if any of the following conditions are met: The current directory contains a file with .red or .reds extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🔺 ' A format string representing the symbol of Red. detect_extensions ['red'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'red bold' The style for the module. disabled false Disables the red module. Variables Variable Example Description version v2.5.1 The version of red symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ red ] symbol = '🔴 ' Ruby By default the ruby module shows the currently installed version of Ruby . The module will be shown if any of the following conditions are met: The current directory contains a Gemfile file The current directory contains a .ruby-version file The current directory contains a .rb file The environment variables RUBY_VERSION or RBENV_VERSION are set Starship gets the current Ruby version by running ruby -v . Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '💎 ' A format string representing the symbol of Ruby. detect_extensions ['rb'] Which extensions should trigger this module. detect_files ['Gemfile', '.ruby-version'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. detect_variables ['RUBY_VERSION', 'RBENV_VERSION'] Which environment variables should trigger this module. style 'bold red' The style for the module. disabled false Disables the ruby module. Variables Variable Example Description version v2.5.1 The version of ruby symbol Mirrors the value of option symbol style Mirrors the value of option style gemset test Optional, gets the current RVM gemset name. : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ ruby ] symbol = '🔺 ' Rust By default the rust module shows the currently installed version of Rust . The module will be shown if any of the following conditions are met: The current directory contains a Cargo.toml file The current directory contains a file with the .rs extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🦀 ' A format string representing the symbol of Rust detect_extensions ['rs'] Which extensions should trigger this module. detect_files ['Cargo.toml'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'bold red' The style for the module. disabled false Disables the rust module. Variables Variable Example Description version v1.43.0-nightly The version of rustc numver 1.51.0 The numeric component of the rustc version toolchain beta The toolchain version symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ rust ] format = 'via [⚙️ $version](red bold)' Scala The scala module shows the currently installed version of Scala . By default the module will be shown if any of the following conditions are met: The current directory contains a build.sbt , .scalaenv or .sbtenv file The current directory contains a file with the .scala or .sbt extension The current directory contains a directory named .metals Options Option Default Description format 'via [${symbol}(${version} )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch detect_extensions ['sbt', 'scala'] Which extensions should trigger this module. detect_files ['.scalaenv', '.sbtenv', 'build.sbt'] Which filenames should trigger this module. detect_folders ['.metals'] Which folders should trigger this modules. symbol '🆂 ' A format string representing the symbol of Scala. style 'red dimmed' The style for the module. disabled false Disables the scala module. Variables Variable Example Description version 2.13.5 The version of scala symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ scala ] symbol = '🌟 ' Shell The shell module shows an indicator for currently used shell. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description bash_indicator 'bsh' A format string used to represent bash. fish_indicator 'fsh' A format string used to represent fish. zsh_indicator 'zsh' A format string used to represent zsh. powershell_indicator 'psh' A format string used to represent powershell. pwsh_indicator A format string used to represent pwsh. The default value mirrors the value of powershell_indicator . ion_indicator 'ion' A format string used to represent ion. elvish_indicator 'esh' A format string used to represent elvish. tcsh_indicator 'tsh' A format string used to represent tcsh. xonsh_indicator 'xsh' A format string used to represent xonsh. cmd_indicator 'cmd' A format string used to represent cmd. nu_indicator 'nu' A format string used to represent nu. unknown_indicator '' The default value to be displayed when the shell is unknown. format '[$indicator]($style) ' The format for the module. style 'white bold' The style for the module. disabled true Disables the shell module. Variables Variable Default Description indicator Mirrors the value of indicator for currently used shell. style Mirrors the value of option style . : This variable can only be used as a part of a style string Examples toml # ~/.config/starship.toml [ shell ] fish_indicator = '󰈺 ' powershell_indicator = '_' unknown_indicator = 'mystery shell' style = 'cyan bold' disabled = false SHLVL The shlvl module shows the current SHLVL ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description threshold 2 Display threshold. format '[$symbol$shlvl]($style) ' The format for the module. symbol '↕️ ' The symbol used to represent the SHLVL . repeat false Causes symbol to be repeated by the current SHLVL amount. repeat_offset 0 Decrements number of times symbol is repeated by the offset value style 'bold yellow' The style for the module. disabled true Disables the shlvl module. Variables Variable Example Description shlvl 3 The current value of SHLVL symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ shlvl ] disabled = false format = '$shlvl level(s) down' threshold = 3 Using repeat and repeat_offset along with character module, one can get prompt like ❯❯❯ where last character is colored appropriately for return status code and preceding characters are provided by shlvl . toml # ~/.config/starship.toml [ shlvl ] disabled = false format = '[$symbol]($style)' repeat = true symbol = '❯' repeat_offset = 1 Singularity The singularity module shows the current Singularity image, if inside a container and $SINGULARITY_NAME is set. Options Option Default Description format '[$symbol\[$env\]]($style) ' The format for the module. symbol '' A format string displayed before the image name. style 'bold dimmed blue' The style for the module. disabled false Disables the singularity module. Variables Variable Example Description env centos.img The current Singularity image symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ singularity ] format = '[📦 \[$env\]]($style) ' Solidity The solidity module shows the currently installed version of Solidity The module will be shown if any of the following conditions are met: The current directory contains a file with the .sol extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${major}.${minor}.${patch}' The version format. Available vars are raw , major , minor , & patch symbol 'S ' A format string representing the symbol of Solidity `compiler ['solc'] The default compiler for Solidity. detect_extensions ['sol'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'bold blue' The style for the module. disabled false Disables this module. Variables Variable Example Description version v0.8.1 The version of solidity symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ solidity ] format = "via [S $version](blue bold)" Spack The spack module shows the current Spack environment, if $SPACK_ENV is set. Options Option Default Description truncation_length 1 The number of directories the environment path should be truncated to. 0 means no truncation. Also see the directory module. symbol '🅢 ' The symbol used before the environment name. style 'bold blue' The style for the module. format 'via [$symbol$environment]($style) ' The format for the module. disabled false Disables the spack module. Variables Variable Example Description environment astronauts The current spack environment symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ spack ] format = '[$symbol$environment](dimmed blue) ' Status The status module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not 0 . The status code will cast to a signed 32-bit integer. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description format '[$symbol$status]($style) ' The format of the module symbol '❌' The symbol displayed on program error success_symbol '' The symbol displayed on program success not_executable_symbol '🚫' The symbol displayed when file isn't executable not_found_symbol '🔍' The symbol displayed when the command can't be found sigint_symbol '🧱' The symbol displayed on SIGINT (Ctrl + c) signal_symbol '⚡' The symbol displayed on any signal style 'bold red' The style for the module. success_style The style used on program success (defaults to style if unset). failure_style The style used on program failure (defaults to style if unset). recognize_signal_code true Enable signal mapping from exit code map_symbol false Enable symbols mapping from exit code pipestatus false Enable pipestatus reporting pipestatus_separator \| The symbol used to separate pipestatus segments (supports formatting) pipestatus_format '\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style) ' The format of the module when the command is a pipeline pipestatus_segment_format When specified, replaces format when formatting pipestatus segments disabled true Disables the status module. Variables Variable Example Description status 127 The exit code of the last command hex_status 0x7F The exit code of the last command in hex int 127 The exit code of the last command common_meaning ERROR Meaning of the code if not a signal signal_number 9 Signal number corresponding to the exit code, only if signalled signal_name KILL Name of the signal corresponding to the exit code, only if signalled maybe_int 7 Contains the exit code number when no meaning has been found pipestatus Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format symbol Mirrors the value of option symbol style Mirrors the value of option success_style on program success and failure_style otherwise : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ status ] style = 'bg:blue' symbol = '🔴 ' success_symbol = '🟢 SUCCESS' format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false Sudo The sudo module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description format '[as $symbol]($style)' The format of the module symbol '🧙 ' The symbol displayed when credentials are cached style 'bold blue' The style for the module. allow_windows false Since windows has no default sudo, default is disabled. disabled true Disables the sudo module. Variables Variable Example Description symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ sudo ] style = 'bold green' symbol = '👩‍💻 ' disabled = false toml # On windows # $HOME\.starship\config.toml [ sudo ] allow_windows = true disabled = false Swift By default the swift module shows the currently installed version of Swift . The module will be shown if any of the following conditions are met: The current directory contains a Package.swift file The current directory contains a file with the .swift extension Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '🐦 ' A format string representing the symbol of Swift detect_extensions ['swift'] Which extensions should trigger this module. detect_files ['Package.swift'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'bold 202' The style for the module. disabled false Disables the swift module. Variables Variable Example Description version v5.2.4 The version of swift symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ swift ] format = 'via [🏎 $version](red bold)' Terraform The terraform module shows the currently selected Terraform workspace and version. It supports both Hashicorp Terraform and OpenTofu for version detection. TIP By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, follow the example shown below . By default the module will be shown if any of the following conditions are met: The current directory contains a .terraform folder Current directory contains a file with the .tf , .tfplan or .tfstate extensions Options Option Default Description format 'via [$symbol$workspace]($style) ' The format string for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '💠' A format string shown before the terraform workspace. detect_extensions ['tf', 'tfplan', 'tfstate'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders ['.terraform'] Which folders should trigger this module. style 'bold 105' The style for the module. disabled false Disables the terraform module. commands [ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ] How to detect what the Terraform version is. Variables Variable Example Description version v0.12.24 The version of terraform workspace default The current Terraform workspace symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example With Terraform Version toml # ~/.config/starship.toml [ terraform ] format = 'via [$symbol$version $workspace]($style) ' Without Terraform version toml # ~/.config/starship.toml [ terraform ] format = 'via [$symbol$workspace]($style) ' Time The time module shows the current local time. The format configuration value is used by the chrono crate to control how the time is displayed. Take a look at the chrono strftime docs to see what options are available. TIP This module is disabled by default. To enable it, set disabled to false in your configuration file. Options Option Default Description format 'at [$time]($style) ' The format string for the module. use_12hr false Enables 12 hour formatting time_format see below The chrono format string used to format the time. style 'bold yellow' The style for the module time utc_time_offset 'local' Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. disabled true Disables the time module. time_range '-' Sets the time range during which the module will be shown. Times must be specified in 24-hours format If use_12hr is true , then time_format defaults to '%r' . Otherwise, it defaults to '%T' . Manually setting time_format will override the use_12hr setting. Variables Variable Example Description time 13:08:10 The current time. style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ time ] disabled = false format = '🕙[\[ $time \]]($style) ' time_format = '%T' utc_time_offset = '-5' time_range = '10:00:00-14:00:00' Typst The typst module shows the current installed version of Typst used in a project. By default, the module will be shown if any of the following conditions are met: The current directory contains a template.typ file The current directory contains any .typ file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol 't ' A format string representing the symbol of Typst style 'bold #0093A7' The style for the module. detect_extensions ['.typ'] Which extensions should trigger this module. detect_files ['template.typ'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. disabled false Disables the typst module. Variables Variable Example Description version v0.9.0 The version of typst , alias for typst_version typst_version default The current Typst version symbol Mirrors the value of option symbol style* Mirrors the value of option style : This variable can only be used as a part of a style string Username The username module shows active user's username. The module will be shown if any of the following conditions are met: The current user is root/admin The current user isn't the same as the one that is logged in The user is currently connected as an SSH session The variable show_always is set to true The array detect_env_vars contains at least the name of one environment variable, that is set TIP SSH connection is detected by checking environment variables SSH_CONNECTION , SSH_CLIENT , and SSH_TTY . If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. Options Option Default Description style_root 'bold red' The style used when the user is root/admin. style_user 'bold yellow' The style used for non-root users. detect_env_vars [] Which environment variable(s) should trigger this module. format '[$user]($style) in ' The format for the module. show_always false Always shows the username module. disabled false Disables the username module. aliases {} Translate system usernames to something else. Variables Variable Example Description style 'red bold' Mirrors the value of option style_root when root is logged in and style_user otherwise. user 'matchai' The currently logged-in user ID. Example Always show the username toml # ~/.config/starship.toml [ username ] style_user = 'white bold' style_root = 'black bold' format = 'user: [$user]($style) ' disabled = false show_always = true aliases = { "corpuser034g" = "matchai" } Vagrant The vagrant module shows the currently installed version of Vagrant . By default the module will be shown if any of the following conditions are met: The current directory contains a Vagrantfile file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '⍱ ' A format string representing the symbol of Vagrant. detect_extensions [] Which extensions should trigger this module. detect_files ['Vagrantfile'] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'cyan bold' The style for the module. disabled false Disables the vagrant module. Variables Variable Example Description version Vagrant 2.2.10 The version of Vagrant symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ vagrant ] format = 'via [⍱ $version](bold white) ' V The vlang module shows you your currently installed version of V . By default the module will be shown if any of the following conditions are met: The current directory contains a file with .v extension The current directory contains a v.mod , vpkg.json or .vpkg-lock.json file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol 'V ' A format string representing the symbol of V detect_extensions ['v'] Which extensions should trigger this module. detect_files ['v.mod', 'vpkg.json', '.vpkg-lock.json' ] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. style 'blue bold' The style for the module. disabled false Disables the vlang module. Variables Variable Example Description version v0.2 The version of v symbol Mirrors the value of option symbol style Mirrors the value of option style Example toml # ~/.config/starship.toml [ vlang ] format = 'via [V $version](blue bold) ' VCSH The vcsh module displays the current active VCSH repository. The module will be shown only if a repository is currently in use. Options Option Default Description symbol '' The symbol used before displaying the repository name. style 'bold yellow' The style for the module. format 'vcsh [$symbol$repo]($style) ' The format for the module. disabled false Disables the vcsh module. Variables Variable Example Description repo dotfiles if in a VCSH repo named dotfiles The active repository name symbol Mirrors the value of option symbol style* black bold dimmed Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ vcsh ] format = '[🆅 $repo](bold blue) ' XMake The xmake module shows the currently installed version of XMake . By default the module will be activated if any of the following conditions are met: The current directory contains a xmake.lua file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '△ ' The symbol used before the version of cmake. detect_extensions [] Which extensions should trigger this module detect_files ['xmake.lua'] Which filenames should trigger this module detect_folders [] Which folders should trigger this module style 'bold green' The style for the module. disabled false Disables the xmake module. Variables Variable Example Description version v2.9.5 The version of xmake symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Zig By default the zig module shows the currently installed version of Zig . The module will be shown if any of the following conditions are met: The current directory contains a .zig file Options Option Default Description format 'via [$symbol($version )]($style)' The format for the module. version_format 'v${raw}' The version format. Available vars are raw , major , minor , & patch symbol '↯ ' The symbol used before displaying the version of Zig. style 'bold yellow' The style for the module. disabled false Disables the zig module. detect_extensions ['zig'] Which extensions should trigger this module. detect_files [] Which filenames should trigger this module. detect_folders [] Which folders should trigger this module. Variables Variable Example Description version v0.6.0 The version of zig symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Example toml # ~/.config/starship.toml [ zig ] symbol = '⚡️ ' Custom commands The custom modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: The current directory contains a file whose name is in detect_files The current directory contains a directory whose name is in detect_folders The current directory contains a file whose extension is in detect_extensions The when command returns 0 The current Operating System (std::env::consts::OS) matches with os field if defined. TIP Multiple custom modules can be defined by using a . . TIP The order in which custom modules are shown can be individually set by including ${custom.foo} in the top level format (as it includes a dot, you need to use ${...} ). By default, the custom module will simply show all custom modules in the order they were defined. TIP Issue #1252 contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! WARNING If unsafe_no_escape is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. \h , but this module will not work in a fish or zsh shell. Format strings can also contain shell specific prompt sequences, e.g. Bash , Zsh . Options Option Default Description command '' The command whose output should be printed. The command will be passed on stdin to the shell. when false Either a boolean value ( true or false , without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the shell returns a 0 status code from executing it. require_repo false If true , the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. shell See below description '<custom module>' The description of the module that is shown when running starship explain . unsafe_no_escape false When set, command output is not escaped of characters that could be interpreted by the shell. detect_files [] The files that will be searched in the working directory for a match. detect_folders [] The directories that will be searched in the working directory for a match. detect_extensions [] The extensions that will be searched in the working directory for a match. symbol '' The symbol used before displaying the command output. style 'bold green' The style for the module. format '[$symbol($output )]($style)' The format for the module. disabled false Disables this custom module. os Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) See possible values . use_stdin An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. ignore_timeout false Ignore global command_timeout setting and keep running external commands, no matter how long they take. Variables Variable Description output The output of command run in shell symbol Mirrors the value of option symbol style Mirrors the value of option style : This variable can only be used as a part of a style string Custom command shell shell accepts a non-empty list of strings, where: The first string is the path to the shell to use to execute the command. Other following arguments are passed to the shell. If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows. The command (and when , if applicable) will be passed in on stdin. If shell is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command - . If shell is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: /C and stdin will be set to false . If shell is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: -c and stdin will be set to false . This behavior can be avoided by explicitly passing arguments to the shell, e.g. toml shell = [ 'pwsh' , '-Command' , '-' ] WARNING Make sure your custom shell configuration exits gracefully If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the shell option). For example, PowerShell requires the -Command parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop. Parameters similar to -NoProfile in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation. Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. Please open an issue with shell details and starship configuration if you hit such scenario. Example toml # ~/.config/starship.toml [ custom . foo ] command = 'echo foo' # shows output of command detect_files = [ 'foo' ] # can specify filters but wildcards are not supported when = ''' test "$HOME" = "$PWD" ''' format = ' transcending [$output]($style)' [ custom . time ] command = 'time /T' detect_extensions = [ 'pst' ] # filters .pst files shell = [ 'pwsh.exe' , '-NoProfile' , '-Command' , '-' ] [ custom . time-as-arg ] command = 'time /T' detect_extensions = [ 'pst' ] # filters *.pst files shell = [ 'pwsh.exe' , '-NoProfile' , '-Command' ] use_stdin = false
Markdown	[Skip to content](https://starship.rs/config/#VPContent) [![](https://starship.rs/icon.png)Starship](https://starship.rs/) Search`K` Main Navigation [Configuration](https://starship.rs/config/) English [Deutsch](https://starship.rs/de-DE/config/) [Español](https://starship.rs/es-ES/config/) [Français](https://starship.rs/fr-FR/config/) [Bahasa Indonesia](https://starship.rs/id-ID/config/) [Italiano](https://starship.rs/it-IT/config/) [日本語](https://starship.rs/ja-JP/config/) [Português do Brasil](https://starship.rs/pt-BR/config/) [Русский](https://starship.rs/ru-RU/config/) [Українська](https://starship.rs/uk-UA/config/) [Tiếng Việt](https://starship.rs/vi-VN/config/) [简体中文](https://starship.rs/zh-CN/config/) [繁體中文](https://starship.rs/zh-TW/config/) English [Deutsch](https://starship.rs/de-DE/config/) [Español](https://starship.rs/es-ES/config/) [Français](https://starship.rs/fr-FR/config/) [Bahasa Indonesia](https://starship.rs/id-ID/config/) [Italiano](https://starship.rs/it-IT/config/) [日本語](https://starship.rs/ja-JP/config/) [Português do Brasil](https://starship.rs/pt-BR/config/) [Русский](https://starship.rs/ru-RU/config/) [Українська](https://starship.rs/uk-UA/config/) [Tiếng Việt](https://starship.rs/vi-VN/config/) [简体中文](https://starship.rs/zh-CN/config/) [繁體中文](https://starship.rs/zh-TW/config/) Appearance Menu Return to top Sidebar Navigation [Guide](https://starship.rs/guide/) [Installation](https://starship.rs/installing/) [Configuration](https://starship.rs/config/) [Advanced Configuration](https://starship.rs/advanced-config/) [FAQ](https://starship.rs/faq/) [Presets](https://starship.rs/presets/) On this page # Configuration [](https://starship.rs/config/#configuration) To get started configuring starship, create the following file: `~/.config/starship.toml`. sh ``` mkdir -p ~/.config && touch ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: toml ``` # Get editor completions based on the config schema "$schema" = 'https://starship.rs/config-schema.json' # Inserts a blank line between shell prompts add_newline = true # Replace the '❯' symbol in the prompt with '➜' [character] # The name of the module we are configuring is 'character' success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green' # Disable the package module, hiding it from the prompt completely [package] disabled = true ``` ### Config File Location [](https://starship.rs/config/#config-file-location) You can change default configuration file location with `STARSHIP_CONFIG` environment variable: sh ``` export STARSHIP_CONFIG=~/example/non/default/path/starship.toml ``` Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: powershell ``` $ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml" ``` Or for Cmd (Windows) would be adding this line to your `starship.lua`: lua ``` os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml') ``` ### Logging [](https://starship.rs/config/#logging) By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to an instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable: sh ``` export STARSHIP_CACHE=~/.starship/cache ``` Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: powershell ``` $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ``` Or for Cmd (Windows) would be adding this line to your `starship.lua`: lua ``` os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp') ``` ### Terminology [](https://starship.rs/config/#terminology) Module: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. Variable: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. ### Strings [](https://starship.rs/config/#strings) In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`. The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`. \| Symbol \| Type \| Notes \| \|---\|---\|---\| \| `'` \| literal string \| less escaping \| \| `"` \| string \| more escaping \| \| `'''` \| multi-line literal string \| less escaping \| \| `"""` \| multi-line string \| more escaping, newlines in declarations can be ignored \| For example: toml ``` # literal string format = '☺\☻ ' # regular string format = "☺\\☻ " # escaping Starship symbols format = '\[\$\] ' ``` When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent: toml ``` # with literal string format = ''' \$''' # with multiline basic string format = """ \\$""" # with basic string format = "\n\\$" ``` In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them. toml ``` format = """ line1\ line1\ line1 line2\ line2\ line2 """ ``` ### Format Strings [](https://starship.rs/config/#format-strings) Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string. #### Variable [](https://starship.rs/config/#variable) A variable contains a `$` symbol followed by the name of the variable. The name of a variable can only contain letters, numbers and `_`. For example: - `'$version'` is a format string with a variable named `version`. - `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`. - `'$git_branch $git_commit'` has the two variables separated with a space. #### Text Group [](https://starship.rs/config/#text-group) A text group is made up of two different parts. The first part, which is enclosed in a `[]`, is a [format string](https://starship.rs/config/#format-strings). You can add texts, variables, or even nested text groups in it. In the second part, which is enclosed in a `()`, is a [style string](https://starship.rs/config/#style-strings). This can be used to style the first part. For example: - `'[on](red bold)'` will print a string `on` with bold text colored red. - `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green. #### Style Strings [](https://starship.rs/config/#style-strings) Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](https://starship.rs/advanced-config/). - `'fg:green bg:blue'` sets green text on a blue background - `'bg:blue fg:bright-green'` sets bright green text on a blue background - `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27 - `'underline bg:#bf5700'` sets underlined text on a burnt orange background - `'bold italic fg:purple'` sets bold italic purple text - `''` explicitly disables all styling Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics. #### Conditional Format Strings [](https://starship.rs/config/#conditional-format-strings) A conditional format string wrapped in `(` and `)` will not render if all variables inside are empty. For example: - `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region. - `'(some text)'` will always show nothing since there are no variables wrapped in the braces. - When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`. ### Negative matching [](https://starship.rs/config/#negative-matching) Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of any negative indicator in the directory will result in the module not being matched. Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all. To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus: toml ``` detect_extensions = ['ts', '!video.ts', '!audio.ts'] ``` ## Prompt [](https://starship.rs/config/#prompt) This is the list of prompt-wide configuration options. ### Options [](https://starship.rs/config/#options) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| [link](https://starship.rs/config/#default-prompt-format) \| Configure the format of the prompt. \| \| `right_format` \| `''` \| See [Enable Right Prompt](https://starship.rs/advanced-config/#enable-right-prompt) \| \| `scan_timeout` \| `30` \| Timeout for starship to scan files (in milliseconds). \| \| `command_timeout` \| `500` \| Timeout for commands executed by starship (in milliseconds). \| \| `add_newline` \| `true` \| Inserts blank line between shell prompts. \| \| `palette` \| `''` \| Sets which color palette from `palettes` to use. \| \| `palettes` \| `{}` \| Collection of color palettes that assign [colors](https://starship.rs/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. \| \| `follow_symlinks` \| `true` \| Follows symlinks to check if they're directories; used in modules such as git. \| TIP If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Example [](https://starship.rs/config/#example) toml ``` # ~/.config/starship.toml # Use custom format format = ''' [┌───────────────────>](bold green) [│](bold green)$directory$rust$package [└─>](bold green) ''' # Wait 10 milliseconds for starship to check files under the current directory. scan_timeout = 10 # Disable the blank line at the start of the prompt add_newline = false # Set 'foo' as custom color palette palette = 'foo' # Define custom colors [palettes.foo] # Overwrite existing color blue = '21' # Define new color mustard = '#af8700' ``` ### Default Prompt Format [](https://starship.rs/config/#default-prompt-format) The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown: toml ``` format = '$all' # Which is equivalent to format = """ $username\ $hostname\ $localip\ $shlvl\ $singularity\ $kubernetes\ $directory\ $vcsh\ $fossil_branch\ $fossil_metrics\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ $hg_state\ $pijul_channel\ $docker_context\ $package\ $c\ $cmake\ $cobol\ $daml\ $dart\ $deno\ $dotnet\ $elixir\ $elm\ $erlang\ $fennel\ $fortran\ $gleam\ $golang\ $guix_shell\ $haskell\ $haxe\ $helm\ $java\ $julia\ $kotlin\ $gradle\ $lua\ $nim\ $nodejs\ $ocaml\ $opa\ $perl\ $php\ $pulumi\ $purescript\ $python\ $quarto\ $raku\ $rlang\ $red\ $ruby\ $rust\ $scala\ $solidity\ $swift\ $terraform\ $typst\ $vlang\ $vagrant\ $zig\ $buf\ $nix_shell\ $conda\ $meson\ $spack\ $memory_usage\ $aws\ $gcloud\ $openstack\ $azure\ $nats\ $direnv\ $env_var\ $mise\ $crystal\ $custom\ $sudo\ $cmd_duration\ $line_break\ $jobs\ $battery\ $time\ $status\ $os\ $container\ $netns\ $shell\ $character""" ``` If you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. Eg. toml ``` # Move the directory to the second line format = '$all$directory$character' ``` ## AWS [](https://starship.rs/config/#aws) The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. When using [AWSume](https://awsu.me/) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var. When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key. When using [aws-sso-cli](https://github.com/synfinatic/aws-sso-cli) the profile is read from the `AWS_SSO_PROFILE` env var. ### Options [](https://starship.rs/config/#options-1) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'on [$symbol($profile )($$region$ )(\[$duration\] )]($style)'` \| The format for the module. \| \| `symbol` \| `'☁️ '` \| The symbol used before displaying the current AWS profile. \| \| `region_aliases` \| `{}` \| Table of region aliases to display in addition to the AWS name. \| \| `profile_aliases` \| `{}` \| Table of profile aliases to display in addition to the AWS name. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `expiration_symbol` \| `'X'` \| The symbol displayed when the temporary credentials have expired. \| \| `disabled` \| `false` \| Disables the `AWS` module. \| \| `force_display` \| `false` \| If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. \| ### Variables [](https://starship.rs/config/#variables) \| Variable \| Example \| Description \| \|---\|---\|---\| \| region \| `ap-northeast-1` \| The current AWS region \| \| profile \| `astronauts` \| The current AWS profile \| \| duration \| `2h27m20s` \| The temporary credentials validity duration \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Examples [](https://starship.rs/config/#examples) #### Display everything [](https://starship.rs/config/#display-everything) toml ``` # ~/.config/starship.toml [aws] format = 'on [$symbol($profile )($$region$ )]($style)' style = 'bold blue' symbol = '🅰 ' [aws.region_aliases] ap-southeast-2 = 'au' us-east-1 = 'va' [aws.profile_aliases] CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region [](https://starship.rs/config/#display-region) toml ``` # ~/.config/starship.toml [aws] format = 'on [$symbol$region]($style) ' style = 'bold blue' symbol = '🅰 ' [aws.region_aliases] ap-southeast-2 = 'au' us-east-1 = 'va' ``` #### Display profile [](https://starship.rs/config/#display-profile) toml ``` # ~/.config/starship.toml [aws] format = 'on [$symbol$profile]($style) ' style = 'bold blue' symbol = '🅰 ' [aws.profile_aliases] Enterprise_Naming_Scheme-voidstars = 'void' ``` ## Azure [](https://starship.rs/config/#azure) The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-2) \| Variable \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'on [$symbol($subscription)]($style) '` \| The format for the Azure module to render. \| \| `symbol` \| `'󰠅 '` \| The symbol used in the format. \| \| `style` \| `'blue bold'` \| The style used in the format. \| \| `disabled` \| `true` \| Disables the `azure` module. \| \| `subscription_aliases` \| `{}` \| Table of subscription name aliases to display in addition to Azure subscription name. \| ### Examples [](https://starship.rs/config/#examples-1) #### Display Subscription Name [](https://starship.rs/config/#display-subscription-name) toml ``` # ~/.config/starship.toml [azure] disabled = false format = 'on [$symbol($subscription)]($style) ' symbol = '󰠅 ' style = 'blue bold' ``` #### Display Username [](https://starship.rs/config/#display-username) toml ``` # ~/.config/starship.toml [azure] disabled = false format = "on [$symbol($username)]($style) " symbol = "󰠅 " style = "blue bold" ``` #### Display Subscription Name Alias [](https://starship.rs/config/#display-subscription-name-alias) toml ``` # ~/.config/starship.toml [azure.subscription_aliases] very-long-subscription-name = 'vlsn' ``` ## Battery [](https://starship.rs/config/#battery) The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. ### Options [](https://starship.rs/config/#options-3) \| Option \| Default \| Description \| \|---\|---\|---\| \| `full_symbol` \| `'󰁹 '` \| The symbol shown when the battery is full. \| \| `charging_symbol` \| `'󰂄 '` \| The symbol shown when the battery is charging. \| \| `discharging_symbol` \| `'󰂃 '` \| The symbol shown when the battery is discharging. \| \| `unknown_symbol` \| `'󰁽 '` \| The symbol shown when the battery state is unknown. \| \| `empty_symbol` \| `'󰂎 '` \| The symbol shown when the battery state is empty. \| \| `format` \| `'[$symbol$percentage]($style) '` \| The format for the module. \| \| `display` \| [link](https://starship.rs/config/#battery-display) \| Display threshold and style for the module. \| \| `disabled` \| `false` \| Disables the `battery` module. \| ### Example [](https://starship.rs/config/#example-1) toml ``` # ~/.config/starship.toml [battery] full_symbol = '🔋 ' charging_symbol = '⚡️ ' discharging_symbol = '💀 ' ``` ### Battery Display [](https://starship.rs/config/#battery-display) The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. The default is as shown: toml ``` [[battery.display]] threshold = 10 style = 'bold red' ``` The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option. #### Options [](https://starship.rs/config/#options-4) The `display` option is an array of the following table. \| Option \| Default \| Description \| \|---\|---\|---\| \| `threshold` \| `10` \| The upper bound for the display option. \| \| `style` \| `'red bold'` \| The style used if the display option is in use. \| \| `charging_symbol` \| \| Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. \| \| `discharging_symbol` \| \| Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. \| #### Example [](https://starship.rs/config/#example-2) toml ``` [[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10% threshold = 10 style = 'bold red' [[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30% threshold = 30 style = 'bold yellow' discharging_symbol = '💦 ' # when capacity is over 30%, the battery indicator will not be displayed ``` ## Buf [](https://starship.rs/config/#buf) The `buf` module shows the currently installed version of [Buf](https://buf.build/). By default, the module is shown if the current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file. ### Options [](https://starship.rs/config/#options-5) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'with [$symbol($version )]($style)'` \| The format for the `buf` module. \| \| `version_format` \| `'v${raw}'` \| The version format. \| \| `symbol` \| `'🐃 '` \| The symbol used before displaying the version of Buf. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `elixir` module. \| ### Variables [](https://starship.rs/config/#variables-1) \| Variable \| Example \| Description \| \|---\|---\|---\| \| `version` \| `v1.0.0` \| The version of `buf` \| \| `symbol` \| \| Mirrors the value of option `symbol` \| \| `style`\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-3) toml ``` # ~/.config/starship.toml [buf] symbol = '🦬 ' ``` ## Bun [](https://starship.rs/config/#bun) The `bun` module shows the currently installed version of the [bun](https://bun.sh/) JavaScript runtime. By default the module will be shown if any of the following conditions are met: - The current directory contains a `bun.lock` file - The current directory contains a `bun.lockb` file - The current directory contains a `bunfig.toml` file ### Options [](https://starship.rs/config/#options-6) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🥟 '` \| A format string representing the symbol of Bun. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['bun.lock', 'bun.lockb', 'bunfig.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold red'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `bun` module. \| ### Variables [](https://starship.rs/config/#variables-2) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.1.4` \| The version of `bun` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-4) #### Customize the format [](https://starship.rs/config/#customize-the-format) toml ``` # ~/.config/starship.toml [bun] format = 'via [🍔 $version](bold green) ' ``` ## C [](https://starship.rs/config/#c) The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. ### Options [](https://starship.rs/config/#options-7) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version(-$name) )]($style)'` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'C '` \| The symbol used before displaying the compiler details \| \| `detect_extensions` \| `['c', 'h']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `commands` \| `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` \| How to detect what the compiler is \| \| `style` \| `'bold 149'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `c` module. \| ### Variables [](https://starship.rs/config/#variables-3) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| clang \| The name of the compiler \| \| version \| 13\.0.0 \| The version of the compiler \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style \| \| Mirrors the value of option `style` \| ### Commands [](https://starship.rs/config/#commands) The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example [](https://starship.rs/config/#example-5) toml ``` # ~/.config/starship.toml [c] format = 'via [$name $version]($style)' ``` ## CPP [](https://starship.rs/config/#cpp) The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`\-related files. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-8) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version(-$name) )]($style)'` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'C++ '` \| The symbol used before displaying the compiler details \| \| `detect_extensions` \| `['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `commands` \| `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` \| How to detect what the compiler is \| \| `style` \| `'bold 149'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `cpp` module. \| ### Variables [](https://starship.rs/config/#variables-4) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| clang++ \| The name of the compiler \| \| version \| 13\.0.0 \| The version of the compiler \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style \| \| Mirrors the value of option `style` \| ### Commands [](https://starship.rs/config/#commands-1) The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example [](https://starship.rs/config/#example-6) toml ``` # ~/.config/starship.toml [cpp] disabled = false format = 'via [$name $version]($style)' ``` ## Character [](https://starship.rs/config/#character) The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. The character will tell you whether the last command was successful or not. It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) By default it only changes color. If you also want to change its shape take a look at [this example](https://starship.rs/config/#with-custom-error-shape). WARNING `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options [](https://starship.rs/config/#options-9) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'$symbol '` \| The format string used before the text input. \| \| `success_symbol` \| `'[❯](bold green)'` \| The format string used before the text input if the previous command succeeded. \| \| `error_symbol` \| `'[❯](bold red)'` \| The format string used before the text input if the previous command failed. \| \| `vimcmd_symbol` \| `'[❮](bold green)'` \| The format string used before the text input if the shell is in vim normal mode. \| \| `vimcmd_replace_one_symbol` \| `'[❮](bold purple)'` \| The format string used before the text input if the shell is in vim `replace_one` mode. \| \| `vimcmd_replace_symbol` \| `'[❮](bold purple)'` \| The format string used before the text input if the shell is in vim replace mode. \| \| `vimcmd_visual_symbol` \| `'[❮](bold yellow)'` \| The format string used before the text input if the shell is in vim visual mode. \| \| `disabled` \| `false` \| Disables the `character` module. \| ### Variables [](https://starship.rs/config/#variables-5) \| Variable \| Example \| Description \| \|---\|---\|---\| \| symbol \| \| A mirror of either `success_symbol`, `error_symbol`, `vimcmd_symbol` or `vimcmd_replace_one_symbol` etc. \| ### Examples [](https://starship.rs/config/#examples-2) #### With custom error shape [](https://starship.rs/config/#with-custom-error-shape) toml ``` # ~/.config/starship.toml [character] success_symbol = '[➜](bold green) ' error_symbol = '[✗](bold red) ' ``` #### Without custom error shape [](https://starship.rs/config/#without-custom-error-shape) toml ``` # ~/.config/starship.toml [character] success_symbol = '[➜](bold green) ' error_symbol = '[➜](bold red) ' ``` #### With custom vim shape [](https://starship.rs/config/#with-custom-vim-shape) toml ``` # ~/.config/starship.toml [character] vimcmd_symbol = '[V](bold green) ' ``` ## CMake [](https://starship.rs/config/#cmake) The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Options [](https://starship.rs/config/#options-10) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'△ '` \| The symbol used before the version of cmake. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module \| \| `detect_files` \| `['CMakeLists.txt', 'CMakeCache.txt']` \| Which filenames should trigger this module \| \| `detect_folders` \| `[]` \| Which folders should trigger this module \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `cmake` module. \| ### Variables [](https://starship.rs/config/#variables-6) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v3.17.3` \| The version of cmake \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## COBOL / GNUCOBOL [](https://starship.rs/config/#cobol-gnucobol) The `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met: - The current directory contains any files ending in `.cob` or `.COB` - The current directory contains any files ending in `.cbl` or `.CBL` ### Options [](https://starship.rs/config/#options-11) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'⚙️ '` \| The symbol used before displaying the version of COBOL. \| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `detect_extensions` \| `['cbl', 'cob', 'CBL', 'COB']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `cobol` module. \| ### Variables [](https://starship.rs/config/#variables-7) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v3.1.2.0` \| The version of `cobol` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Command Duration [](https://starship.rs/config/#command-duration) The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. WARNING Do not hook the DEBUG trap in Bash If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module will* break. Bash users who need preexec-like functionality can use [rcaloras's bash\_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### Options [](https://starship.rs/config/#options-12) \| Option \| Default \| Description \| \|---\|---\|---\| \| `min_time` \| `2_000` \| Shortest duration to show time for (in milliseconds). \| \| `show_milliseconds` \| `false` \| Show milliseconds in addition to seconds for the duration. \| \| `format` \| `'took [$duration]($style) '` \| The format for the module. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `cmd_duration` module. \| \| `show_notifications` \| `false` \| Show desktop notifications when command completes. \| \| `min_time_to_notify` \| `45_000` \| Shortest duration for notification (in milliseconds). \| \| `notification_timeout` \| \| Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. \| ### Variables [](https://starship.rs/config/#variables-8) \| Variable \| Example \| Description \| \|---\|---\|---\| \| duration \| `16m40s` \| The time it took to execute the command \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-7) toml ``` # ~/.config/starship.toml [cmd_duration] min_time = 500 format = 'underwent [$duration](bold yellow)' ``` ## Conda [](https://starship.rs/config/#conda) The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. TIP This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh/), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options [](https://starship.rs/config/#options-13) \| Option \| Default \| Description \| \|---\|---\|---\| \| `truncation_length` \| `1` \| The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](https://starship.rs/config/#directory) module. \| \| `symbol` \| `'🅒 '` \| The symbol used before the environment name. \| \| `style` \| `'bold green'` \| The style for the module. \| \| `format` \| `'via [$symbol$environment]($style) '` \| The format for the module. \| \| `ignore_base` \| `true` \| Ignores `base` environment when activated. \| \| `detect_env_vars` \| `["!PIXI_ENVIRONMENT_NAME"]` \| Which environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default. \| \| `disabled` \| `false` \| Disables the `conda` module. \| ### Variables [](https://starship.rs/config/#variables-9) \| Variable \| Example \| Description \| \|---\|---\|---\| \| environment \| `astronauts` \| The current conda environment \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-8) toml ``` # ~/.config/starship.toml [conda] format = '[$symbol$environment](dimmed green) ' ``` ## Container [](https://starship.rs/config/#container) The `container` module displays a symbol and container name, if inside a container. ### Options [](https://starship.rs/config/#options-14) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'⬢'` \| The symbol shown, when inside a container \| \| `style` \| `'bold red dimmed'` \| The style for the module. \| \| `format` \| `'[$symbol \[$name\]]($style) '` \| The format for the module. \| \| `disabled` \| `false` \| Disables the `container` module. \| ### Variables [](https://starship.rs/config/#variables-10) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| `fedora-toolbox:35` \| The name of the container \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-9) toml ``` # ~/.config/starship.toml [container] format = '[$symbol \[$name\]]($style) ' ``` ## Crystal [](https://starship.rs/config/#crystal) The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options [](https://starship.rs/config/#options-15) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'🔮 '` \| The symbol used before displaying the version of crystal. \| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `style` \| `'bold red'` \| The style for the module. \| \| `detect_extensions` \| `['cr']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['shard.yml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `crystal` module. \| ### Variables [](https://starship.rs/config/#variables-11) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.32.1` \| The version of `crystal` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-10) toml ``` # ~/.config/starship.toml [crystal] format = 'via [✨ $version](bold blue) ' ``` ## Daml [](https://starship.rs/config/#daml) The `daml` module shows the currently used [Daml](https://www.digitalasset.com/developers) SDK version when you are in the root directory of your Daml project. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. By default the module will be shown if any of the following conditions are met: - The current directory contains a `daml.yaml` file ### Options [](https://starship.rs/config/#options-16) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'Λ '` \| A format string representing the symbol of Daml \| \| `style` \| `'bold cyan'` \| The style for the module. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['daml.yaml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `daml` module. \| ### Variables [](https://starship.rs/config/#variables-12) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v2.2.0` \| The version of `daml` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-11) toml ``` # ~/.config/starship.toml [daml] format = 'via [D $version](bold bright-green) ' ``` ## Dart [](https://starship.rs/config/#dart) The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file ### Options [](https://starship.rs/config/#options-17) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🎯 '` \| A format string representing the symbol of Dart \| \| `detect_extensions` \| `['dart']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['.dart_tool']` \| Which folders should trigger this module. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `dart` module. \| ### Variables [](https://starship.rs/config/#variables-13) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v2.8.4` \| The version of `dart` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-12) toml ``` # ~/.config/starship.toml [dart] format = 'via [🔰 $version](bold red) ' ``` ## Deno [](https://starship.rs/config/#deno) The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options [](https://starship.rs/config/#options-18) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🦕 '` \| A format string representing the symbol of Deno \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['deno.json', 'deno.jsonc', 'deno.lock', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'green bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `deno` module. \| ### Variables [](https://starship.rs/config/#variables-14) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.8.3` \| The version of `deno` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-13) toml ``` # ~/.config/starship.toml [deno] format = 'via [🦕 $version](green bold) ' ``` ## Directory [](https://starship.rs/config/#directory) The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. When using the `fish_style_pwd_dir_length` option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. ### Options [](https://starship.rs/config/#options-19) \| Option \| Default \| Description \| \|---\|---\|---\| \| `truncation_length` \| `3` \| The number of parent folders that the current directory should be truncated to. \| \| `truncate_to_repo` \| `true` \| Whether or not to truncate to the root of the git repo that you're currently in. \| \| `format` \| `'[$path]($style)[$read_only]($read_only_style) '` \| The format for the module. \| \| `style` \| `'bold cyan'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `directory` module. \| \| `read_only` \| `'🔒'` \| The symbol indicating current directory is read only. \| \| `read_only_style` \| `'red'` \| The style for the read only symbol. \| \| `truncation_symbol` \| `''` \| The symbol to prefix to truncated paths. eg: '…/' \| \| `before_repo_root_style` \| \| The style for the path segment above the root of the git repo. The default value is equivalent to `style`. \| \| `repo_root_style` \| \| The style for the root of the git repo. The default value is equivalent to `style`. \| \| `repo_root_format` \| `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` \| The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. \| \| `home_symbol` \| `'~'` \| The symbol indicating home directory. \| \| `use_os_path_sep` \| `true` \| Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) \| This module has a few advanced configuration options that control how the directory is displayed. \| Advanced Option \| Default \| Description \| \|---\|---\|---\| \| `substitutions` \| \| A table of substitutions to be made to the path. \| \| `fish_style_pwd_dir_length` \| `0` \| The number of characters to use when applying fish shell pwd path logic. \| \| `use_logical_path` \| `true` \| If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. \| `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories of Java. Note that this will disable the fish style PWD. toml ``` [directory.substitutions] '/Volumes/network/path' = '/net' 'src/com/long/java/path' = 'mypath' ``` `fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`\--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. ### Variables [](https://starship.rs/config/#variables-15) \| Variable \| Example \| Description \| \|---\|---\|---\| \| path \| `'D:/Projects'` \| The current directory path \| \| style\* \| `'black bold dimmed'` \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string The git repos have additional variables. Let us consider the path `/path/to/home/git_repo/src/lib` \| Variable \| Example \| Description \| \|---\|---\|---\| \| before\_root\_path \| `'/path/to/home/'` \| The path before git root directory path \| \| repo\_root \| `'git_repo'` \| The git root directory name \| \| path \| `'/src/lib'` \| The remaining path \| \| style \| `'black bold dimmed'` \| Mirrors the value of option `style` \| \| repo\_root\_style \| `'underline white'` \| Style for git root directory name \| ### Example [](https://starship.rs/config/#example-14) toml ``` # ~/.config/starship.toml [directory] truncation_length = 8 truncation_symbol = '…/' ``` ## Direnv [](https://starship.rs/config/#direnv) The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-20) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[$symbol$loaded/$allowed]($style) '` \| The format for the module. \| \| `symbol` \| `'direnv '` \| The symbol used before displaying the direnv context. \| \| `style` \| `'bold orange'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `direnv` module. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['.envrc']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `detect_env_vars` \| `['DIRENV_FILE']` \| Which environment variables should trigger this module. \| \| `allowed_msg` \| `'allowed'` \| The message displayed when an rc file is allowed. \| \| `not_allowed_msg` \| `'not allowed'` \| The message displayed when an rc file is not\_allowed. \| \| `denied_msg` \| `'denied'` \| The message displayed when an rc file is denied. \| \| `loaded_msg` \| `'loaded'` \| The message displayed when an rc file is loaded. \| \| `unloaded_msg` \| `'not loaded'` \| The message displayed when an rc file is not loaded. \| ### Variables [](https://starship.rs/config/#variables-16) \| Variable \| Example \| Description \| \|---\|---\|---\| \| loaded \| `loaded` \| Whether the current rc file is loaded. \| \| allowed \| `denied` \| Whether the current rc file is allowed. \| \| rc\_path \| `/home/test/.envrc` \| The current rc file path. \| \| symbol \| \| Mirrors the value of option `symbol`. \| \| style\ \| `red bold` \| Mirrors the value of option `style`. \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-15) toml ``` # ~/.config/starship.toml [direnv] disabled = false ``` ## Docker Context [](https://starship.rs/config/#docker-context) The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or `desktop-linux`, or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). ### Options [](https://starship.rs/config/#options-21) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol$context]($style) '` \| The format for the module. \| \| `symbol` \| `'🐳 '` \| The symbol used before displaying the Docker context. \| \| `only_with_files` \| `true` \| Only show when there's a match \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module (needs `only_with_files` to be true). \| \| `detect_files` \| `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` \| Which filenames should trigger this module (needs `only_with_files` to be true). \| \| `detect_folders` \| `[]` \| Which folders should trigger this module (needs `only_with_files` to be true). \| \| `style` \| `'blue bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `docker_context` module. \| ### Variables [](https://starship.rs/config/#variables-17) \| Variable \| Example \| Description \| \|---\|---\|---\| \| context \| `test_context` \| The current docker context \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-16) toml ``` # ~/.config/starship.toml [docker_context] format = 'via [🐋 $context](blue bold)' ``` ## Dotnet [](https://starship.rs/config/#dotnet) The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: - `global.json` - `project.json` - `Directory.Build.props` - `Directory.Build.targets` - `Packages.props` - `.csproj` - `.fsproj` - `.xproj` You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. The module will also show the Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks>) when there is a `.csproj` file in the current directory. ### Options [](https://starship.rs/config/#options-22) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )(🎯 $tfm )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'.NET '` \| The symbol used before displaying the version of dotnet. \| \| `heuristic` \| `true` \| Use faster version detection to keep starship snappy. \| \| `detect_extensions` \| `['csproj', 'fsproj', 'xproj']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `dotnet` module. \| ### Variables [](https://starship.rs/config/#variables-18) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v3.1.201` \| The version of `dotnet` sdk \| \| tfm \| `netstandard2.0` \| The Target Framework Moniker that the current project is targeting \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-17) toml ``` # ~/.config/starship.toml [dotnet] symbol = '🥅 ' style = 'green' heuristic = false ``` ## Elixir [](https://starship.rs/config/#elixir) The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mix.exs` file. ### Options [](https://starship.rs/config/#options-23) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version $OTP $otp_version$ )]($style)'` \| The format for the module elixir. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'💧 '` \| The symbol used before displaying the version of Elixir/Erlang. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['mix.exs']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `elixir` module. \| ### Variables [](https://starship.rs/config/#variables-19) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.10` \| The version of `elixir` \| \| otp\_version \| \| The otp version of `elixir` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-18) toml ``` # ~/.config/starship.toml [elixir] symbol = '🔮 ' ``` ## Elm [](https://starship.rs/config/#elm) The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `elm.json` file - The current directory contains a `elm-package.json` file - The current directory contains a `.elm-version` file - The current directory contains a `elm-stuff` folder - The current directory contains `.elm` files ### Options [](https://starship.rs/config/#options-24) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🌳 '` \| A format string representing the symbol of Elm. \| \| `detect_extensions` \| `['elm']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['elm.json', 'elm-package.json', '.elm-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['elm-stuff']` \| Which folders should trigger this modules. \| \| `style` \| `'cyan bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `elm` module. \| ### Variables [](https://starship.rs/config/#variables-20) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.19.1` \| The version of `elm` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-19) toml ``` # ~/.config/starship.toml [elm] format = 'via [ $version](cyan bold) ' ``` ## Environment Variable [](https://starship.rs/config/#environment-variable) The `env_var` module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met: - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is TIP The order in which env\_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env\_var modules in the order they were defined. TIP Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. Example: following configuration will display value of USER environment variable toml ``` # ~/.config/starship.toml [env_var.USER] default = 'unknown user' ``` ### Options [](https://starship.rs/config/#options-25) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `""` \| The symbol used before displaying the variable value. \| \| `variable` \| \| The environment variable to be displayed. \| \| `default` \| \| The default value to be displayed when the selected variable is not defined. \| \| `format` \| `"with [$env_value]($style) "` \| The format for the module. \| \| `description` \| `"<env_var module>"` \| The description of the module that is shown when running `starship explain`. \| \| `disabled` \| `false` \| Disables the `env_var` module. \| ### Variables [](https://starship.rs/config/#variables-21) \| Variable \| Example \| Description \| \|---\|---\|---\| \| env\_value \| `Windows NT` (if variable* would be `$OS`) \| The environment value of option `variable` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| `black bold dimmed` \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-20) toml ``` # ~/.config/starship.toml [env_var] variable = 'SHELL' default = 'unknown shell' ``` Displaying multiple environmental variables: toml ``` # ~/.config/starship.toml [env_var.SHELL] variable = 'SHELL' default = 'unknown shell' [env_var.USER] default = 'unknown user' ``` ## Erlang [](https://starship.rs/config/#erlang) The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `rebar.config` file. - The current directory contains a `erlang.mk` file. ### Options [](https://starship.rs/config/#options-26) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `' '` \| The symbol used before displaying the version of erlang. \| \| `style` \| `'bold red'` \| The style for the module. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['rebar.config', 'elang.mk']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `disabled` \| `false` \| Disables the `erlang` module. \| ### Variables [](https://starship.rs/config/#variables-22) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v22.1.3` \| The version of `erlang` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-21) toml ``` # ~/.config/starship.toml [erlang] format = 'via [e $version](bold red) ' ``` ## Fennel [](https://starship.rs/config/#fennel) The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with the `.fnl` extension ### Options [](https://starship.rs/config/#options-27) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🧅 '` \| The symbol used before displaying the version of fennel. \| \| `style` \| `'bold green'` \| The style for the module. \| \| `detect_extensions` \| `['fnl']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `disabled` \| `false` \| Disables the `fennel` module. \| ### Variables [](https://starship.rs/config/#variables-23) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.2.1` \| The version of `fennel` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-22) toml ``` # ~/.config/starship.toml [fennel] symbol = '⫰ ' ``` ## Fill [](https://starship.rs/config/#fill) The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. ### Options [](https://starship.rs/config/#options-28) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'.'` \| The symbol used to fill the line. \| \| `style` \| `'bold black'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `fill` module \| ### Example [](https://starship.rs/config/#example-23) toml ``` # ~/.config/starship.toml format = 'AA $fill BB $fill CC' [fill] symbol = '-' style = 'bold green' ``` Produces a prompt that looks like: ``` AA -------------------------------------------- BB -------------------------------------------- CC ``` ## Fortran [](https://starship.rs/config/#fortran) The `fortran` module shows the current compiler version of Fortran. ### Options [](https://starship.rs/config/#options-29) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `' '` \| The symbol used before displaying the version of Fortran. \| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `detect_extensions` \| `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['fpm.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `commands` \| `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` \| How to detect what the compiler is \| \| `disabled` \| `false` \| Disables the `fortran` module. \| ### Variables [](https://starship.rs/config/#variables-24) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| gfortran \| The name of the compiler \| \| version \| `14.2.0` \| The version of the Fortran compiler \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Commands [](https://starship.rs/config/#commands-2) The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). ## Fossil Branch [](https://starship.rs/config/#fossil-branch) The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-30) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'on [$symbol$branch]($style) '` \| The format for the module. Use `'$branch'` to refer to the current branch name. \| \| `symbol` \| `' '` \| The symbol used before the branch name of the check-out in your current directory. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `truncation_length` \| `2^63 - 1` \| Truncates a Fossil branch name to `N` graphemes \| \| `truncation_symbol` \| `'…'` \| The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. \| \| `disabled` \| `true` \| Disables the `fossil_branch` module. \| ### Variables [](https://starship.rs/config/#variables-25) \| Variable \| Example \| Description \| \|---\|---\|---\| \| branch \| `trunk` \| The active Fossil branch \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-24) toml ``` # ~/.config/starship.toml [fossil_branch] symbol = '🦎 ' truncation_length = 4 truncation_symbol = '' ``` ## Fossil Metrics [](https://starship.rs/config/#fossil-metrics) The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-31) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` \| The format for the module. \| \| `added_style` \| `'bold green'` \| The style for the added count. \| \| `deleted_style` \| `'bold red'` \| The style for the deleted count. \| \| `only_nonzero_diffs` \| `true` \| Render status only for changed items. \| \| `disabled` \| `true` \| Disables the `fossil_metrics` module. \| ### Variables [](https://starship.rs/config/#variables-26) \| Variable \| Example \| Description \| \|---\|---\|---\| \| added \| `1` \| The current number of added lines \| \| deleted \| `2` \| The current number of deleted lines \| \| added\_style\ \| \| Mirrors the value of option `added_style` \| \| deleted\_style\* \| \| Mirrors the value of option `deleted_style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-25) toml ``` # ~/.config/starship.toml [fossil_metrics] added_style = 'bold blue' format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ``` ## Google Cloud (`gcloud`) [](https://starship.rs/config/#google-cloud-gcloud) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. When the module is enabled it will always be active, unless `detect_env_vars` has been set in which case the module will only be active when one of the environment variables has been set. ### Options [](https://starship.rs/config/#options-32) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'on [$symbol$account(@$domain)($$region$)]($style) '` \| The format for the module. \| \| `symbol` \| `'☁️ '` \| The symbol used before displaying the current GCP profile. \| \| `region_aliases` \| `{}` \| Table of region aliases to display in addition to the GCP name. \| \| `project_aliases` \| `{}` \| Table of project aliases to display in addition to the GCP name. \| \| `detect_env_vars` \| `[]` \| Which environmental variables should trigger this module \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `gcloud` module. \| ### Variables [](https://starship.rs/config/#variables-27) \| Variable \| Example \| Description \| \|---\|---\|---\| \| region \| `us-central1` \| The current GCP region \| \| account \| `foo` \| The current GCP profile \| \| domain \| `example.com` \| The current GCP profile domain \| \| project \| \| The current GCP project \| \| active \| `default` \| The active config name written in `~/.config/gcloud/active_config` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Examples [](https://starship.rs/config/#examples-3) #### Display account and project [](https://starship.rs/config/#display-account-and-project) toml ``` # ~/.config/starship.toml [gcloud] format = 'on [$symbol$account(@$domain)($$project$)]($style) ' ``` #### Display active config name only [](https://starship.rs/config/#display-active-config-name-only) toml ``` # ~/.config/starship.toml [gcloud] format = '[$symbol$active]($style) ' style = 'bold yellow' ``` #### Display account and aliased region [](https://starship.rs/config/#display-account-and-aliased-region) toml ``` # ~/.config/starship.toml [gcloud] symbol = '️🇬️ ' [gcloud.region_aliases] us-central1 = 'uc1' asia-northeast1 = 'an1' ``` #### Display account and aliased project [](https://starship.rs/config/#display-account-and-aliased-project) toml ``` # ~/.config/starship.toml [gcloud] format = 'on [$symbol$account(@$domain)($$project$)]($style) ' [gcloud.project_aliases] very-long-project-name = 'vlpn' ``` ## Git Branch [](https://starship.rs/config/#git-branch) The `git_branch` module shows the active branch of the repo in your current directory. ### Options [](https://starship.rs/config/#options-33) \| Option \| Default \| Description \| \|---\|---\|---\| \| `always_show_remote` \| `false` \| Shows the remote tracking branch name, even if it is equal to the local branch name. \| \| `format` \| `'on [$symbol$branch(:$remote_branch)]($style) '` \| The format for the module. Use `'$branch'` to refer to the current branch name. \| \| `symbol` \| `' '` \| A format string representing the symbol of git branch. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `truncation_length` \| `2^63 - 1` \| Truncates a git branch to `N` graphemes. \| \| `truncation_symbol` \| `'…'` \| The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. \| \| `only_attached` \| `false` \| Only show the branch name when not in a detached `HEAD` state. \| \| `ignore_branches` \| `[]` \| A list of names to avoid displaying. Useful for 'master' or 'main'. \| \| `ignore_bare_repo` \| `false` \| Do not show when in a bare repo. \| \| `disabled` \| `false` \| Disables the `git_branch` module. \| ### Variables [](https://starship.rs/config/#variables-28) \| Variable \| Example \| Description \| \|---\|---\|---\| \| branch \| `master` \| The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). \| \| remote\_name \| `origin` \| The remote name. \| \| remote\_branch \| `master` \| The name of the branch tracked on `remote_name`. \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-26) toml ``` # ~/.config/starship.toml [git_branch] symbol = '🌱 ' truncation_length = 4 truncation_symbol = '' ignore_branches = ['master', 'main'] ``` ## Git Commit [](https://starship.rs/config/#git-commit) The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### Options [](https://starship.rs/config/#options-34) \| Option \| Default \| Description \| \|---\|---\|---\| \| `commit_hash_length` \| `7` \| The length of the displayed git commit hash. \| \| `format` \| `'[$$hash$tag$]($style) '` \| The format for the module. \| \| `style` \| `'bold green'` \| The style for the module. \| \| `only_detached` \| `true` \| Only show git commit hash when in detached `HEAD` state \| \| `tag_disabled` \| `true` \| Disables showing tag info in `git_commit` module. \| \| `tag_max_candidates` \| `0` \| How many commits to consider for tag display. The default only allows exact matches. \| \| `tag_symbol` \| `' 🏷 '` \| Tag symbol prefixing the info shown \| \| `disabled` \| `false` \| Disables the `git_commit` module. \| ### Variables [](https://starship.rs/config/#variables-29) \| Variable \| Example \| Description \| \|---\|---\|---\| \| hash \| `b703eb3` \| The current git commit hash \| \| tag \| `v1.0.0` \| The tag name if showing tag info is enabled. \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-27) toml ``` # ~/.config/starship.toml [git_commit] commit_hash_length = 4 tag_symbol = '🔖 ' ``` ## Git State [](https://starship.rs/config/#git-state) The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### Options [](https://starship.rs/config/#options-35) \| Option \| Default \| Description \| \|---\|---\|---\| \| `rebase` \| `'REBASING'` \| A format string displayed when a `rebase` is in progress. \| \| `merge` \| `'MERGING'` \| A format string displayed when a `merge` is in progress. \| \| `revert` \| `'REVERTING'` \| A format string displayed when a `revert` is in progress. \| \| `cherry_pick` \| `'CHERRY-PICKING'` \| A format string displayed when a `cherry-pick` is in progress. \| \| `bisect` \| `'BISECTING'` \| A format string displayed when a `bisect` is in progress. \| \| `am` \| `'AM'` \| A format string displayed when an `apply-mailbox` (`git am`) is in progress. \| \| `am_or_rebase` \| `'AM/REBASE'` \| A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `format` \| `'$[$state( $progress_current/$progress_total)]($style)$ '` \| The format for the module. \| \| `disabled` \| `false` \| Disables the `git_state` module. \| ### Variables [](https://starship.rs/config/#variables-30) \| Variable \| Example \| Description \| \|---\|---\|---\| \| state \| `REBASING` \| The current state of the repo \| \| progress\_current \| `1` \| The current operation progress \| \| progress\_total \| `2` \| The total operation progress \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-28) toml ``` # ~/.config/starship.toml [git_state] format = '[$$state( $progress_current of $progress_total)$]($style) ' cherry_pick = '[🍒 PICKING](bold red)' ``` ## Git Metrics [](https://starship.rs/config/#git-metrics) The `git_metrics` module will show the number of added and deleted lines in the current git repository. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-36) \| Option \| Default \| Description \| \|---\|---\|---\| \| `added_style` \| `'bold green'` \| The style for the added count. \| \| `deleted_style` \| `'bold red'` \| The style for the deleted count. \| \| `only_nonzero_diffs` \| `true` \| Render status only for changed items. \| \| `format` \| `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` \| The format for the module. \| \| `disabled` \| `true` \| Disables the `git_metrics` module. \| \| `ignore_submodules` \| `false` \| Ignore changes to submodules \| ### Variables [](https://starship.rs/config/#variables-31) \| Variable \| Example \| Description \| \|---\|---\|---\| \| added \| `1` \| The current number of added lines \| \| deleted \| `2` \| The current number of deleted lines \| \| added\_style\ \| \| Mirrors the value of option `added_style` \| \| deleted\_style\* \| \| Mirrors the value of option `deleted_style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-29) toml ``` # ~/.config/starship.toml [git_metrics] added_style = 'bold blue' format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ``` ## Git Status [](https://starship.rs/config/#git-status) The `git_status` module shows symbols representing the state of the repo in your current directory. TIP The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths. ### Options [](https://starship.rs/config/#options-37) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'([\[$all_status$ahead_behind\]]($style) )'` \| The default format for `git_status` \| \| `conflicted` \| `'='` \| This branch has merge conflicts. \| \| `ahead` \| `'⇡'` \| The format of `ahead` \| \| `behind` \| `'⇣'` \| The format of `behind` \| \| `diverged` \| `'⇕'` \| The format of `diverged` \| \| `up_to_date` \| `''` \| The format of `up_to_date` \| \| `untracked` \| `'?'` \| The format of `untracked` \| \| `stashed` \| `'\$'` \| The format of `stashed` \| \| `modified` \| `'!'` \| The format of `modified` \| \| `staged` \| `'+'` \| The format of `staged` \| \| `renamed` \| `'»'` \| The format of `renamed` \| \| `deleted` \| `'✘'` \| The format of `deleted` \| \| `typechanged` \| `""` \| The format of `typechanged` \| \| `style` \| `'bold red'` \| The style for the module. \| \| `ignore_submodules` \| `false` \| Ignore changes to submodules. \| \| `disabled` \| `false` \| Disables the `git_status` module. \| \| `windows_starship` \| \| Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. \| \| `use_git_executable` \| `false` \| Do not use `gitoxide` for computing the status, but use the `git` executable instead. \| ### Variables [](https://starship.rs/config/#variables-32) The following variables can be used in `format`: \| Variable \| Description \| \|---\|---\| \| `all_status` \| Shortcut for`$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked` \| \| `ahead_behind` \| Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. \| \| `conflicted` \| Displays `conflicted` when this branch has merge conflicts. \| \| `untracked` \| Displays `untracked` when there are untracked files in the working directory. \| \| `stashed` \| Displays `stashed` when a stash exists for the local repository. \| \| `modified` \| Displays `modified` when there are file modifications in the working directory. \| \| `staged` \| Displays `staged` when a new file has been added to the staging area. \| \| `renamed` \| Displays `renamed` when a renamed file has been added to the staging area. \| \| `deleted` \| Displays `deleted` when a file's deletion has been added to the staging area. \| \| `typechanged` \| Displays `typechanged` when a file's type has been changed in the staging area. \| \| style\ \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string The following variables can be used in `diverged`: \| Variable \| Description \| \|---\|---\| \| `ahead_count` \| Number of commits ahead of the tracking branch \| \| `behind_count` \| Number of commits behind the tracking branch \| The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: \| Variable \| Description \| \|---\|---\| \| `count` \| Show the number of files \| ### Example [](https://starship.rs/config/#example-30) toml ``` # ~/.config/starship.toml [git_status] conflicted = '🏳' ahead = '🏎💨' behind = '😰' diverged = '😵' up_to_date = '✓' untracked = '🤷' stashed = '📦' modified = '📝' staged = '[++$$count$](green)' renamed = '👅' deleted = '🗑' ``` Show ahead/behind count of the branch being tracked toml ``` # ~/.config/starship.toml [git_status] ahead = '⇡${count}' diverged = '⇕⇡${ahead_count}⇣${behind_count}' behind = '⇣${count}' ``` Use Windows Starship executable on Windows paths in WSL toml ``` # ~/.config/starship.toml [git_status] windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe' ``` ## Gleam [](https://starship.rs/config/#gleam) The `gleam` module shows the currently installed version of [Gleam](https://gleam.run/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `gleam.toml` file - The current directory contains a file with the `.gleam` extension ### Options [](https://starship.rs/config/#options-38) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'⭐ '` \| A format string representing the symbol of Gleam. \| \| `detect_extensions` \| `['gleam']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['gleam.toml']` \| Which filenames should trigger this module. \| \| `style` \| `'bold #FFAFF3'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `gleam` module. \| ### Variables [](https://starship.rs/config/#variables-33) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.0.0` \| The version of `gleam` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-31) toml ``` # ~/.config/starship.toml [gleam] format = 'via [⭐ $version](bold red) ' ``` ## Go [](https://starship.rs/config/#go) The `golang` module shows the currently installed version of [Go](https://golang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `go.mod` file - The current directory contains a `go.sum` file - The current directory contains a `go.work` file - The current directory contains a `glide.yaml` file - The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.lock` file - The current directory contains a `.go-version` file - The current directory contains a `Godeps` directory - The current directory contains a file with the `.go` extension ### Options [](https://starship.rs/config/#options-39) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐹 '` \| A format string representing the symbol of Go. \| \| `detect_extensions` \| `['go']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['Godeps']` \| Which folders should trigger this module. \| \| `style` \| `'bold cyan'` \| The style for the module. \| \| `not_capable_style` \| `'bold red'` \| The style for the module when the go directive in the go.mod file does not match the installed Go version. \| \| `disabled` \| `false` \| Disables the `golang` module. \| ### Variables [](https://starship.rs/config/#variables-34) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.12.1` \| The version of `go` \| \| mod\_version \| `1.16` \| `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-32) toml ``` # ~/.config/starship.toml [golang] format = 'via [🏎💨 $version](bold cyan) ' ``` ### Using `mod_version` [](https://starship.rs/config/#using-mod-version) toml ``` # ~/.config/starship.toml [golang] format = 'via [$symbol($version )($mod_version )]($style)' ``` ## Guix-shell [](https://starship.rs/config/#guix-shell) The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. ### Options [](https://starship.rs/config/#options-40) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol]($style) '` \| The format for the module. \| \| `symbol` \| `'🐃 '` \| A format string representing the symbol of guix-shell. \| \| `style` \| `'yellow bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `guix_shell` module. \| ### Variables [](https://starship.rs/config/#variables-35) \| Variable \| Example \| Description \| \|---\|---\|---\| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-33) toml ``` # ~/.config/starship.toml [guix_shell] disabled = true format = 'via [🐂](yellow bold) ' ``` ## Gradle [](https://starship.rs/config/#gradle) The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. By default the module will be shown if any of the following conditions are met: - The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. - The current directory contains a file ending with `.gradle` or `.gradle.kts`. The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. ### Options [](https://starship.rs/config/#options-41) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🅶 '` \| A format string representing the symbol of Gradle. \| \| `detect_extensions` \| `['gradle', 'gradle.kts']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['gradle']` \| Which folders should trigger this module. \| \| `style` \| `'bold bright-cyan'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `gradle` module. \| \| `recursive` \| `false` \| Enables recursive finding for the `gradle` directory. \| ### Variables [](https://starship.rs/config/#variables-36) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v7.5.1` \| The version of `gradle` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Haskell [](https://starship.rs/config/#haskell) The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. By default the module will be shown if any of the following conditions are met: - The current directory contains a `stack.yaml` file - The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file ### Options [](https://starship.rs/config/#options-42) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `symbol` \| `'λ '` \| A format string representing the symbol of Haskell \| \| `detect_extensions` \| `['hs', 'cabal', 'hs-boot']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['stack.yaml', 'cabal.project']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `haskell` module. \| ### Variables [](https://starship.rs/config/#variables-37) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| \| `ghc_version` or `snapshot` depending on whether the current project is a Stack project \| \| snapshot \| `lts-18.12` \| Currently selected Stack snapshot \| \| ghc\_version \| `9.2.1` \| Currently installed GHC version \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Haxe [](https://starship.rs/config/#haxe) The `haxe` module shows the currently installed version of [Haxe](https://haxe.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `project.xml`, `Project.xml`, `application.xml`, `haxelib.json`, `hxformat.json` or `.haxerc` file - The current directory contains a `.haxelib` or a `haxe_libraries` directory - The current directory contains a file with the `.hx` or `.hxml` extension ### Options [](https://starship.rs/config/#options-43) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `['hx', 'hxml']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['.haxelib', 'haxe_libraries']` \| Which folders should trigger this modules. \| \| `symbol` \| `'⌘ '` \| A format string representing the symbol of Haxe. \| \| `style` \| `'bold fg:202'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `haxe` module. \| ### Variables [](https://starship.rs/config/#variables-38) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v4.2.5` \| The version of `haxe` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-34) toml ``` # ~/.config/starship.toml [haxe] format = "via [⌘ $version](bold fg:202) " ``` ## Helm [](https://starship.rs/config/#helm) The `helm` module shows the currently installed version of [Helm](https://helm.sh/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `helmfile.yaml` file - The current directory contains a `Chart.yaml` file ### Options [](https://starship.rs/config/#options-44) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['helmfile.yaml', 'Chart.yaml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `symbol` \| `'⎈ '` \| A format string representing the symbol of Helm. \| \| `style` \| `'bold white'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `helm` module. \| ### Variables [](https://starship.rs/config/#variables-39) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v3.1.1` \| The version of `helm` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-35) toml ``` # ~/.config/starship.toml [helm] format = 'via [⎈ $version](bold white) ' ``` ## Hostname [](https://starship.rs/config/#hostname) The `hostname` module shows the system hostname. ### Options [](https://starship.rs/config/#options-45) \| Option \| Default \| Description \| \|---\|---\|---\| \| `ssh_only` \| `true` \| Only show hostname when connected to an SSH session. \| \| `ssh_symbol` \| `'🌐 '` \| A format string representing the symbol when connected to SSH session. \| \| `trim_at` \| `'.'` \| String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation. \| \| `detect_env_vars` \| `[]` \| Which environment variable(s) should trigger this module. \| \| `format` \| `'[$ssh_symbol$hostname]($style) in '` \| The format for the module. \| \| `style` \| `'bold dimmed green'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `hostname` module. \| \| `aliases` \| `{}` \| Translate system hostnames to something else. If `trim_at` is specified, only the first part will be matched and replaced. \| ### Variables [](https://starship.rs/config/#variables-40) \| Variable \| Example \| Description \| \|---\|---\|---\| \| hostname \| `computer` \| The hostname of the computer \| \| style\ \| \| Mirrors the value of option `style` \| \| ssh\_symbol \| `'🌏 '` \| The symbol to represent when connected to SSH session \| \: This variable can only be used as a part of a style string ### Examples [](https://starship.rs/config/#examples-4) #### Always show the hostname [](https://starship.rs/config/#always-show-the-hostname) toml ``` # ~/.config/starship.toml [hostname] ssh_only = false format = '[$ssh_symbol](bold blue) on [$hostname](bold red) ' trim_at = '.companyname.com' disabled = false ``` #### Hide the hostname in remote tmux sessions [](https://starship.rs/config/#hide-the-hostname-in-remote-tmux-sessions) toml ``` # ~/.config/starship.toml [hostname] ssh_only = false detect_env_vars = ['!TMUX', 'SSH_CONNECTION'] disabled = false ``` #### Replace the hostname with a nickname [](https://starship.rs/config/#replace-the-hostname-with-a-nickname) toml ``` # ~/.config/starship.toml [hostname] aliases = { "Max's MacBook Pro" = "home" } ``` ## Java [](https://starship.rs/config/#java) The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, `build.boot`, or `.sdkmanrc` file - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension ### Options [](https://starship.rs/config/#options-46) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [${symbol}(${version} )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `symbol` \| `'☕ '` \| A format string representing the symbol of Java \| \| `style` \| `'red dimmed'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `java` module. \| ### Variables [](https://starship.rs/config/#variables-41) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v14` \| The version of `java` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-36) toml ``` # ~/.config/starship.toml [java] symbol = '🌟 ' ``` ## Jobs [](https://starship.rs/config/#jobs) The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to always* show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: - 0 jobs -\> Nothing is shown. - 1 job -\> `symbol` is shown. - 2 jobs or more -\> `symbol` + `number` are shown. WARNING This module is not supported on tcsh. WARNING The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ### Options [](https://starship.rs/config/#options-47) \| Option \| Default \| Description \| \|---\|---\|---\| \| `threshold`\* \| `1` \| Show number of jobs if exceeded. \| \| `symbol_threshold` \| `1` \| Show `symbol` if the job count is at least `symbol_threshold`. \| \| `number_threshold` \| `2` \| Show the number of jobs if the job count is at least `number_threshold`. \| \| `format` \| `'[$symbol$number]($style) '` \| The format for the module. \| \| `symbol` \| `'✦'` \| The string used to represent the `symbol` variable. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `jobs` module. \| \: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. ### Variables [](https://starship.rs/config/#variables-42) \| Variable \| Example \| Description \| \|---\|---\|---\| \| number \| `1` \| The number of jobs \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Examples [](https://starship.rs/config/#examples-5) toml ``` # ~/.config/starship.toml [jobs] symbol = '+ ' number_threshold = 4 symbol_threshold = 0 ``` #### Changing process grouping behavior in fish [](https://starship.rs/config/#changing-process-grouping-behavior-in-fish) When using the Fish shell, Starship counts job groups* instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: fish ``` set -g __starship_fish_use_job_groups "false" ``` ## Julia [](https://starship.rs/config/#julia) The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Project.toml` file - The current directory contains a `Manifest.toml` file - The current directory contains a file with the `.jl` extension ### Options [](https://starship.rs/config/#options-48) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `['jl']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Project.toml', 'Manifest.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `symbol` \| `'ஃ '` \| A format string representing the symbol of Julia. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `julia` module. \| ### Variables [](https://starship.rs/config/#variables-43) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.4.0` \| The version of `julia` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-37) toml ``` # ~/.config/starship.toml [julia] symbol = '∴ ' ``` ## Kotlin [](https://starship.rs/config/#kotlin) The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `.kt` or a `.kts` file ### Options [](https://starship.rs/config/#options-49) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `['kt', 'kts']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `symbol` \| `'🅺 '` \| A format string representing the symbol of Kotlin. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `kotlin_binary` \| `'kotlin'` \| Configures the kotlin binary that Starship executes when getting the version. \| \| `disabled` \| `false` \| Disables the `kotlin` module. \| ### Variables [](https://starship.rs/config/#variables-44) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.4.21` \| The version of `kotlin` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-38) toml ``` # ~/.config/starship.toml [kotlin] symbol = '🅺 ' ``` toml ``` # ~/.config/starship.toml [kotlin] # Uses the Kotlin Compiler binary to get the installed version kotlin_binary = 'kotlinc' ``` ## Kubernetes [](https://starship.rs/config/#kubernetes) Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options [](https://starship.rs/config/#options-50) WARNING The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'☸ '` \| A format string representing the symbol displayed before the Cluster. \| \| `format` \| `'[$symbol$context( $$namespace$)]($style) in '` \| The format for the module. \| \| `style` \| `'cyan bold'` \| The style for the module. \| \| `context_aliases`\ \| `{}` \| Table of context aliases to display. \| \| `user_aliases`\* \| `{}` \| Table of user aliases to display. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `detect_env_vars` \| `[]` \| Which environmental variables should trigger this module \| \| `contexts` \| `[]` \| Customized styles and symbols for specific contexts. \| \| `disabled` \| `true` \| Disables the `kubernetes` module. \| \: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead. To customize the style of the module for specific environments, use the following configuration as part of the `contexts` list: \| Variable \| Description \| \|---\|---\| \| `context_pattern` \| Required* Regular expression to match current Kubernetes context name. \| \| `user_pattern` \| Regular expression to match current Kubernetes user name. \| \| `context_alias` \| Context alias to display instead of the full context name. \| \| `user_alias` \| User alias to display instead of the full user name. \| \| `style` \| The style for the module when using this context. If not set, will use module's style. \| \| `symbol` \| The symbol for the module when using this context. If not set, will use module's symbol. \| Note that all regular expression are anchored with `^<pattern>$` and so must match the whole string. The `_pattern` regular expressions may contain capture groups, which can be referenced in the corresponding alias via `$name` and `$N` (see example below and the [rust Regex::replace() documentation](https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace)). ### Variables [](https://starship.rs/config/#variables-45) \| Variable \| Example \| Description \| \|---\|---\|---\| \| context \| `starship-context` \| The current kubernetes context name \| \| namespace \| `starship-namespace` \| If set, the current kubernetes namespace \| \| user \| `starship-user` \| If set, the current kubernetes user \| \| cluster \| `starship-cluster` \| If set, the current kubernetes cluster \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-39) toml ``` # ~/.config/starship.toml [kubernetes] format = 'on [⛵ ($user on )($cluster in )$context $$namespace$](dimmed green) ' disabled = false contexts = [ { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " }, ] ``` Only show the module in directories that contain a `k8s` file. toml ``` # ~/.config/starship.toml [kubernetes] disabled = false detect_files = ['k8s'] ``` #### Kubernetes Context specific config [](https://starship.rs/config/#kubernetes-context-specific-config) The `contexts` configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression. toml ``` # ~/.config/starship.toml [[kubernetes.contexts]] # "bold red" style + default symbol when Kubernetes current context name equals "production" and* the current user # equals "admin_user" context_pattern = "production" user_pattern = "admin_user" style = "bold red" context_alias = "prod" user_alias = "admin" [[kubernetes.contexts]] # "green" style + a different symbol when Kubernetes current context name contains openshift context_pattern = ".openshift." style = "green" symbol = "💔 " context_alias = "openshift" [[kubernetes.contexts]] # Using capture groups # Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone. # The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`) # and renames every matching kube context into a more readable format (`gke-cluster-name`): context_pattern = "gke_._(?P<cluster>[\\w-]+)" context_alias = "gke-$cluster" ``` ## Line Break [](https://starship.rs/config/#line-break) The `line_break` module separates the prompt into two lines. ### Options [](https://starship.rs/config/#options-51) \| Option \| Default \| Description \| \|---\|---\|---\| \| `disabled` \| `false` \| Disables the `line_break` module, making the prompt a single line. \| ### Example [](https://starship.rs/config/#example-40) toml ``` # ~/.config/starship.toml [line_break] disabled = true ``` ## Local IP [](https://starship.rs/config/#local-ip) The `localip` module shows the IPv4 address of the primary network interface. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-52) \| Option \| Default \| Description \| \|---\|---\|---\| \| `ssh_only` \| `true` \| Only show IP address when connected to an SSH session. \| \| `format` \| `'[$localipv4]($style) '` \| The format for the module. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `localip` module. \| ### Variables [](https://starship.rs/config/#variables-46) \| Variable \| Example \| Description \| \|---\|---\|---\| \| localipv4 \| 192\.168.1.13 \| Contains the primary IPv4 address \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-41) toml ``` # ~/.config/starship.toml [localip] ssh_only = false format = '@[$localipv4](bold red) ' disabled = false ``` ## Lua [](https://starship.rs/config/#lua) The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `.lua-version` file - The current directory contains a `lua` directory - The current directory contains a file with the `.lua` extension ### Options [](https://starship.rs/config/#options-53) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🌙 '` \| A format string representing the symbol of Lua. \| \| `detect_extensions` \| `['lua']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['.lua-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['lua']` \| Which folders should trigger this module. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `lua_binary` \| `'lua'` \| Configures the lua binary that Starship executes when getting the version. \| \| `disabled` \| `false` \| Disables the `lua` module. \| ### Variables [](https://starship.rs/config/#variables-47) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v5.4.0` \| The version of `lua` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-42) toml ``` # ~/.config/starship.toml [lua] format = 'via [🌕 $version](bold blue) ' ``` ## Memory Usage [](https://starship.rs/config/#memory-usage) The `memory_usage` module shows current system memory and swap usage. By default the swap usage is displayed if the total system swap is non-zero. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-54) \| Option \| Default \| Description \| \|---\|---\|---\| \| `threshold` \| `75` \| Hide the memory usage unless it exceeds this percentage. \| \| `format` \| `'via $symbol [${ram}( \| ${swap})]($style) '` \| The format for the module. \| \| `symbol` \| `'🐏'` \| The symbol used before displaying the memory usage. \| \| `style` \| `'bold dimmed white'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `memory_usage` module. \| ### Variables [](https://starship.rs/config/#variables-48) \| Variable \| Example \| Description \| \|---\|---\|---\| \| ram \| `31GiB/65GiB` \| The usage/total RAM of the current system memory. \| \| ram\_pct \| `48%` \| The percentage of the current system memory. \| \| swap\\* \| `1GiB/4GiB` \| The swap memory size of the current system swap memory file. \| \| swap\_pct\\ \| `77%` \| The swap memory percentage of the current system swap memory file. \| \| symbol \| `🐏` \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string \\: The SWAP file information is only displayed if detected on the current system ### Example [](https://starship.rs/config/#example-43) toml ``` # ~/.config/starship.toml [memory_usage] disabled = false threshold = -1 symbol = ' ' style = 'bold dimmed green' ``` ## Meson [](https://starship.rs/config/#meson) The `meson` module shows the current Meson developer environment status. By default the Meson project name is displayed, if `$MESON_DEVENV` is set. ### Options [](https://starship.rs/config/#options-55) \| Option \| Default \| Description \| \|---\|---\|---\| \| `truncation_length` \| `2^32 - 1` \| Truncates a project name to `N` graphemes. \| \| `truncation_symbol` \| `'…'` \| The symbol used to indicate a project name was truncated. You can use `''` for no symbol. \| \| `format` \| `'via [$symbol$project]($style) '` \| The format for the module. \| \| `symbol` \| `'⬢ '` \| The symbol used before displaying the project name. \| \| `style` \| `'blue bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `meson` module. \| ### Variables [](https://starship.rs/config/#variables-49) \| Variable \| Example \| Description \| \|---\|---\|---\| \| project \| `starship` \| The current Meson project name \| \| symbol \| `🐏` \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-44) toml ``` # ~/.config/starship.toml [meson] disabled = false truncation_symbol = '--' symbol = ' ' style = 'bold dimmed green' ``` ## Mercurial Branch [](https://starship.rs/config/#mercurial-branch) The `hg_branch` module shows the active branch and topic of the repo in your current directory. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-56) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `' '` \| The symbol used before the hg bookmark or branch name of the repo in your current directory. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `format` \| `'on [$symbol$branch(:$topic)]($style) '` \| The format for the module. \| \| `truncation_length` \| `2^63 - 1` \| Truncates the hg branch / topic name to `N` graphemes \| \| `truncation_symbol` \| `'…'` \| The symbol used to indicate a branch name was truncated. \| \| `disabled` \| `true` \| Disables the `hg_branch` module. \| ### Variables [](https://starship.rs/config/#variables-50) \| Variable \| Example \| Description \| \|---\|---\|---\| \| branch \| `master` \| The active mercurial branch \| \| topic \| `feature` \| The active mercurial topic \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-45) toml ``` # ~/.config/starship.toml [hg_branch] format = 'on [🌱 $branch](bold purple)' truncation_length = 4 truncation_symbol = '' ``` ## Mercurial State [](https://starship.rs/config/#mercurial-state) The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-57) \| Option \| Default \| Description \| \|---\|---\|---\| \| `merge` \| `'MERGING'` \| A format string displayed when a `merge` is in progress. \| \| `rebase` \| `'REBASING'` \| A format string displayed when a `rebase` is in progress. \| \| `update` \| `'UPDATING'` \| A format string displayed when a `update` is in progress. \| \| `bisect` \| `'BISECTING'` \| A format string displayed when a `bisect` is in progress. \| \| `shelve` \| `'SHELVING'` \| A format string displayed when a `shelve` is in progress. \| \| `graft` \| `'GRAFTING'` \| A format string displayed when a `graft` is in progress. \| \| `transplant` \| `'TRANSPLANTING'` \| A format string displayed when a `transplant` is in progress. \| \| `histedit` \| `'HISTEDITING'` \| A format string displayed when a `histedit` is in progress. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `format` \| `'$[$state]($style)$ '` \| The format for the module. \| \| `disabled` \| `true` \| Disables the `hg_state` module. \| ### Variables [](https://starship.rs/config/#variables-51) \| Variable \| Example \| Description \| \|---\|---\|---\| \| state \| `REBASING` \| The current state of the repo \| \| progress\_current \| `1` \| The current operation progress \| \| progress\_total \| `2` \| The total operation progress \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Mise [](https://starship.rs/config/#mise) The `mise` module shows the current mise health as reported by running `mise doctor`. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-58) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'mise '` \| The symbol used before displaying mise* health. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `format` \| `'on [$symbol$health]($style) '` \| The format for the module. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['mise.toml', 'mise.local.toml', '.mise.toml', '.mise.local.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['.mise']` \| Which folders should trigger this module. \| \| `healthy_symbol` \| `healthy` \| The message displayed when mise is healthy. \| \| `unhealthy_symbol` \| `unhealthy` \| The message displayed when mise is unhealthy. \| \| `disabled` \| `true` \| Disables the `mise` module. \| ### Variables [](https://starship.rs/config/#variables-52) \| Variable \| Example \| Description \| \|---\|---\|---\| \| health \| `healthy` \| The health of mise \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-46) toml ``` # ~/.config/starship.toml [mise] health = 'ready' ``` ## Mojo [](https://starship.rs/config/#mojo) The `mojo` module shows the current version of [Mojo programming language](https://www.modular.com/mojo) installed ### Options [](https://starship.rs/config/#options-59) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'with [$symbol($version )]($style)'` \| The format for the module. \| \| `symbol` \| `'🔥 '` \| The symbol used before displaying the version of Mojo. \| \| `style` \| `'bold 208'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `mojo` module. \| \| `detect_extensions` \| `['mojo', '🔥']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| ### Variables [](https://starship.rs/config/#variables-53) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `24.4.0` \| The version of `mojo` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-47) toml ``` # ~/.config/starship.toml [mojo] format = 'via [mojo ($version )($hash )]($style)' ``` ## NATS [](https://starship.rs/config/#nats) The `nats` module shows the name of the current [NATS](https://nats.io/) context. ### Options [](https://starship.rs/config/#options-60) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'✉️ '` \| The symbol used before the NATS context (defaults to empty). \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `format` \| `'[$symbol$name]($style)'` \| The format for the module. \| \| `disabled` \| `false` \| Disables the `nats` module. \| ### Variables [](https://starship.rs/config/#variables-54) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| `localhost` \| The name of the NATS context \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-48) toml ``` [nats] format = '[$symbol]($style)' style = 'bold purple' ``` ## Network Namespace [](https://starship.rs/config/#network-namespace) The `netns` module shows the current network namespace. This uses `ip netns identify` to get the network namespace, so only network namespaces mounted at `/var/run/netns` will be detected. ### Options [](https://starship.rs/config/#options-61) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[$symbol \[$name\]]($style)'` \| The format for the module. \| \| `symbol` \| `'🛜 '` \| The symbol used before the network namespace (defaults to empty). \| \| `style` \| `'blue bold dimmed'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `netns` module. \| ### Variables [](https://starship.rs/config/#variables-55) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| `my-netns` \| The name of the current network namespace \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-49) toml ``` # ~/.config/starship.toml [netns] style = 'bold yellow' symbol = '🌐 ' ``` ## Nim [](https://starship.rs/config/#nim) The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension ### Options [](https://starship.rs/config/#options-62) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'👑 '` \| The symbol used before displaying the version of Nim. \| \| `detect_extensions` \| `['nim', 'nims', 'nimble']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['nim.cfg']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `nim` module. \| ### Variables [](https://starship.rs/config/#variables-56) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.2.0` \| The version of `nimc` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-50) toml ``` # ~/.config/starship.toml [nim] style = 'yellow' symbol = '🎣 ' ``` ## Nix-shell [](https://starship.rs/config/#nix-shell) The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Options [](https://starship.rs/config/#options-63) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol$state( $$name$)]($style) '` \| The format for the module. \| \| `symbol` \| `'❄️ '` \| A format string representing the symbol of nix-shell. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `impure_msg` \| `'impure'` \| A format string shown when the shell is impure. \| \| `pure_msg` \| `'pure'` \| A format string shown when the shell is pure. \| \| `unknown_msg` \| `''` \| A format string shown when it is unknown if the shell is pure/impure. \| \| `disabled` \| `false` \| Disables the `nix_shell` module. \| \| `heuristic` \| `false` \| Attempts to detect new `nix shell`\-style shells with a heuristic. \| ### Variables [](https://starship.rs/config/#variables-57) \| Variable \| Example \| Description \| \|---\|---\|---\| \| state \| `pure` \| The state of the nix-shell \| \| name \| `lorri` \| The name of the nix-shell \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-51) toml ``` # ~/.config/starship.toml [nix_shell] disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( $$name$)](bold blue) ' ``` ## Node.js [](https://starship.rs/config/#node-js) The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file - The current directory contains a `node_modules` directory - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts`, `.mts` or `.cts` extension Additionally, the module will be hidden by default if the directory contains a `bunfig.toml`, `bun.lock`, or `bun.lockb` file, overriding the above conditions. ### Options [](https://starship.rs/config/#options-64) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `' '` \| A format string representing the symbol of Node.js. \| \| `detect_extensions` \| `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['package.json', '.node-version', '.nvmrc']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['node_modules']` \| Which folders should trigger this module. \| \| `style` \| `'bold green'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `nodejs` module. \| \| `not_capable_style` \| `'bold red'` \| The style for the module when an engines property in package.json does not match the Node.js version. \| ### Variables [](https://starship.rs/config/#variables-58) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v13.12.0` \| The version of `node` \| \| engines\_version \| `>=12.0.0` \| `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-52) toml ``` # ~/.config/starship.toml [nodejs] format = 'via [🤖 $version](bold green) ' ``` ## OCaml [](https://starship.rs/config/#ocaml) The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory - The current directory contains a `dune` or `dune-project` file - The current directory contains a `jbuild` or `jbuild-ignore` file - The current directory contains a `.merlin` file - The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension ### Options [](https://starship.rs/config/#options-65) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )($$switch_indicator$switch_name$ )]($style)'` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐫 '` \| The symbol used before displaying the version of OCaml. \| \| `global_switch_indicator` \| `''` \| The format string used to represent global OPAM switch. \| \| `local_switch_indicator` \| `''` \| The format string used to represent local OPAM switch. \| \| `detect_extensions` \| `['opam', 'ml', 'mli', 're', 'rei']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['_opam', 'esy.lock']` \| Which folders should trigger this module. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `ocaml` module. \| ### Variables [](https://starship.rs/config/#variables-59) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v4.10.0` \| The version of `ocaml` \| \| switch\_name \| `my-project` \| The active OPAM switch \| \| switch\_indicator \| \| Mirrors the value of `indicator` for currently active OPAM switch \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-53) toml ``` # ~/.config/starship.toml [ocaml] format = 'via [🐪 $version]($style) ' ``` ## Odin [](https://starship.rs/config/#odin) The `odin` module shows the currently installed version of [Odin](https://odin-lang.org/). By default the module will be shown if the current directory contains a `.odin` file. ### Options [](https://starship.rs/config/#options-66) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `show_commit` \| `false` \| Shows the commit as part of the version. \| \| `symbol` \| `'Ø '` \| The symbol used before displaying the version of Odin. \| \| `style` \| `'bold bright-blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `odin` module. \| \| `detect_extensions` \| `['odin']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| ### Variables [](https://starship.rs/config/#variables-60) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `dev-2024-03` \| The version of `odin` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-54) toml ``` # ~/.config/starship.toml [odin] format = 'via [󰹩 ($version )]($style)' show_commit = true ``` ## Open Policy Agent [](https://starship.rs/config/#open-policy-agent) The `opa` module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a `.rego` file. ### Options [](https://starship.rs/config/#options-67) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🪖 '` \| A format string representing the symbol of OPA. \| \| `detect_extensions` \| `['rego']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `opa` module. \| ### Variables [](https://starship.rs/config/#variables-61) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.44.0` \| The version of `opa` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-55) toml ``` # ~/.config/starship.toml [opa] format = 'via [⛑️ $version](bold red) ' ``` ## OpenStack [](https://starship.rs/config/#openstack) The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. ### Options [](https://starship.rs/config/#options-68) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'on [$symbol$cloud($$project$)]($style) '` \| The format for the module. \| \| `symbol` \| `'☁️ '` \| The symbol used before displaying the current OpenStack cloud. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `openstack` module. \| ### Variables [](https://starship.rs/config/#variables-62) \| Variable \| Example \| Description \| \|---\|---\|---\| \| cloud \| `corp` \| The current OpenStack cloud \| \| project \| `dev` \| The current OpenStack project \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-56) toml ``` # ~/.config/starship.toml [openstack] format = 'on [$symbol$cloud($$project$)]($style) ' style = 'bold yellow' symbol = '☁️ ' ``` ## OS [](https://starship.rs/config/#os) The `os` module shows the current operating system. OS information is detected via the [os\_info](https://lib.rs/crates/os_info) crate. WARNING The [os\_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-69) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[$symbol]($style)'` \| The format for the module. \| \| `style` \| `'bold white'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `os` module. \| \| `symbols` \| \| A table that maps each operating system to its symbol. \| `symbols` allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a [feature request](https://github.com/starship/starship/issues/new/choose). toml ``` # This is the default symbols table. [os.symbols] AIX = "➿ " Alpaquita = "🔔 " AlmaLinux = "💠 " Alpine = "🏔️ " ALTLinux = "Ⓐ " Amazon = "🙂 " Android = "🤖 " AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " CachyOS = "🎗️ " CentOS = "💠 " Debian = "🌀 " DragonFly = "🐉 " Elementary = "🍏 " Emscripten = "🔗 " EndeavourOS = "🚀 " Fedora = "🎩 " FreeBSD = "😈 " Garuda = "🦅 " Gentoo = "🗜️ " HardenedBSD = "🛡️ " Illumos = "🐦 " Ios = "📱 " InstantOS = "⏲️ " Kali = "🐉 " Linux = "🐧 " Mabox = "📦 " Macos = "🍎 " Manjaro = "🥭 " Mariner = "🌊 " MidnightBSD = "🌘 " Mint = "🌿 " NetBSD = "🚩 " NixOS = "❄️ " Nobara = "🎩 " OpenBSD = "🐡 " OpenCloudOS = "☁️ " openEuler = "🦉 " openSUSE = "🦎 " OracleLinux = "🦴 " PikaOS = "🐤 " Pop = "🍭 " Raspbian = "🍓 " Redhat = "🎩 " RedHatEnterprise = "🎩 " RockyLinux = "💠 " Redox = "🧪 " Solus = "⛵ " SUSE = "🦎 " Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " Void = " " Windows = "🪟 " Zorin = "🔹 " ``` ### Variables [](https://starship.rs/config/#variables-63) \| Variable \| Example \| Description \| \|---\|---\|---\| \| symbol \| `🎗️` \| The current operating system symbol from advanced option `symbols` \| \| name \| `Arch Linux` \| The current operating system name \| \| type \| `Arch` \| The current operating system type \| \| codename \| \| The current operating system codename, if applicable \| \| edition \| \| The current operating system edition, if applicable \| \| version \| \| The current operating system version, if applicable \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-57) toml ``` # ~/.config/starship.toml [os] format = "on [($name )]($style)" style = "bold blue" disabled = false [os.symbols] Windows = " " Arch = "Arch is the best! " ``` ## Package Version [](https://starship.rs/config/#package-version) The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [npm](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [JSR](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory - [Cargo](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory - [Nimble](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `.nimble` file present in the current directory with the `nimble dump` command - [Poetry](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [Python](https://www.python.org/) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory - [Composer](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [Gradle](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory - [Julia](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory - [Mix](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory - [Helm](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory - [Maven](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [Meson](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [Shards](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory - [Galaxy](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [V](https://vlang.io/) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [SBT](https://scala-sbt.org/) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [Daml](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory - [Dart](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory > ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. ### Options [](https://starship.rs/config/#options-70) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'is [$symbol$version]($style) '` \| The format for the module. \| \| `symbol` \| `'📦 '` \| The symbol used before displaying the version the package. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `style` \| `'bold 208'` \| The style for the module. \| \| `display_private` \| `false` \| Enable displaying version for packages marked as private. \| \| `disabled` \| `false` \| Disables the `package` module. \| ### Variables [](https://starship.rs/config/#variables-64) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.0.0` \| The version of your package \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-58) toml ``` # ~/.config/starship.toml [package] format = 'via [🎁 $version](208 bold) ' ``` ## Perl [](https://starship.rs/config/#perl) The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `META.json` file or `META.yml` file - The current directory contains a `.perl-version` file - The current directory contains a `.pl`, `.pm` or `.pod` ### Options [](https://starship.rs/config/#options-71) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐪 '` \| The symbol used before displaying the version of Perl \| \| `detect_extensions` \| `['pl', 'pm', 'pod']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold 149'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `perl` module. \| ### Variables [](https://starship.rs/config/#variables-65) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v5.26.1` \| The version of `perl` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-59) toml ``` # ~/.config/starship.toml [perl] format = 'via [🦪 $version]($style) ' ``` ## PHP [](https://starship.rs/config/#php) The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` extension ### Options [](https://starship.rs/config/#options-72) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐘 '` \| The symbol used before displaying the version of PHP. \| \| `detect_extensions` \| `['php']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['composer.json', '.php-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'147 bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `php` module. \| ### Variables [](https://starship.rs/config/#variables-66) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v7.3.8` \| The version of `php` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-60) toml ``` # ~/.config/starship.toml [php] format = 'via [🔹 $version](147 bold) ' ``` ## Pijul Channel [](https://starship.rs/config/#pijul-channel) The `pijul_channel` module shows the active channel of the repo in your current directory. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-73) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `' '` \| The symbol used before the pijul channel name of the repo in your current directory. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `format` \| `'on [$symbol$channel]($style) '` \| The format for the module. \| \| `truncation_length` \| `2^63 - 1` \| Truncates the pijul channel name to `N` graphemes \| \| `truncation_symbol` \| `'…'` \| The symbol used to indicate a branch name was truncated. \| \| `disabled` \| `true` \| Disables the `pijul` module. \| ## Pixi [](https://starship.rs/config/#pixi) The `pixi` module shows the installed [pixi](https://pixi.sh/) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. TIP This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options [](https://starship.rs/config/#options-74) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )($$environment$ )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch`. \| \| `symbol` \| `'🧚 '` \| The symbol used before the environment name. \| \| `style` \| `'yellow bold'` \| The style for the module. \| \| `show_default_environment` \| `true` \| Whether to indicate that the `default` environment of your project is activated. \| \| `pixi_binary` \| `['pixi']` \| Configures the pixi binary that Starship should execute when getting the version. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['pixi.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `pixi` module. \| ### Variables [](https://starship.rs/config/#variables-67) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.33.0` \| The version of `pixi` \| \| environment \| `py311` \| The current pixi environment \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-61) toml ``` # ~/.config/starship.toml [pixi] format = '[$symbol$environment](yellow) ' ``` ## Pulumi [](https://starship.rs/config/#pulumi) The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. TIP By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](https://starship.rs/config/#with-pulumi-version). By default the module will be shown if any of the following conditions are met: - The current directory contains either `Pulumi.yaml` or `Pulumi.yml` - A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` unless `search_upwards` is set to `false` ### Options [](https://starship.rs/config/#options-75) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($username@)$stack]($style) '` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `' '` \| A format string shown before the Pulumi stack. \| \| `style` \| `'bold 5'` \| The style for the module. \| \| `search_upwards` \| `true` \| Enable discovery of pulumi config files in parent directories. \| \| `disabled` \| `false` \| Disables the `pulumi` module. \| ### Variables [](https://starship.rs/config/#variables-68) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.12.24` \| The version of `pulumi` \| \| stack \| `dev` \| The current Pulumi stack \| \| username \| `alice` \| The current Pulumi username \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-62) #### With Pulumi Version [](https://starship.rs/config/#with-pulumi-version) toml ``` # ~/.config/starship.toml [pulumi] format = '[🛥 ($version )$stack]($style) ' ``` #### Without Pulumi version [](https://starship.rs/config/#without-pulumi-version) toml ``` # ~/.config/starship.toml [pulumi] symbol = '🛥 ' format = '[$symbol$stack]($style) ' ``` ## PureScript [](https://starship.rs/config/#purescript) The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a `spago.yaml` file - The current directory contains a `spago.lock` file - The current directory contains a file with the `.purs` extension ### Options [](https://starship.rs/config/#options-76) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'<=> '` \| The symbol used before displaying the version of PureScript. \| \| `detect_extensions` \| `['purs']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['spago.dhall', 'spago.yaml', 'spago.lock']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold white'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `purescript` module. \| ### Variables [](https://starship.rs/config/#variables-69) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `0.13.5` \| The version of `purescript` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-63) toml ``` # ~/.config/starship.toml [purescript] format = 'via [$symbol$version](bold white)' ``` ## Python [](https://starship.rs/config/#python) The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. By default, the module will be shown if any of the following conditions are met: - The current directory contains a `.python-version` file - The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file - The current directory contains a `pyproject.toml` file - The current directory contains a `requirements.txt` file - The current directory contains a `setup.py` file - The current directory contains a `tox.ini` file - The current directory contains a file with the `.py` extension. - The current directory contains a file with the `.ipynb` extension. - A virtual environment is currently activated ### Options [](https://starship.rs/config/#options-77) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [${symbol}${pyenv_prefix}(${version} )($$virtualenv$ )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐍 '` \| A format string representing the symbol of Python \| \| `style` \| `'yellow bold'` \| The style for the module. \| \| `pyenv_version_name` \| `false` \| Use pyenv to get Python version \| \| `pyenv_prefix` \| `'pyenv'` \| Prefix before pyenv version display, only used if pyenv is used \| \| `python_binary` \| `['python', 'python3', 'python2']` \| Configures the python binaries that Starship should execute when getting the version. \| \| `detect_extensions` \| `['py', 'ipynb']` \| Which extensions should trigger this module \| \| `detect_files` \| `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` \| Which filenames should trigger this module \| \| `detect_folders` \| `[]` \| Which folders should trigger this module \| \| `disabled` \| `false` \| Disables the `python` module. \| TIP The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. ### Variables [](https://starship.rs/config/#variables-70) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `'v3.8.1'` \| The version of `python` \| \| symbol \| `'🐍 '` \| Mirrors the value of option `symbol` \| \| style \| `'yellow bold'` \| Mirrors the value of option `style` \| \| pyenv\_prefix \| `'pyenv '` \| Mirrors the value of option `pyenv_prefix` \| \| virtualenv \| `'venv'` \| The current `virtualenv` name \| ### Example [](https://starship.rs/config/#example-64) toml ``` # ~/.config/starship.toml [python] symbol = '👾 ' pyenv_version_name = true ``` toml ``` # ~/.config/starship.toml [python] # Only use the `python3` binary to get the version. python_binary = 'python3' ``` toml ``` # ~/.config/starship.toml [python] # Don't trigger for files with the py extension detect_extensions = [] ``` ## Quarto [](https://starship.rs/config/#quarto) The `quarto` module shows the current installed version of Quarto used in a project. By default, the module will be shown if any of the following conditions are met: - The current directory contains a `_quarto.yml` file - The current directory contains any `.qmd` file ### Options [](https://starship.rs/config/#options-78) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'⨁ '` \| A format string representing the symbol of Quarto \| \| `style` \| `'bold #75AADB'` \| The style for the module. \| \| `detect_extensions` \| `['.qmd']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['_quarto.yml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `quarto` module. \| ### Variables [](https://starship.rs/config/#variables-71) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `1.4.549` \| The version of `quarto` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## R [](https://starship.rs/config/#r) The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with the `.R` extension. - The current directory contains a file with the `.Rd` extension. - The current directory contains a file with the `.Rmd` extension. - The current directory contains a file with the `.Rproj` extension. - The current directory contains a file with the `.Rsx` extension. - The current directory contains a `.Rprofile` file - The current directory contains a `.Rproj.user` folder ### Options [](https://starship.rs/config/#options-79) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'📐'` \| A format string representing the symbol of R. \| \| `style` \| `'blue bold'` \| The style for the module. \| \| `detect_extensions` \| `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` \| Which extensions should trigger this module \| \| `detect_files` \| `['.Rprofile']` \| Which filenames should trigger this module \| \| `detect_folders` \| `['.Rproj.user']` \| Which folders should trigger this module \| \| `disabled` \| `false` \| Disables the `r` module. \| ### Variables [](https://starship.rs/config/#variables-72) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v4.0.5` \| The version of `R` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style \| `'blue bold'` \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-65) toml ``` # ~/.config/starship.toml [rlang] format = 'with [📐 $version](blue bold) ' ``` ## Raku [](https://starship.rs/config/#raku) The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `META6.json` file - The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6` ### Options [](https://starship.rs/config/#options-80) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version-$vm_version )]($style)'` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🦋 '` \| The symbol used before displaying the version of Raku \| \| `detect_extensions` \| `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['META6.json']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold 149'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `raku` module. \| ### Variables [](https://starship.rs/config/#variables-73) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v6.d` \| The version of `raku` \| \| vm\_version \| `moar` \| The version of VM `raku` is built on \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-66) toml ``` # ~/.config/starship.toml [raku] format = 'via [🦪 $version]($style) ' ``` ## Red [](https://starship.rs/config/#red) By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension ### Options [](https://starship.rs/config/#options-81) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🔺 '` \| A format string representing the symbol of Red. \| \| `detect_extensions` \| `['red']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'red bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `red` module. \| ### Variables [](https://starship.rs/config/#variables-74) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v2.5.1` \| The version of `red` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-67) toml ``` # ~/.config/starship.toml [red] symbol = '🔴 ' ``` ## Ruby [](https://starship.rs/config/#ruby) By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file - The current directory contains a `.rb` file - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set Starship gets the current Ruby version by running `ruby -v`. ### Options [](https://starship.rs/config/#options-82) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'💎 '` \| A format string representing the symbol of Ruby. \| \| `detect_extensions` \| `['rb']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Gemfile', '.ruby-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `detect_variables` \| `['RUBY_VERSION', 'RBENV_VERSION']` \| Which environment variables should trigger this module. \| \| `style` \| `'bold red'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `ruby` module. \| ### Variables [](https://starship.rs/config/#variables-75) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v2.5.1` \| The version of `ruby` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \| gemset \| `test` \| Optional, gets the current RVM gemset name. \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-68) toml ``` # ~/.config/starship.toml [ruby] symbol = '🔺 ' ``` ## Rust [](https://starship.rs/config/#rust) By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension ### Options [](https://starship.rs/config/#options-83) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🦀 '` \| A format string representing the symbol of Rust \| \| `detect_extensions` \| `['rs']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Cargo.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold red'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `rust` module. \| ### Variables [](https://starship.rs/config/#variables-76) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.43.0-nightly` \| The version of `rustc` \| \| numver \| `1.51.0` \| The numeric component of the `rustc` version \| \| toolchain \| `beta` \| The toolchain version \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-69) toml ``` # ~/.config/starship.toml [rust] format = 'via [⚙️ $version](red bold)' ``` ## Scala [](https://starship.rs/config/#scala) The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension - The current directory contains a directory named `.metals` ### Options [](https://starship.rs/config/#options-84) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [${symbol}(${version} )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `['sbt', 'scala']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['.scalaenv', '.sbtenv', 'build.sbt']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['.metals']` \| Which folders should trigger this modules. \| \| `symbol` \| `'🆂 '` \| A format string representing the symbol of Scala. \| \| `style` \| `'red dimmed'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `scala` module. \| ### Variables [](https://starship.rs/config/#variables-77) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `2.13.5` \| The version of `scala` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-70) toml ``` # ~/.config/starship.toml [scala] symbol = '🌟 ' ``` ## Shell [](https://starship.rs/config/#shell) The `shell` module shows an indicator for currently used shell. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-85) \| Option \| Default \| Description \| \|---\|---\|---\| \| `bash_indicator` \| `'bsh'` \| A format string used to represent bash. \| \| `fish_indicator` \| `'fsh'` \| A format string used to represent fish. \| \| `zsh_indicator` \| `'zsh'` \| A format string used to represent zsh. \| \| `powershell_indicator` \| `'psh'` \| A format string used to represent powershell. \| \| `pwsh_indicator` \| \| A format string used to represent pwsh. The default value mirrors the value of `powershell_indicator`. \| \| `ion_indicator` \| `'ion'` \| A format string used to represent ion. \| \| `elvish_indicator` \| `'esh'` \| A format string used to represent elvish. \| \| `tcsh_indicator` \| `'tsh'` \| A format string used to represent tcsh. \| \| `xonsh_indicator` \| `'xsh'` \| A format string used to represent xonsh. \| \| `cmd_indicator` \| `'cmd'` \| A format string used to represent cmd. \| \| `nu_indicator` \| `'nu'` \| A format string used to represent nu. \| \| `unknown_indicator` \| `''` \| The default value to be displayed when the shell is unknown. \| \| `format` \| `'[$indicator]($style) '` \| The format for the module. \| \| `style` \| `'white bold'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `shell` module. \| ### Variables [](https://starship.rs/config/#variables-78) \| Variable \| Default \| Description \| \|---\|---\|---\| \| indicator \| \| Mirrors the value of `indicator` for currently used shell. \| \| style\ \| \| Mirrors the value of option `style`. \| \: This variable can only be used as a part of a style string ### Examples [](https://starship.rs/config/#examples-6) toml ``` # ~/.config/starship.toml [shell] fish_indicator = '󰈺 ' powershell_indicator = '_' unknown_indicator = 'mystery shell' style = 'cyan bold' disabled = false ``` ## SHLVL [](https://starship.rs/config/#shlvl) The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-86) \| Option \| Default \| Description \| \|---\|---\|---\| \| `threshold` \| `2` \| Display threshold. \| \| `format` \| `'[$symbol$shlvl]($style) '` \| The format for the module. \| \| `symbol` \| `'↕️ '` \| The symbol used to represent the `SHLVL`. \| \| `repeat` \| `false` \| Causes `symbol` to be repeated by the current `SHLVL` amount. \| \| `repeat_offset` \| `0` \| Decrements number of times `symbol` is repeated by the offset value \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `shlvl` module. \| ### Variables [](https://starship.rs/config/#variables-79) \| Variable \| Example \| Description \| \|---\|---\|---\| \| shlvl \| `3` \| The current value of `SHLVL` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-71) toml ``` # ~/.config/starship.toml [shlvl] disabled = false format = '$shlvl level(s) down' threshold = 3 ``` Using `repeat` and `repeat_offset` along with `character` module, one can get prompt like `❯❯❯` where last character is colored appropriately for return status code and preceding characters are provided by `shlvl`. toml ``` # ~/.config/starship.toml [shlvl] disabled = false format = '[$symbol]($style)' repeat = true symbol = '❯' repeat_offset = 1 ``` ## Singularity [](https://starship.rs/config/#singularity) The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options [](https://starship.rs/config/#options-87) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[$symbol\[$env\]]($style) '` \| The format for the module. \| \| `symbol` \| `''` \| A format string displayed before the image name. \| \| `style` \| `'bold dimmed blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `singularity` module. \| ### Variables [](https://starship.rs/config/#variables-80) \| Variable \| Example \| Description \| \|---\|---\|---\| \| env \| `centos.img` \| The current Singularity image \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-72) toml ``` # ~/.config/starship.toml [singularity] format = '[📦 \[$env\]]($style) ' ``` ## Solidity [](https://starship.rs/config/#solidity) The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met: - The current directory contains a file with the `.sol` extension ### Options [](https://starship.rs/config/#options-88) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${major}.${minor}.${patch}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'S '` \| A format string representing the symbol of Solidity \| \| \`compiler \| \['solc'\] \| The default compiler for Solidity. \| \| `detect_extensions` \| `['sol']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables this module. \| ### Variables [](https://starship.rs/config/#variables-81) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.8.1` \| The version of `solidity` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-73) toml ``` # ~/.config/starship.toml [solidity] format = "via [S $version](blue bold)" ``` ## Spack [](https://starship.rs/config/#spack) The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. ### Options [](https://starship.rs/config/#options-89) \| Option \| Default \| Description \| \|---\|---\|---\| \| `truncation_length` \| `1` \| The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](https://starship.rs/config/#directory) module. \| \| `symbol` \| `'🅢 '` \| The symbol used before the environment name. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `format` \| `'via [$symbol$environment]($style) '` \| The format for the module. \| \| `disabled` \| `false` \| Disables the `spack` module. \| ### Variables [](https://starship.rs/config/#variables-82) \| Variable \| Example \| Description \| \|---\|---\|---\| \| environment \| `astronauts` \| The current spack environment \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-74) toml ``` # ~/.config/starship.toml [spack] format = '[$symbol$environment](dimmed blue) ' ``` ## Status [](https://starship.rs/config/#status) The `status` module displays the exit code of the previous command. If \$success\_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-90) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[$symbol$status]($style) '` \| The format of the module \| \| `symbol` \| `'❌'` \| The symbol displayed on program error \| \| `success_symbol` \| `''` \| The symbol displayed on program success \| \| `not_executable_symbol` \| `'🚫'` \| The symbol displayed when file isn't executable \| \| `not_found_symbol` \| `'🔍'` \| The symbol displayed when the command can't be found \| \| `sigint_symbol` \| `'🧱'` \| The symbol displayed on SIGINT (Ctrl + c) \| \| `signal_symbol` \| `'⚡'` \| The symbol displayed on any signal \| \| `style` \| `'bold red'` \| The style for the module. \| \| `success_style` \| \| The style used on program success (defaults to `style` if unset). \| \| `failure_style` \| \| The style used on program failure (defaults to `style` if unset). \| \| `recognize_signal_code` \| `true` \| Enable signal mapping from exit code \| \| `map_symbol` \| `false` \| Enable symbols mapping from exit code \| \| `pipestatus` \| `false` \| Enable pipestatus reporting \| \| `pipestatus_separator` \| `\|` \| The symbol used to separate pipestatus segments (supports formatting) \| \| `pipestatus_format` \| `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style) '` \| The format of the module when the command is a pipeline \| \| `pipestatus_segment_format` \| \| When specified, replaces `format` when formatting pipestatus segments \| \| `disabled` \| `true` \| Disables the `status` module. \| ### Variables [](https://starship.rs/config/#variables-83) \| Variable \| Example \| Description \| \|---\|---\|---\| \| status \| `127` \| The exit code of the last command \| \| hex\_status \| `0x7F` \| The exit code of the last command in hex \| \| int \| `127` \| The exit code of the last command \| \| common\_meaning \| `ERROR` \| Meaning of the code if not a signal \| \| signal\_number \| `9` \| Signal number corresponding to the exit code, only if signalled \| \| signal\_name \| `KILL` \| Name of the signal corresponding to the exit code, only if signalled \| \| maybe\_int \| `7` \| Contains the exit code number when no meaning has been found \| \| pipestatus \| \| Rendering of in pipeline programs' exit codes, this is only available in pipestatus\_format \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `success_style` on program success and `failure_style` otherwise \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-75) toml ``` # ~/.config/starship.toml [status] style = 'bg:blue' symbol = '🔴 ' success_symbol = '🟢 SUCCESS' format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` ## Sudo [](https://starship.rs/config/#sudo) The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-91) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[as $symbol]($style)'` \| The format of the module \| \| `symbol` \| `'🧙 '` \| The symbol displayed when credentials are cached \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `allow_windows` \| `false` \| Since windows has no default sudo, default is disabled. \| \| `disabled` \| `true` \| Disables the `sudo` module. \| ### Variables [](https://starship.rs/config/#variables-84) \| Variable \| Example \| Description \| \|---\|---\|---\| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-76) toml ``` # ~/.config/starship.toml [sudo] style = 'bold green' symbol = '👩‍💻 ' disabled = false ``` toml ``` # On windows # $HOME\.starship\config.toml [sudo] allow_windows = true disabled = false ``` ## Swift [](https://starship.rs/config/#swift) By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options [](https://starship.rs/config/#options-92) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐦 '` \| A format string representing the symbol of Swift \| \| `detect_extensions` \| `['swift']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Package.swift']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold 202'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `swift` module. \| ### Variables [](https://starship.rs/config/#variables-85) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v5.2.4` \| The version of `swift` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-77) toml ``` # ~/.config/starship.toml [swift] format = 'via [🏎 $version](red bold)' ``` ## Terraform [](https://starship.rs/config/#terraform) The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. TIP By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](https://starship.rs/config/#with-terraform-version). By default the module will be shown if any of the following conditions are met: - The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions ### Options [](https://starship.rs/config/#options-93) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol$workspace]($style) '` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'💠'` \| A format string shown before the terraform workspace. \| \| `detect_extensions` \| `['tf', 'tfplan', 'tfstate']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['.terraform']` \| Which folders should trigger this module. \| \| `style` \| `'bold 105'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `terraform` module. \| \| `commands` \| `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` \| How to detect what the Terraform version is. \| ### Variables [](https://starship.rs/config/#variables-86) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.12.24` \| The version of `terraform` \| \| workspace \| `default` \| The current Terraform workspace \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-78) #### With Terraform Version [](https://starship.rs/config/#with-terraform-version) toml ``` # ~/.config/starship.toml [terraform] format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version [](https://starship.rs/config/#without-terraform-version) toml ``` # ~/.config/starship.toml [terraform] format = 'via [$symbol$workspace]($style) ' ``` ## Time [](https://starship.rs/config/#time) The `time` module shows the current local* time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-94) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'at [$time]($style) '` \| The format string for the module. \| \| `use_12hr` \| `false` \| Enables 12 hour formatting \| \| `time_format` \| see below \| The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. \| \| `style` \| `'bold yellow'` \| The style for the module time \| \| `utc_time_offset` \| `'local'` \| Sets the UTC offset to use. Range from -24 \< x \< 24. Allows floats to accommodate 30/45 minute timezone offsets. \| \| `disabled` \| `true` \| Disables the `time` module. \| \| `time_range` \| `'-'` \| Sets the time range during which the module will be shown. Times must be specified in 24-hours format \| If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables [](https://starship.rs/config/#variables-87) \| Variable \| Example \| Description \| \|---\|---\|---\| \| time \| `13:08:10` \| The current time. \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-79) toml ``` # ~/.config/starship.toml [time] disabled = false format = '🕙[\[ $time \]]($style) ' time_format = '%T' utc_time_offset = '-5' time_range = '10:00:00-14:00:00' ``` ## Typst [](https://starship.rs/config/#typst) The `typst` module shows the current installed version of Typst used in a project. By default, the module will be shown if any of the following conditions are met: - The current directory contains a `template.typ` file - The current directory contains any `.typ` file ### Options [](https://starship.rs/config/#options-95) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'t '` \| A format string representing the symbol of Typst \| \| `style` \| `'bold #0093A7'` \| The style for the module. \| \| `detect_extensions` \| `['.typ']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['template.typ']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `typst` module. \| ### Variables [](https://starship.rs/config/#variables-88) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.9.0` \| The version of `typst`, alias for typst\_version \| \| typst\_version \| `default` \| The current Typst version \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Username [](https://starship.rs/config/#username) The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - The current user is root/admin - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set TIP SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. ### Options [](https://starship.rs/config/#options-96) \| Option \| Default \| Description \| \|---\|---\|---\| \| `style_root` \| `'bold red'` \| The style used when the user is root/admin. \| \| `style_user` \| `'bold yellow'` \| The style used for non-root users. \| \| `detect_env_vars` \| `[]` \| Which environment variable(s) should trigger this module. \| \| `format` \| `'[$user]($style) in '` \| The format for the module. \| \| `show_always` \| `false` \| Always shows the `username` module. \| \| `disabled` \| `false` \| Disables the `username` module. \| \| `aliases` \| `{}` \| Translate system usernames to something else. \| ### Variables [](https://starship.rs/config/#variables-89) \| Variable \| Example \| Description \| \|---\|---\|---\| \| `style` \| `'red bold'` \| Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. \| \| `user` \| `'matchai'` \| The currently logged-in user ID. \| ### Example [](https://starship.rs/config/#example-80) #### Always show the username [](https://starship.rs/config/#always-show-the-username) toml ``` # ~/.config/starship.toml [username] style_user = 'white bold' style_root = 'black bold' format = 'user: [$user]($style) ' disabled = false show_always = true aliases = { "corpuser034g" = "matchai" } ``` ## Vagrant [](https://starship.rs/config/#vagrant) The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Vagrantfile` file ### Options [](https://starship.rs/config/#options-97) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'⍱ '` \| A format string representing the symbol of Vagrant. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Vagrantfile']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'cyan bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `vagrant` module. \| ### Variables [](https://starship.rs/config/#variables-90) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `Vagrant 2.2.10` \| The version of `Vagrant` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-81) toml ``` # ~/.config/starship.toml [vagrant] format = 'via [⍱ $version](bold white) ' ``` ## V [](https://starship.rs/config/#v) The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.v` extension - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file ### Options [](https://starship.rs/config/#options-98) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'V '` \| A format string representing the symbol of V \| \| `detect_extensions` \| `['v']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'blue bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `vlang` module. \| ### Variables [](https://starship.rs/config/#variables-91) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.2` \| The version of `v` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-82) toml ``` # ~/.config/starship.toml [vlang] format = 'via [V $version](blue bold) ' ``` ## VCSH [](https://starship.rs/config/#vcsh) The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options [](https://starship.rs/config/#options-99) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `''` \| The symbol used before displaying the repository name. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `format` \| `'vcsh [$symbol$repo]($style) '` \| The format for the module. \| \| `disabled` \| `false` \| Disables the `vcsh` module. \| ### Variables [](https://starship.rs/config/#variables-92) \| Variable \| Example \| Description \| \|---\|---\|---\| \| repo \| `dotfiles` if in a VCSH repo named dotfiles \| The active repository name \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| `black bold dimmed` \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-83) toml ``` # ~/.config/starship.toml [vcsh] format = '[🆅 $repo](bold blue) ' ``` ## XMake [](https://starship.rs/config/#xmake) The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `xmake.lua` file ### Options [](https://starship.rs/config/#options-100) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'△ '` \| The symbol used before the version of cmake. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module \| \| `detect_files` \| `['xmake.lua']` \| Which filenames should trigger this module \| \| `detect_folders` \| `[]` \| Which folders should trigger this module \| \| `style` \| `'bold green'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `xmake` module. \| ### Variables [](https://starship.rs/config/#variables-93) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v2.9.5` \| The version of xmake \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Zig [](https://starship.rs/config/#zig) By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Options [](https://starship.rs/config/#options-101) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'↯ '` \| The symbol used before displaying the version of Zig. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `zig` module. \| \| `detect_extensions` \| `['zig']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| ### Variables [](https://starship.rs/config/#variables-94) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.6.0` \| The version of `zig` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-84) toml ``` # ~/.config/starship.toml [zig] symbol = '⚡️ ' ``` ## Custom commands [](https://starship.rs/config/#custom-commands) The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: - The current directory contains a file whose name is in `detect_files` - The current directory contains a directory whose name is in `detect_folders` - The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matches with `os` field if defined. TIP Multiple custom modules can be defined by using a `.`. TIP The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. TIP [Issue \#1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there\! WARNING If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell. Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). ### Options [](https://starship.rs/config/#options-102) \| Option \| Default \| Description \| \|---\|---\|---\| \| `command` \| `''` \| The command whose output should be printed. The command will be passed on stdin to the shell. \| \| `when` \| `false` \| Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the `shell` returns a `0` status code from executing it. \| \| `require_repo` \| `false` \| If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. \| \| `shell` \| \| [See below](https://starship.rs/config/#custom-command-shell) \| \| `description` \| `'<custom module>'` \| The description of the module that is shown when running `starship explain`. \| \| `unsafe_no_escape` \| `false` \| When set, command output is not escaped of characters that could be interpreted by the shell. \| \| `detect_files` \| `[]` \| The files that will be searched in the working directory for a match. \| \| `detect_folders` \| `[]` \| The directories that will be searched in the working directory for a match. \| \| `detect_extensions` \| `[]` \| The extensions that will be searched in the working directory for a match. \| \| `symbol` \| `''` \| The symbol used before displaying the command output. \| \| `style` \| `'bold green'` \| The style for the module. \| \| `format` \| `'[$symbol($output )]($style)'` \| The format for the module. \| \| `disabled` \| `false` \| Disables this `custom` module. \| \| `os` \| \| Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). \| \| `use_stdin` \| \| An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. \| \| `ignore_timeout` \| `false` \| Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. \| ### Variables [](https://starship.rs/config/#variables-95) \| Variable \| Description \| \|---\|---\| \| output \| The output of `command` run in `shell` \| \| symbol \| Mirrors the value of option `symbol` \| \| style\ \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string #### Custom command shell [](https://starship.rs/config/#custom-command-shell) `shell` accepts a non-empty list of strings, where: - The first string is the path to the shell to use to execute the command. - Other following arguments are passed to the shell. If unset, it will fallback to STARSHIP\_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows. The `command` (and `when`, if applicable) will be passed in on stdin. If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. toml ``` shell = ['pwsh', '-Command', '-'] ``` WARNING Make sure your custom shell configuration exits gracefully If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option). For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop. Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation. Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. ### Example [](https://starship.rs/config/#example-85) toml ``` # ~/.config/starship.toml [custom.foo] command = 'echo foo' # shows output of command detect_files = ['foo'] # can specify filters but wildcards are not supported when = ''' test "$HOME" = "$PWD" ''' format = ' transcending [$output]($style)' [custom.time] command = 'time /T' detect_extensions = ['pst'] # filters .pst files shell = ['pwsh.exe', '-NoProfile', '-Command', '-'] [custom.time-as-arg] command = 'time /T' detect_extensions = ['pst'] # filters *.pst files shell = ['pwsh.exe', '-NoProfile', '-Command'] use_stdin = false ``` [Edit this page on GitHub](https://github.com/starship/starship/edit/master/docs/config/README.md) Pager [Previous pageInstallation](https://starship.rs/installing/) [Next pageAdvanced Configuration](https://starship.rs/advanced-config/)
Readable Markdown	## Configuration [](https://starship.rs/config/#configuration) To get started configuring starship, create the following file: `~/.config/starship.toml`. sh ``` mkdir -p ~/.config && touch ~/.config/starship.toml ``` All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: toml ``` # Get editor completions based on the config schema "$schema" = 'https://starship.rs/config-schema.json' # Inserts a blank line between shell prompts add_newline = true # Replace the '❯' symbol in the prompt with '➜' [character] # The name of the module we are configuring is 'character' success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green' # Disable the package module, hiding it from the prompt completely [package] disabled = true ``` ### Config File Location [](https://starship.rs/config/#config-file-location) You can change default configuration file location with `STARSHIP_CONFIG` environment variable: sh ``` export STARSHIP_CONFIG=~/example/non/default/path/starship.toml ``` Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: powershell ``` $ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml" ``` Or for Cmd (Windows) would be adding this line to your `starship.lua`: lua ``` os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml') ``` ### Logging [](https://starship.rs/config/#logging) By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to an instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable: sh ``` export STARSHIP_CACHE=~/.starship/cache ``` Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: powershell ``` $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ``` Or for Cmd (Windows) would be adding this line to your `starship.lua`: lua ``` os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp') ``` ### Terminology [](https://starship.rs/config/#terminology) Module: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project. Variable: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. ### Strings [](https://starship.rs/config/#strings) In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`. The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`. \| Symbol \| Type \| Notes \| \|---\|---\|---\| \| `'` \| literal string \| less escaping \| \| `"` \| string \| more escaping \| \| `'''` \| multi-line literal string \| less escaping \| \| `"""` \| multi-line string \| more escaping, newlines in declarations can be ignored \| For example: toml ``` # literal string format = '☺\☻ ' # regular string format = "☺\\☻ " # escaping Starship symbols format = '\[\$\] ' ``` When using line breaks, multi-line declarations can be used. For example, if you want to print a `$` symbol on a new line, the following values for `format` are equivalent: toml ``` # with literal string format = ''' \$''' # with multiline basic string format = """ \\$""" # with basic string format = "\n\\$" ``` In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them. toml ``` format = """ line1\ line1\ line1 line2\ line2\ line2 """ ``` ### Format Strings [](https://starship.rs/config/#format-strings) Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string. #### Variable [](https://starship.rs/config/#variable) A variable contains a `$` symbol followed by the name of the variable. The name of a variable can only contain letters, numbers and `_`. For example: - `'$version'` is a format string with a variable named `version`. - `'$git_branch$git_commit'` is a format string with two variables named `git_branch` and `git_commit`. - `'$git_branch $git_commit'` has the two variables separated with a space. #### Text Group [](https://starship.rs/config/#text-group) A text group is made up of two different parts. The first part, which is enclosed in a `[]`, is a [format string](https://starship.rs/config/#format-strings). You can add texts, variables, or even nested text groups in it. In the second part, which is enclosed in a `()`, is a [style string](https://starship.rs/config/#style-strings). This can be used to style the first part. For example: - `'[on](red bold)'` will print a string `on` with bold text colored red. - `'[⌘ $version](bold green)'` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `'[a [b](red) c](green)'` will print `a b c` with `b` red, and `a` and `c` green. #### Style Strings [](https://starship.rs/config/#style-strings) Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](https://starship.rs/advanced-config/). - `'fg:green bg:blue'` sets green text on a blue background - `'bg:blue fg:bright-green'` sets bright green text on a blue background - `'bold fg:27'` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27 - `'underline bg:#bf5700'` sets underlined text on a burnt orange background - `'bold italic fg:purple'` sets bold italic purple text - `''` explicitly disables all styling Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics. #### Conditional Format Strings [](https://starship.rs/config/#conditional-format-strings) A conditional format string wrapped in `(` and `)` will not render if all variables inside are empty. For example: - `'(@$region)'` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region. - `'(some text)'` will always show nothing since there are no variables wrapped in the braces. - When `$combined` is a shortcut for `\[$a$b\]`, `'($combined)'` will show nothing only if `$a` and `$b` are both `None`. This works the same as `'(\[$a$b\] )'`. ### Negative matching [](https://starship.rs/config/#negative-matching) Many modules have `detect_extensions`, `detect_files`, and `detect_folders` variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of any negative indicator in the directory will result in the module not being matched. Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, `foo.bar.tar.gz` will be matched against `bar.tar.gz` and `gz` in the `detect_extensions` variable. Files whose name begins with a dot are not considered to have extensions at all. To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus: toml ``` detect_extensions = ['ts', '!video.ts', '!audio.ts'] ``` This is the list of prompt-wide configuration options. ### Options [](https://starship.rs/config/#options) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| [link](https://starship.rs/config/#default-prompt-format) \| Configure the format of the prompt. \| \| `right_format` \| `''` \| See [Enable Right Prompt](https://starship.rs/advanced-config/#enable-right-prompt) \| \| `scan_timeout` \| `30` \| Timeout for starship to scan files (in milliseconds). \| \| `command_timeout` \| `500` \| Timeout for commands executed by starship (in milliseconds). \| \| `add_newline` \| `true` \| Inserts blank line between shell prompts. \| \| `palette` \| `''` \| Sets which color palette from `palettes` to use. \| \| `palettes` \| `{}` \| Collection of color palettes that assign [colors](https://starship.rs/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. \| \| `follow_symlinks` \| `true` \| Follows symlinks to check if they're directories; used in modules such as git. \| TIP If you have symlinks to networked filesystems, consider setting `follow_symlinks` to `false`. ### Example [](https://starship.rs/config/#example) toml ``` # ~/.config/starship.toml # Use custom format format = ''' [┌───────────────────>](bold green) [│](bold green)$directory$rust$package [└─>](bold green) ''' # Wait 10 milliseconds for starship to check files under the current directory. scan_timeout = 10 # Disable the blank line at the start of the prompt add_newline = false # Set 'foo' as custom color palette palette = 'foo' # Define custom colors [palettes.foo] # Overwrite existing color blue = '21' # Define new color mustard = '#af8700' ``` ### Default Prompt Format [](https://starship.rs/config/#default-prompt-format) The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown: toml ``` format = '$all' # Which is equivalent to format = """ $username\ $hostname\ $localip\ $shlvl\ $singularity\ $kubernetes\ $directory\ $vcsh\ $fossil_branch\ $fossil_metrics\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ $hg_state\ $pijul_channel\ $docker_context\ $package\ $c\ $cmake\ $cobol\ $daml\ $dart\ $deno\ $dotnet\ $elixir\ $elm\ $erlang\ $fennel\ $fortran\ $gleam\ $golang\ $guix_shell\ $haskell\ $haxe\ $helm\ $java\ $julia\ $kotlin\ $gradle\ $lua\ $nim\ $nodejs\ $ocaml\ $opa\ $perl\ $php\ $pulumi\ $purescript\ $python\ $quarto\ $raku\ $rlang\ $red\ $ruby\ $rust\ $scala\ $solidity\ $swift\ $terraform\ $typst\ $vlang\ $vagrant\ $zig\ $buf\ $nix_shell\ $conda\ $meson\ $spack\ $memory_usage\ $aws\ $gcloud\ $openstack\ $azure\ $nats\ $direnv\ $env_var\ $mise\ $crystal\ $custom\ $sudo\ $cmd_duration\ $line_break\ $jobs\ $battery\ $time\ $status\ $os\ $container\ $netns\ $shell\ $character""" ``` If you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. Eg. toml ``` # Move the directory to the second line format = '$all$directory$character' ``` ## AWS [](https://starship.rs/config/#aws) The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process`, `sso_start_url`, or `sso_session` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. When using [awsu](https://github.com/kreuzwerker/awsu) the profile is read from the `AWSU_PROFILE` env var. When using [AWSume](https://awsu.me/) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var. When using [saml2aws](https://github.com/Versent/saml2aws) the expiration information obtained from `~/.aws/credentials` falls back to the `x_security_token_expires` key. When using [aws-sso-cli](https://github.com/synfinatic/aws-sso-cli) the profile is read from the `AWS_SSO_PROFILE` env var. ### Options [](https://starship.rs/config/#options-1) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'on [$symbol($profile )($$region$ )(\[$duration\] )]($style)'` \| The format for the module. \| \| `symbol` \| `'☁️ '` \| The symbol used before displaying the current AWS profile. \| \| `region_aliases` \| `{}` \| Table of region aliases to display in addition to the AWS name. \| \| `profile_aliases` \| `{}` \| Table of profile aliases to display in addition to the AWS name. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `expiration_symbol` \| `'X'` \| The symbol displayed when the temporary credentials have expired. \| \| `disabled` \| `false` \| Disables the `AWS` module. \| \| `force_display` \| `false` \| If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. \| ### Variables [](https://starship.rs/config/#variables) \| Variable \| Example \| Description \| \|---\|---\|---\| \| region \| `ap-northeast-1` \| The current AWS region \| \| profile \| `astronauts` \| The current AWS profile \| \| duration \| `2h27m20s` \| The temporary credentials validity duration \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Examples [](https://starship.rs/config/#examples) #### Display everything [](https://starship.rs/config/#display-everything) toml ``` # ~/.config/starship.toml [aws] format = 'on [$symbol($profile )($$region$ )]($style)' style = 'bold blue' symbol = '🅰 ' [aws.region_aliases] ap-southeast-2 = 'au' us-east-1 = 'va' [aws.profile_aliases] CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region [](https://starship.rs/config/#display-region) toml ``` # ~/.config/starship.toml [aws] format = 'on [$symbol$region]($style) ' style = 'bold blue' symbol = '🅰 ' [aws.region_aliases] ap-southeast-2 = 'au' us-east-1 = 'va' ``` #### Display profile [](https://starship.rs/config/#display-profile) toml ``` # ~/.config/starship.toml [aws] format = 'on [$symbol$profile]($style) ' style = 'bold blue' symbol = '🅰 ' [aws.profile_aliases] Enterprise_Naming_Scheme-voidstars = 'void' ``` ## Azure [](https://starship.rs/config/#azure) The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-2) \| Variable \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'on [$symbol($subscription)]($style) '` \| The format for the Azure module to render. \| \| `symbol` \| `'󰠅 '` \| The symbol used in the format. \| \| `style` \| `'blue bold'` \| The style used in the format. \| \| `disabled` \| `true` \| Disables the `azure` module. \| \| `subscription_aliases` \| `{}` \| Table of subscription name aliases to display in addition to Azure subscription name. \| ### Examples [](https://starship.rs/config/#examples-1) #### Display Subscription Name [](https://starship.rs/config/#display-subscription-name) toml ``` # ~/.config/starship.toml [azure] disabled = false format = 'on [$symbol($subscription)]($style) ' symbol = '󰠅 ' style = 'blue bold' ``` #### Display Username [](https://starship.rs/config/#display-username) toml ``` # ~/.config/starship.toml [azure] disabled = false format = "on [$symbol($username)]($style) " symbol = "󰠅 " style = "blue bold" ``` #### Display Subscription Name Alias [](https://starship.rs/config/#display-subscription-name-alias) toml ``` # ~/.config/starship.toml [azure.subscription_aliases] very-long-subscription-name = 'vlsn' ``` ## Battery [](https://starship.rs/config/#battery) The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%. ### Options [](https://starship.rs/config/#options-3) \| Option \| Default \| Description \| \|---\|---\|---\| \| `full_symbol` \| `'󰁹 '` \| The symbol shown when the battery is full. \| \| `charging_symbol` \| `'󰂄 '` \| The symbol shown when the battery is charging. \| \| `discharging_symbol` \| `'󰂃 '` \| The symbol shown when the battery is discharging. \| \| `unknown_symbol` \| `'󰁽 '` \| The symbol shown when the battery state is unknown. \| \| `empty_symbol` \| `'󰂎 '` \| The symbol shown when the battery state is empty. \| \| `format` \| `'[$symbol$percentage]($style) '` \| The format for the module. \| \| `display` \| [link](https://starship.rs/config/#battery-display) \| Display threshold and style for the module. \| \| `disabled` \| `false` \| Disables the `battery` module. \| ### Example [](https://starship.rs/config/#example-1) toml ``` # ~/.config/starship.toml [battery] full_symbol = '🔋 ' charging_symbol = '⚡️ ' discharging_symbol = '💀 ' ``` ### Battery Display [](https://starship.rs/config/#battery-display) The `display` configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no `display` is provided. The default is as shown: toml ``` [[battery.display]] threshold = 10 style = 'bold red' ``` The default value for the `charging_symbol` and `discharging_symbol` option is respectively the value of `battery`'s `charging_symbol` and `discharging_symbol` option. #### Options [](https://starship.rs/config/#options-4) The `display` option is an array of the following table. \| Option \| Default \| Description \| \|---\|---\|---\| \| `threshold` \| `10` \| The upper bound for the display option. \| \| `style` \| `'red bold'` \| The style used if the display option is in use. \| \| `charging_symbol` \| \| Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. \| \| `discharging_symbol` \| \| Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. \| #### Example [](https://starship.rs/config/#example-2) toml ``` [[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10% threshold = 10 style = 'bold red' [[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30% threshold = 30 style = 'bold yellow' discharging_symbol = '💦 ' # when capacity is over 30%, the battery indicator will not be displayed ``` ## Buf [](https://starship.rs/config/#buf) The `buf` module shows the currently installed version of [Buf](https://buf.build/). By default, the module is shown if the current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file. ### Options [](https://starship.rs/config/#options-5) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'with [$symbol($version )]($style)'` \| The format for the `buf` module. \| \| `version_format` \| `'v${raw}'` \| The version format. \| \| `symbol` \| `'🐃 '` \| The symbol used before displaying the version of Buf. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `elixir` module. \| ### Variables [](https://starship.rs/config/#variables-1) \| Variable \| Example \| Description \| \|---\|---\|---\| \| `version` \| `v1.0.0` \| The version of `buf` \| \| `symbol` \| \| Mirrors the value of option `symbol` \| \| `style`\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-3) toml ``` # ~/.config/starship.toml [buf] symbol = '🦬 ' ``` ## Bun [](https://starship.rs/config/#bun) The `bun` module shows the currently installed version of the [bun](https://bun.sh/) JavaScript runtime. By default the module will be shown if any of the following conditions are met: - The current directory contains a `bun.lock` file - The current directory contains a `bun.lockb` file - The current directory contains a `bunfig.toml` file ### Options [](https://starship.rs/config/#options-6) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🥟 '` \| A format string representing the symbol of Bun. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['bun.lock', 'bun.lockb', 'bunfig.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold red'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `bun` module. \| ### Variables [](https://starship.rs/config/#variables-2) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.1.4` \| The version of `bun` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-4) #### Customize the format [](https://starship.rs/config/#customize-the-format) toml ``` # ~/.config/starship.toml [bun] format = 'via [🍔 $version](bold green) ' ``` ## C [](https://starship.rs/config/#c) The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. ### Options [](https://starship.rs/config/#options-7) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version(-$name) )]($style)'` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'C '` \| The symbol used before displaying the compiler details \| \| `detect_extensions` \| `['c', 'h']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `commands` \| `[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]` \| How to detect what the compiler is \| \| `style` \| `'bold 149'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `c` module. \| ### Variables [](https://starship.rs/config/#variables-3) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| clang \| The name of the compiler \| \| version \| 13\.0.0 \| The version of the compiler \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style \| \| Mirrors the value of option `style` \| ### Commands [](https://starship.rs/config/#commands) The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycc', '--version']`. Starship will try executing each command until it gets a result on STDOUT. If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example [](https://starship.rs/config/#example-5) toml ``` # ~/.config/starship.toml [c] format = 'via [$name $version]($style)' ``` ## CPP [](https://starship.rs/config/#cpp) The `cpp` module shows some information about your `C++` compiler. By default, the module will be shown if the current directory contains a `.cpp`, `.hpp`, or other `C++`\-related files. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-8) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version(-$name) )]($style)'` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'C++ '` \| The symbol used before displaying the compiler details \| \| `detect_extensions` \| `['cpp', 'cc', 'cxx', 'c++', 'hpp', 'hh', 'hxx', 'h++', 'tcc']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `commands` \| `[ [ 'c++', '--version' ], [ 'g++', '--version' ], [ 'clang++', '--version' ] ]` \| How to detect what the compiler is \| \| `style` \| `'bold 149'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `cpp` module. \| ### Variables [](https://starship.rs/config/#variables-4) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| clang++ \| The name of the compiler \| \| version \| 13\.0.0 \| The version of the compiler \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style \| \| Mirrors the value of option `style` \| ### Commands [](https://starship.rs/config/#commands-1) The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['mycpp', '--version']`. Starship will try executing each command until it gets a result on STDOUT. If a C++ compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/issues/new/choose). ### Example [](https://starship.rs/config/#example-6) toml ``` # ~/.config/starship.toml [cpp] disabled = false format = 'via [$name $version]($style)' ``` ## Character [](https://starship.rs/config/#character) The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. The character will tell you whether the last command was successful or not. It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) By default it only changes color. If you also want to change its shape take a look at [this example](https://starship.rs/config/#with-custom-error-shape). WARNING `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). ### Options [](https://starship.rs/config/#options-9) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'$symbol '` \| The format string used before the text input. \| \| `success_symbol` \| `'[❯](bold green)'` \| The format string used before the text input if the previous command succeeded. \| \| `error_symbol` \| `'[❯](bold red)'` \| The format string used before the text input if the previous command failed. \| \| `vimcmd_symbol` \| `'[❮](bold green)'` \| The format string used before the text input if the shell is in vim normal mode. \| \| `vimcmd_replace_one_symbol` \| `'[❮](bold purple)'` \| The format string used before the text input if the shell is in vim `replace_one` mode. \| \| `vimcmd_replace_symbol` \| `'[❮](bold purple)'` \| The format string used before the text input if the shell is in vim replace mode. \| \| `vimcmd_visual_symbol` \| `'[❮](bold yellow)'` \| The format string used before the text input if the shell is in vim visual mode. \| \| `disabled` \| `false` \| Disables the `character` module. \| ### Variables [](https://starship.rs/config/#variables-5) \| Variable \| Example \| Description \| \|---\|---\|---\| \| symbol \| \| A mirror of either `success_symbol`, `error_symbol`, `vimcmd_symbol` or `vimcmd_replace_one_symbol` etc. \| ### Examples [](https://starship.rs/config/#examples-2) #### With custom error shape [](https://starship.rs/config/#with-custom-error-shape) toml ``` # ~/.config/starship.toml [character] success_symbol = '[➜](bold green) ' error_symbol = '[✗](bold red) ' ``` #### Without custom error shape [](https://starship.rs/config/#without-custom-error-shape) toml ``` # ~/.config/starship.toml [character] success_symbol = '[➜](bold green) ' error_symbol = '[➜](bold red) ' ``` #### With custom vim shape [](https://starship.rs/config/#with-custom-vim-shape) toml ``` # ~/.config/starship.toml [character] vimcmd_symbol = '[V](bold green) ' ``` ## CMake [](https://starship.rs/config/#cmake) The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeCache.txt` file ### Options [](https://starship.rs/config/#options-10) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'△ '` \| The symbol used before the version of cmake. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module \| \| `detect_files` \| `['CMakeLists.txt', 'CMakeCache.txt']` \| Which filenames should trigger this module \| \| `detect_folders` \| `[]` \| Which folders should trigger this module \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `cmake` module. \| ### Variables [](https://starship.rs/config/#variables-6) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v3.17.3` \| The version of cmake \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## COBOL / GNUCOBOL [](https://starship.rs/config/#cobol-gnucobol) The `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met: - The current directory contains any files ending in `.cob` or `.COB` - The current directory contains any files ending in `.cbl` or `.CBL` ### Options [](https://starship.rs/config/#options-11) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'⚙️ '` \| The symbol used before displaying the version of COBOL. \| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `detect_extensions` \| `['cbl', 'cob', 'CBL', 'COB']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `cobol` module. \| ### Variables [](https://starship.rs/config/#variables-7) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v3.1.2.0` \| The version of `cobol` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Command Duration [](https://starship.rs/config/#command-duration) The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. WARNING Do not hook the DEBUG trap in Bash If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module will* break. Bash users who need preexec-like functionality can use [rcaloras's bash\_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. ### Options [](https://starship.rs/config/#options-12) \| Option \| Default \| Description \| \|---\|---\|---\| \| `min_time` \| `2_000` \| Shortest duration to show time for (in milliseconds). \| \| `show_milliseconds` \| `false` \| Show milliseconds in addition to seconds for the duration. \| \| `format` \| `'took [$duration]($style) '` \| The format for the module. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `cmd_duration` module. \| \| `show_notifications` \| `false` \| Show desktop notifications when command completes. \| \| `min_time_to_notify` \| `45_000` \| Shortest duration for notification (in milliseconds). \| \| `notification_timeout` \| \| Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. \| ### Variables [](https://starship.rs/config/#variables-8) \| Variable \| Example \| Description \| \|---\|---\|---\| \| duration \| `16m40s` \| The time it took to execute the command \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-7) toml ``` # ~/.config/starship.toml [cmd_duration] min_time = 500 format = 'underwent [$duration](bold yellow)' ``` ## Conda [](https://starship.rs/config/#conda) The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. TIP This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. If you use [pixi](https://pixi.sh/), you can disable pixi's prompt modifier by running `pixi config set shell.change-ps1 false`. ### Options [](https://starship.rs/config/#options-13) \| Option \| Default \| Description \| \|---\|---\|---\| \| `truncation_length` \| `1` \| The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](https://starship.rs/config/#directory) module. \| \| `symbol` \| `'🅒 '` \| The symbol used before the environment name. \| \| `style` \| `'bold green'` \| The style for the module. \| \| `format` \| `'via [$symbol$environment]($style) '` \| The format for the module. \| \| `ignore_base` \| `true` \| Ignores `base` environment when activated. \| \| `detect_env_vars` \| `["!PIXI_ENVIRONMENT_NAME"]` \| Which environment variable(s) should trigger this module. If it's a pixi environment, this module is not being triggered by default. \| \| `disabled` \| `false` \| Disables the `conda` module. \| ### Variables [](https://starship.rs/config/#variables-9) \| Variable \| Example \| Description \| \|---\|---\|---\| \| environment \| `astronauts` \| The current conda environment \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-8) toml ``` # ~/.config/starship.toml [conda] format = '[$symbol$environment](dimmed green) ' ``` ## Container [](https://starship.rs/config/#container) The `container` module displays a symbol and container name, if inside a container. ### Options [](https://starship.rs/config/#options-14) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'⬢'` \| The symbol shown, when inside a container \| \| `style` \| `'bold red dimmed'` \| The style for the module. \| \| `format` \| `'[$symbol \[$name\]]($style) '` \| The format for the module. \| \| `disabled` \| `false` \| Disables the `container` module. \| ### Variables [](https://starship.rs/config/#variables-10) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| `fedora-toolbox:35` \| The name of the container \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-9) toml ``` # ~/.config/starship.toml [container] format = '[$symbol \[$name\]]($style) ' ``` ## Crystal [](https://starship.rs/config/#crystal) The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Options [](https://starship.rs/config/#options-15) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'🔮 '` \| The symbol used before displaying the version of crystal. \| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `style` \| `'bold red'` \| The style for the module. \| \| `detect_extensions` \| `['cr']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['shard.yml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `crystal` module. \| ### Variables [](https://starship.rs/config/#variables-11) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.32.1` \| The version of `crystal` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-10) toml ``` # ~/.config/starship.toml [crystal] format = 'via [✨ $version](bold blue) ' ``` ## Daml [](https://starship.rs/config/#daml) The `daml` module shows the currently used [Daml](https://www.digitalasset.com/developers) SDK version when you are in the root directory of your Daml project. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. By default the module will be shown if any of the following conditions are met: - The current directory contains a `daml.yaml` file ### Options [](https://starship.rs/config/#options-16) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'Λ '` \| A format string representing the symbol of Daml \| \| `style` \| `'bold cyan'` \| The style for the module. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['daml.yaml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `daml` module. \| ### Variables [](https://starship.rs/config/#variables-12) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v2.2.0` \| The version of `daml` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-11) toml ``` # ~/.config/starship.toml [daml] format = 'via [D $version](bold bright-green) ' ``` ## Dart [](https://starship.rs/config/#dart) The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory - The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file ### Options [](https://starship.rs/config/#options-17) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🎯 '` \| A format string representing the symbol of Dart \| \| `detect_extensions` \| `['dart']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['.dart_tool']` \| Which folders should trigger this module. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `dart` module. \| ### Variables [](https://starship.rs/config/#variables-13) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v2.8.4` \| The version of `dart` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-12) toml ``` # ~/.config/starship.toml [dart] format = 'via [🔰 $version](bold red) ' ``` ## Deno [](https://starship.rs/config/#deno) The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `deno.json`, `deno.jsonc`, `deno.lock`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Options [](https://starship.rs/config/#options-18) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🦕 '` \| A format string representing the symbol of Deno \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['deno.json', 'deno.jsonc', 'deno.lock', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'green bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `deno` module. \| ### Variables [](https://starship.rs/config/#variables-14) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.8.3` \| The version of `deno` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-13) toml ``` # ~/.config/starship.toml [deno] format = 'via [🦕 $version](green bold) ' ``` ## Directory [](https://starship.rs/config/#directory) The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. When using the `fish_style_pwd_dir_length` option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. ### Options [](https://starship.rs/config/#options-19) \| Option \| Default \| Description \| \|---\|---\|---\| \| `truncation_length` \| `3` \| The number of parent folders that the current directory should be truncated to. \| \| `truncate_to_repo` \| `true` \| Whether or not to truncate to the root of the git repo that you're currently in. \| \| `format` \| `'[$path]($style)[$read_only]($read_only_style) '` \| The format for the module. \| \| `style` \| `'bold cyan'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `directory` module. \| \| `read_only` \| `'🔒'` \| The symbol indicating current directory is read only. \| \| `read_only_style` \| `'red'` \| The style for the read only symbol. \| \| `truncation_symbol` \| `''` \| The symbol to prefix to truncated paths. eg: '…/' \| \| `before_repo_root_style` \| \| The style for the path segment above the root of the git repo. The default value is equivalent to `style`. \| \| `repo_root_style` \| \| The style for the root of the git repo. The default value is equivalent to `style`. \| \| `repo_root_format` \| `'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '` \| The format of a git repo when `before_repo_root_style` and `repo_root_style` is defined. \| \| `home_symbol` \| `'~'` \| The symbol indicating home directory. \| \| `use_os_path_sep` \| `true` \| Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) \| This module has a few advanced configuration options that control how the directory is displayed. \| Advanced Option \| Default \| Description \| \|---\|---\|---\| \| `substitutions` \| \| A table of substitutions to be made to the path. \| \| `fish_style_pwd_dir_length` \| `0` \| The number of characters to use when applying fish shell pwd path logic. \| \| `use_logical_path` \| `true` \| If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. \| `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories of Java. Note that this will disable the fish style PWD. toml ``` [directory.substitutions] '/Volumes/network/path' = '/net' 'src/com/long/java/path' = 'mypath' ``` `fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`\--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. ### Variables [](https://starship.rs/config/#variables-15) \| Variable \| Example \| Description \| \|---\|---\|---\| \| path \| `'D:/Projects'` \| The current directory path \| \| style\* \| `'black bold dimmed'` \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string The git repos have additional variables. Let us consider the path `/path/to/home/git_repo/src/lib` \| Variable \| Example \| Description \| \|---\|---\|---\| \| before\_root\_path \| `'/path/to/home/'` \| The path before git root directory path \| \| repo\_root \| `'git_repo'` \| The git root directory name \| \| path \| `'/src/lib'` \| The remaining path \| \| style \| `'black bold dimmed'` \| Mirrors the value of option `style` \| \| repo\_root\_style \| `'underline white'` \| Style for git root directory name \| ### Example [](https://starship.rs/config/#example-14) toml ``` # ~/.config/starship.toml [directory] truncation_length = 8 truncation_symbol = '…/' ``` ## Direnv [](https://starship.rs/config/#direnv) The `direnv` module shows the status of the current rc file if one is present. The status includes the path to the rc file, whether it is loaded, and whether it has been allowed by `direnv`. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-20) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[$symbol$loaded/$allowed]($style) '` \| The format for the module. \| \| `symbol` \| `'direnv '` \| The symbol used before displaying the direnv context. \| \| `style` \| `'bold orange'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `direnv` module. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['.envrc']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `detect_env_vars` \| `['DIRENV_FILE']` \| Which environment variables should trigger this module. \| \| `allowed_msg` \| `'allowed'` \| The message displayed when an rc file is allowed. \| \| `not_allowed_msg` \| `'not allowed'` \| The message displayed when an rc file is not\_allowed. \| \| `denied_msg` \| `'denied'` \| The message displayed when an rc file is denied. \| \| `loaded_msg` \| `'loaded'` \| The message displayed when an rc file is loaded. \| \| `unloaded_msg` \| `'not loaded'` \| The message displayed when an rc file is not loaded. \| ### Variables [](https://starship.rs/config/#variables-16) \| Variable \| Example \| Description \| \|---\|---\|---\| \| loaded \| `loaded` \| Whether the current rc file is loaded. \| \| allowed \| `denied` \| Whether the current rc file is allowed. \| \| rc\_path \| `/home/test/.envrc` \| The current rc file path. \| \| symbol \| \| Mirrors the value of option `symbol`. \| \| style\ \| `red bold` \| Mirrors the value of option `style`. \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-15) toml ``` # ~/.config/starship.toml [direnv] disabled = false ``` ## Docker Context [](https://starship.rs/config/#docker-context) The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or `desktop-linux`, or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). ### Options [](https://starship.rs/config/#options-21) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol$context]($style) '` \| The format for the module. \| \| `symbol` \| `'🐳 '` \| The symbol used before displaying the Docker context. \| \| `only_with_files` \| `true` \| Only show when there's a match \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module (needs `only_with_files` to be true). \| \| `detect_files` \| `['compose.yml', 'compose.yaml', 'docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']` \| Which filenames should trigger this module (needs `only_with_files` to be true). \| \| `detect_folders` \| `[]` \| Which folders should trigger this module (needs `only_with_files` to be true). \| \| `style` \| `'blue bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `docker_context` module. \| ### Variables [](https://starship.rs/config/#variables-17) \| Variable \| Example \| Description \| \|---\|---\|---\| \| context \| `test_context` \| The current docker context \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-16) toml ``` # ~/.config/starship.toml [docker_context] format = 'via [🐋 $context](blue bold)' ``` ## Dotnet [](https://starship.rs/config/#dotnet) The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: - `global.json` - `project.json` - `Directory.Build.props` - `Directory.Build.targets` - `Packages.props` - `.csproj` - `.fsproj` - `.xproj` You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. The module will also show the Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks>) when there is a `.csproj` file in the current directory. ### Options [](https://starship.rs/config/#options-22) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )(🎯 $tfm )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'.NET '` \| The symbol used before displaying the version of dotnet. \| \| `heuristic` \| `true` \| Use faster version detection to keep starship snappy. \| \| `detect_extensions` \| `['csproj', 'fsproj', 'xproj']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `dotnet` module. \| ### Variables [](https://starship.rs/config/#variables-18) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v3.1.201` \| The version of `dotnet` sdk \| \| tfm \| `netstandard2.0` \| The Target Framework Moniker that the current project is targeting \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-17) toml ``` # ~/.config/starship.toml [dotnet] symbol = '🥅 ' style = 'green' heuristic = false ``` ## Elixir [](https://starship.rs/config/#elixir) The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `mix.exs` file. ### Options [](https://starship.rs/config/#options-23) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version $OTP $otp_version$ )]($style)'` \| The format for the module elixir. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'💧 '` \| The symbol used before displaying the version of Elixir/Erlang. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['mix.exs']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `elixir` module. \| ### Variables [](https://starship.rs/config/#variables-19) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.10` \| The version of `elixir` \| \| otp\_version \| \| The otp version of `elixir` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-18) toml ``` # ~/.config/starship.toml [elixir] symbol = '🔮 ' ``` ## Elm [](https://starship.rs/config/#elm) The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `elm.json` file - The current directory contains a `elm-package.json` file - The current directory contains a `.elm-version` file - The current directory contains a `elm-stuff` folder - The current directory contains `.elm` files ### Options [](https://starship.rs/config/#options-24) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🌳 '` \| A format string representing the symbol of Elm. \| \| `detect_extensions` \| `['elm']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['elm.json', 'elm-package.json', '.elm-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['elm-stuff']` \| Which folders should trigger this modules. \| \| `style` \| `'cyan bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `elm` module. \| ### Variables [](https://starship.rs/config/#variables-20) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.19.1` \| The version of `elm` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-19) toml ``` # ~/.config/starship.toml [elm] format = 'via [ $version](cyan bold) ' ``` ## Environment Variable [](https://starship.rs/config/#environment-variable) The `env_var` module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met: - The `variable` configuration option matches an existing environment variable - The `variable` configuration option is not defined, but the `default` configuration option is TIP The order in which env\_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env\_var modules in the order they were defined. TIP Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. Example: following configuration will display value of USER environment variable toml ``` # ~/.config/starship.toml [env_var.USER] default = 'unknown user' ``` ### Options [](https://starship.rs/config/#options-25) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `""` \| The symbol used before displaying the variable value. \| \| `variable` \| \| The environment variable to be displayed. \| \| `default` \| \| The default value to be displayed when the selected variable is not defined. \| \| `format` \| `"with [$env_value]($style) "` \| The format for the module. \| \| `description` \| `"<env_var module>"` \| The description of the module that is shown when running `starship explain`. \| \| `disabled` \| `false` \| Disables the `env_var` module. \| ### Variables [](https://starship.rs/config/#variables-21) \| Variable \| Example \| Description \| \|---\|---\|---\| \| env\_value \| `Windows NT` (if variable* would be `$OS`) \| The environment value of option `variable` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| `black bold dimmed` \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-20) toml ``` # ~/.config/starship.toml [env_var] variable = 'SHELL' default = 'unknown shell' ``` Displaying multiple environmental variables: toml ``` # ~/.config/starship.toml [env_var.SHELL] variable = 'SHELL' default = 'unknown shell' [env_var.USER] default = 'unknown user' ``` ## Erlang [](https://starship.rs/config/#erlang) The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `rebar.config` file. - The current directory contains a `erlang.mk` file. ### Options [](https://starship.rs/config/#options-26) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `' '` \| The symbol used before displaying the version of erlang. \| \| `style` \| `'bold red'` \| The style for the module. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['rebar.config', 'elang.mk']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `disabled` \| `false` \| Disables the `erlang` module. \| ### Variables [](https://starship.rs/config/#variables-22) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v22.1.3` \| The version of `erlang` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-21) toml ``` # ~/.config/starship.toml [erlang] format = 'via [e $version](bold red) ' ``` ## Fennel [](https://starship.rs/config/#fennel) The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with the `.fnl` extension ### Options [](https://starship.rs/config/#options-27) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🧅 '` \| The symbol used before displaying the version of fennel. \| \| `style` \| `'bold green'` \| The style for the module. \| \| `detect_extensions` \| `['fnl']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `disabled` \| `false` \| Disables the `fennel` module. \| ### Variables [](https://starship.rs/config/#variables-23) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.2.1` \| The version of `fennel` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-22) toml ``` # ~/.config/starship.toml [fennel] symbol = '⫰ ' ``` ## Fill [](https://starship.rs/config/#fill) The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. ### Options [](https://starship.rs/config/#options-28) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'.'` \| The symbol used to fill the line. \| \| `style` \| `'bold black'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `fill` module \| ### Example [](https://starship.rs/config/#example-23) toml ``` # ~/.config/starship.toml format = 'AA $fill BB $fill CC' [fill] symbol = '-' style = 'bold green' ``` Produces a prompt that looks like: ``` AA -------------------------------------------- BB -------------------------------------------- CC ``` ## Fortran [](https://starship.rs/config/#fortran) The `fortran` module shows the current compiler version of Fortran. ### Options [](https://starship.rs/config/#options-29) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `' '` \| The symbol used before displaying the version of Fortran. \| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `detect_extensions` \| `['f', 'F', 'for', 'FOR', 'ftn', 'FTN', 'f77', 'F77', 'f90', 'F90', 'f95', 'F95','f03', 'F03', 'f08', 'F08', 'f18', 'F18']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['fpm.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `commands` \| `[ [ 'gfortran', '--version' ], [ 'flang', '--version' ], [ 'flang-new', '--version' ] ]` \| How to detect what the compiler is \| \| `disabled` \| `false` \| Disables the `fortran` module. \| ### Variables [](https://starship.rs/config/#variables-24) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| gfortran \| The name of the compiler \| \| version \| `14.2.0` \| The version of the Fortran compiler \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Commands [](https://starship.rs/config/#commands-2) The `commands` option accepts a list of commands to determine the compiler version and name. Each command is represented as a list of the executable name, followed by its arguments, usually something like `['myfortran', '--version']`. Starship will try executing each command until it gets a result on STDOUT. If a Fortran compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). ## Fossil Branch [](https://starship.rs/config/#fossil-branch) The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-30) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'on [$symbol$branch]($style) '` \| The format for the module. Use `'$branch'` to refer to the current branch name. \| \| `symbol` \| `' '` \| The symbol used before the branch name of the check-out in your current directory. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `truncation_length` \| `2^63 - 1` \| Truncates a Fossil branch name to `N` graphemes \| \| `truncation_symbol` \| `'…'` \| The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. \| \| `disabled` \| `true` \| Disables the `fossil_branch` module. \| ### Variables [](https://starship.rs/config/#variables-25) \| Variable \| Example \| Description \| \|---\|---\|---\| \| branch \| `trunk` \| The active Fossil branch \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-24) toml ``` # ~/.config/starship.toml [fossil_branch] symbol = '🦎 ' truncation_length = 4 truncation_symbol = '' ``` ## Fossil Metrics [](https://starship.rs/config/#fossil-metrics) The `fossil_metrics` module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-31) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` \| The format for the module. \| \| `added_style` \| `'bold green'` \| The style for the added count. \| \| `deleted_style` \| `'bold red'` \| The style for the deleted count. \| \| `only_nonzero_diffs` \| `true` \| Render status only for changed items. \| \| `disabled` \| `true` \| Disables the `fossil_metrics` module. \| ### Variables [](https://starship.rs/config/#variables-26) \| Variable \| Example \| Description \| \|---\|---\|---\| \| added \| `1` \| The current number of added lines \| \| deleted \| `2` \| The current number of deleted lines \| \| added\_style\ \| \| Mirrors the value of option `added_style` \| \| deleted\_style\* \| \| Mirrors the value of option `deleted_style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-25) toml ``` # ~/.config/starship.toml [fossil_metrics] added_style = 'bold blue' format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ``` ## Google Cloud (`gcloud`) [](https://starship.rs/config/#google-cloud-gcloud) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. When the module is enabled it will always be active, unless `detect_env_vars` has been set in which case the module will only be active when one of the environment variables has been set. ### Options [](https://starship.rs/config/#options-32) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'on [$symbol$account(@$domain)($$region$)]($style) '` \| The format for the module. \| \| `symbol` \| `'☁️ '` \| The symbol used before displaying the current GCP profile. \| \| `region_aliases` \| `{}` \| Table of region aliases to display in addition to the GCP name. \| \| `project_aliases` \| `{}` \| Table of project aliases to display in addition to the GCP name. \| \| `detect_env_vars` \| `[]` \| Which environmental variables should trigger this module \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `gcloud` module. \| ### Variables [](https://starship.rs/config/#variables-27) \| Variable \| Example \| Description \| \|---\|---\|---\| \| region \| `us-central1` \| The current GCP region \| \| account \| `foo` \| The current GCP profile \| \| domain \| `example.com` \| The current GCP profile domain \| \| project \| \| The current GCP project \| \| active \| `default` \| The active config name written in `~/.config/gcloud/active_config` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Examples [](https://starship.rs/config/#examples-3) #### Display account and project [](https://starship.rs/config/#display-account-and-project) toml ``` # ~/.config/starship.toml [gcloud] format = 'on [$symbol$account(@$domain)($$project$)]($style) ' ``` #### Display active config name only [](https://starship.rs/config/#display-active-config-name-only) toml ``` # ~/.config/starship.toml [gcloud] format = '[$symbol$active]($style) ' style = 'bold yellow' ``` #### Display account and aliased region [](https://starship.rs/config/#display-account-and-aliased-region) toml ``` # ~/.config/starship.toml [gcloud] symbol = '️🇬️ ' [gcloud.region_aliases] us-central1 = 'uc1' asia-northeast1 = 'an1' ``` #### Display account and aliased project [](https://starship.rs/config/#display-account-and-aliased-project) toml ``` # ~/.config/starship.toml [gcloud] format = 'on [$symbol$account(@$domain)($$project$)]($style) ' [gcloud.project_aliases] very-long-project-name = 'vlpn' ``` ## Git Branch [](https://starship.rs/config/#git-branch) The `git_branch` module shows the active branch of the repo in your current directory. ### Options [](https://starship.rs/config/#options-33) \| Option \| Default \| Description \| \|---\|---\|---\| \| `always_show_remote` \| `false` \| Shows the remote tracking branch name, even if it is equal to the local branch name. \| \| `format` \| `'on [$symbol$branch(:$remote_branch)]($style) '` \| The format for the module. Use `'$branch'` to refer to the current branch name. \| \| `symbol` \| `' '` \| A format string representing the symbol of git branch. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `truncation_length` \| `2^63 - 1` \| Truncates a git branch to `N` graphemes. \| \| `truncation_symbol` \| `'…'` \| The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. \| \| `only_attached` \| `false` \| Only show the branch name when not in a detached `HEAD` state. \| \| `ignore_branches` \| `[]` \| A list of names to avoid displaying. Useful for 'master' or 'main'. \| \| `ignore_bare_repo` \| `false` \| Do not show when in a bare repo. \| \| `disabled` \| `false` \| Disables the `git_branch` module. \| ### Variables [](https://starship.rs/config/#variables-28) \| Variable \| Example \| Description \| \|---\|---\|---\| \| branch \| `master` \| The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). \| \| remote\_name \| `origin` \| The remote name. \| \| remote\_branch \| `master` \| The name of the branch tracked on `remote_name`. \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-26) toml ``` # ~/.config/starship.toml [git_branch] symbol = '🌱 ' truncation_length = 4 truncation_symbol = '' ignore_branches = ['master', 'main'] ``` ## Git Commit [](https://starship.rs/config/#git-commit) The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### Options [](https://starship.rs/config/#options-34) \| Option \| Default \| Description \| \|---\|---\|---\| \| `commit_hash_length` \| `7` \| The length of the displayed git commit hash. \| \| `format` \| `'[$$hash$tag$]($style) '` \| The format for the module. \| \| `style` \| `'bold green'` \| The style for the module. \| \| `only_detached` \| `true` \| Only show git commit hash when in detached `HEAD` state \| \| `tag_disabled` \| `true` \| Disables showing tag info in `git_commit` module. \| \| `tag_max_candidates` \| `0` \| How many commits to consider for tag display. The default only allows exact matches. \| \| `tag_symbol` \| `' 🏷 '` \| Tag symbol prefixing the info shown \| \| `disabled` \| `false` \| Disables the `git_commit` module. \| ### Variables [](https://starship.rs/config/#variables-29) \| Variable \| Example \| Description \| \|---\|---\|---\| \| hash \| `b703eb3` \| The current git commit hash \| \| tag \| `v1.0.0` \| The tag name if showing tag info is enabled. \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-27) toml ``` # ~/.config/starship.toml [git_commit] commit_hash_length = 4 tag_symbol = '🔖 ' ``` ## Git State [](https://starship.rs/config/#git-state) The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### Options [](https://starship.rs/config/#options-35) \| Option \| Default \| Description \| \|---\|---\|---\| \| `rebase` \| `'REBASING'` \| A format string displayed when a `rebase` is in progress. \| \| `merge` \| `'MERGING'` \| A format string displayed when a `merge` is in progress. \| \| `revert` \| `'REVERTING'` \| A format string displayed when a `revert` is in progress. \| \| `cherry_pick` \| `'CHERRY-PICKING'` \| A format string displayed when a `cherry-pick` is in progress. \| \| `bisect` \| `'BISECTING'` \| A format string displayed when a `bisect` is in progress. \| \| `am` \| `'AM'` \| A format string displayed when an `apply-mailbox` (`git am`) is in progress. \| \| `am_or_rebase` \| `'AM/REBASE'` \| A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `format` \| `'$[$state( $progress_current/$progress_total)]($style)$ '` \| The format for the module. \| \| `disabled` \| `false` \| Disables the `git_state` module. \| ### Variables [](https://starship.rs/config/#variables-30) \| Variable \| Example \| Description \| \|---\|---\|---\| \| state \| `REBASING` \| The current state of the repo \| \| progress\_current \| `1` \| The current operation progress \| \| progress\_total \| `2` \| The total operation progress \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-28) toml ``` # ~/.config/starship.toml [git_state] format = '[$$state( $progress_current of $progress_total)$]($style) ' cherry_pick = '[🍒 PICKING](bold red)' ``` ## Git Metrics [](https://starship.rs/config/#git-metrics) The `git_metrics` module will show the number of added and deleted lines in the current git repository. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-36) \| Option \| Default \| Description \| \|---\|---\|---\| \| `added_style` \| `'bold green'` \| The style for the added count. \| \| `deleted_style` \| `'bold red'` \| The style for the deleted count. \| \| `only_nonzero_diffs` \| `true` \| Render status only for changed items. \| \| `format` \| `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` \| The format for the module. \| \| `disabled` \| `true` \| Disables the `git_metrics` module. \| \| `ignore_submodules` \| `false` \| Ignore changes to submodules \| ### Variables [](https://starship.rs/config/#variables-31) \| Variable \| Example \| Description \| \|---\|---\|---\| \| added \| `1` \| The current number of added lines \| \| deleted \| `2` \| The current number of deleted lines \| \| added\_style\ \| \| Mirrors the value of option `added_style` \| \| deleted\_style\* \| \| Mirrors the value of option `deleted_style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-29) toml ``` # ~/.config/starship.toml [git_metrics] added_style = 'bold blue' format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ``` ## Git Status [](https://starship.rs/config/#git-status) The `git_status` module shows symbols representing the state of the repo in your current directory. TIP The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths. ### Options [](https://starship.rs/config/#options-37) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'([\[$all_status$ahead_behind\]]($style) )'` \| The default format for `git_status` \| \| `conflicted` \| `'='` \| This branch has merge conflicts. \| \| `ahead` \| `'⇡'` \| The format of `ahead` \| \| `behind` \| `'⇣'` \| The format of `behind` \| \| `diverged` \| `'⇕'` \| The format of `diverged` \| \| `up_to_date` \| `''` \| The format of `up_to_date` \| \| `untracked` \| `'?'` \| The format of `untracked` \| \| `stashed` \| `'\$'` \| The format of `stashed` \| \| `modified` \| `'!'` \| The format of `modified` \| \| `staged` \| `'+'` \| The format of `staged` \| \| `renamed` \| `'»'` \| The format of `renamed` \| \| `deleted` \| `'✘'` \| The format of `deleted` \| \| `typechanged` \| `""` \| The format of `typechanged` \| \| `style` \| `'bold red'` \| The style for the module. \| \| `ignore_submodules` \| `false` \| Ignore changes to submodules. \| \| `disabled` \| `false` \| Disables the `git_status` module. \| \| `windows_starship` \| \| Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. \| \| `use_git_executable` \| `false` \| Do not use `gitoxide` for computing the status, but use the `git` executable instead. \| ### Variables [](https://starship.rs/config/#variables-32) The following variables can be used in `format`: \| Variable \| Description \| \|---\|---\| \| `all_status` \| Shortcut for`$conflicted$stashed$deleted$renamed$modified$typechanged$staged$untracked` \| \| `ahead_behind` \| Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. \| \| `conflicted` \| Displays `conflicted` when this branch has merge conflicts. \| \| `untracked` \| Displays `untracked` when there are untracked files in the working directory. \| \| `stashed` \| Displays `stashed` when a stash exists for the local repository. \| \| `modified` \| Displays `modified` when there are file modifications in the working directory. \| \| `staged` \| Displays `staged` when a new file has been added to the staging area. \| \| `renamed` \| Displays `renamed` when a renamed file has been added to the staging area. \| \| `deleted` \| Displays `deleted` when a file's deletion has been added to the staging area. \| \| `typechanged` \| Displays `typechanged` when a file's type has been changed in the staging area. \| \| style\ \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string The following variables can be used in `diverged`: \| Variable \| Description \| \|---\|---\| \| `ahead_count` \| Number of commits ahead of the tracking branch \| \| `behind_count` \| Number of commits behind the tracking branch \| The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: \| Variable \| Description \| \|---\|---\| \| `count` \| Show the number of files \| ### Example [](https://starship.rs/config/#example-30) toml ``` # ~/.config/starship.toml [git_status] conflicted = '🏳' ahead = '🏎💨' behind = '😰' diverged = '😵' up_to_date = '✓' untracked = '🤷' stashed = '📦' modified = '📝' staged = '[++$$count$](green)' renamed = '👅' deleted = '🗑' ``` Show ahead/behind count of the branch being tracked toml ``` # ~/.config/starship.toml [git_status] ahead = '⇡${count}' diverged = '⇕⇡${ahead_count}⇣${behind_count}' behind = '⇣${count}' ``` Use Windows Starship executable on Windows paths in WSL toml ``` # ~/.config/starship.toml [git_status] windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe' ``` ## Gleam [](https://starship.rs/config/#gleam) The `gleam` module shows the currently installed version of [Gleam](https://gleam.run/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `gleam.toml` file - The current directory contains a file with the `.gleam` extension ### Options [](https://starship.rs/config/#options-38) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'⭐ '` \| A format string representing the symbol of Gleam. \| \| `detect_extensions` \| `['gleam']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['gleam.toml']` \| Which filenames should trigger this module. \| \| `style` \| `'bold #FFAFF3'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `gleam` module. \| ### Variables [](https://starship.rs/config/#variables-33) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.0.0` \| The version of `gleam` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-31) toml ``` # ~/.config/starship.toml [gleam] format = 'via [⭐ $version](bold red) ' ``` ## Go [](https://starship.rs/config/#go) The `golang` module shows the currently installed version of [Go](https://golang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `go.mod` file - The current directory contains a `go.sum` file - The current directory contains a `go.work` file - The current directory contains a `glide.yaml` file - The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.lock` file - The current directory contains a `.go-version` file - The current directory contains a `Godeps` directory - The current directory contains a file with the `.go` extension ### Options [](https://starship.rs/config/#options-39) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐹 '` \| A format string representing the symbol of Go. \| \| `detect_extensions` \| `['go']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['Godeps']` \| Which folders should trigger this module. \| \| `style` \| `'bold cyan'` \| The style for the module. \| \| `not_capable_style` \| `'bold red'` \| The style for the module when the go directive in the go.mod file does not match the installed Go version. \| \| `disabled` \| `false` \| Disables the `golang` module. \| ### Variables [](https://starship.rs/config/#variables-34) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.12.1` \| The version of `go` \| \| mod\_version \| `1.16` \| `go` version requirement as set in the go directive of `go.mod`. Will only show if the version requirement does not match the `go` version. \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-32) toml ``` # ~/.config/starship.toml [golang] format = 'via [🏎💨 $version](bold cyan) ' ``` ### Using `mod_version` [](https://starship.rs/config/#using-mod-version) toml ``` # ~/.config/starship.toml [golang] format = 'via [$symbol($version )($mod_version )]($style)' ``` ## Guix-shell [](https://starship.rs/config/#guix-shell) The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. ### Options [](https://starship.rs/config/#options-40) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol]($style) '` \| The format for the module. \| \| `symbol` \| `'🐃 '` \| A format string representing the symbol of guix-shell. \| \| `style` \| `'yellow bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `guix_shell` module. \| ### Variables [](https://starship.rs/config/#variables-35) \| Variable \| Example \| Description \| \|---\|---\|---\| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-33) toml ``` # ~/.config/starship.toml [guix_shell] disabled = true format = 'via [🐂](yellow bold) ' ``` ## Gradle [](https://starship.rs/config/#gradle) The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. By default the module will be shown if any of the following conditions are met: - The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. - The current directory contains a file ending with `.gradle` or `.gradle.kts`. The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. ### Options [](https://starship.rs/config/#options-41) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🅶 '` \| A format string representing the symbol of Gradle. \| \| `detect_extensions` \| `['gradle', 'gradle.kts']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['gradle']` \| Which folders should trigger this module. \| \| `style` \| `'bold bright-cyan'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `gradle` module. \| \| `recursive` \| `false` \| Enables recursive finding for the `gradle` directory. \| ### Variables [](https://starship.rs/config/#variables-36) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v7.5.1` \| The version of `gradle` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Haskell [](https://starship.rs/config/#haskell) The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. By default the module will be shown if any of the following conditions are met: - The current directory contains a `stack.yaml` file - The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file ### Options [](https://starship.rs/config/#options-42) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `symbol` \| `'λ '` \| A format string representing the symbol of Haskell \| \| `detect_extensions` \| `['hs', 'cabal', 'hs-boot']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['stack.yaml', 'cabal.project']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `haskell` module. \| ### Variables [](https://starship.rs/config/#variables-37) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| \| `ghc_version` or `snapshot` depending on whether the current project is a Stack project \| \| snapshot \| `lts-18.12` \| Currently selected Stack snapshot \| \| ghc\_version \| `9.2.1` \| Currently installed GHC version \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Haxe [](https://starship.rs/config/#haxe) The `haxe` module shows the currently installed version of [Haxe](https://haxe.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `project.xml`, `Project.xml`, `application.xml`, `haxelib.json`, `hxformat.json` or `.haxerc` file - The current directory contains a `.haxelib` or a `haxe_libraries` directory - The current directory contains a file with the `.hx` or `.hxml` extension ### Options [](https://starship.rs/config/#options-43) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `['hx', 'hxml']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['project.xml', 'Project.xml', 'application.xml', 'haxelib.json', 'hxformat.json', '.haxerc']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['.haxelib', 'haxe_libraries']` \| Which folders should trigger this modules. \| \| `symbol` \| `'⌘ '` \| A format string representing the symbol of Haxe. \| \| `style` \| `'bold fg:202'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `haxe` module. \| ### Variables [](https://starship.rs/config/#variables-38) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v4.2.5` \| The version of `haxe` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-34) toml ``` # ~/.config/starship.toml [haxe] format = "via [⌘ $version](bold fg:202) " ``` ## Helm [](https://starship.rs/config/#helm) The `helm` module shows the currently installed version of [Helm](https://helm.sh/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `helmfile.yaml` file - The current directory contains a `Chart.yaml` file ### Options [](https://starship.rs/config/#options-44) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['helmfile.yaml', 'Chart.yaml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `symbol` \| `'⎈ '` \| A format string representing the symbol of Helm. \| \| `style` \| `'bold white'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `helm` module. \| ### Variables [](https://starship.rs/config/#variables-39) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v3.1.1` \| The version of `helm` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-35) toml ``` # ~/.config/starship.toml [helm] format = 'via [⎈ $version](bold white) ' ``` ## Hostname [](https://starship.rs/config/#hostname) The `hostname` module shows the system hostname. ### Options [](https://starship.rs/config/#options-45) \| Option \| Default \| Description \| \|---\|---\|---\| \| `ssh_only` \| `true` \| Only show hostname when connected to an SSH session. \| \| `ssh_symbol` \| `'🌐 '` \| A format string representing the symbol when connected to SSH session. \| \| `trim_at` \| `'.'` \| String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation. \| \| `detect_env_vars` \| `[]` \| Which environment variable(s) should trigger this module. \| \| `format` \| `'[$ssh_symbol$hostname]($style) in '` \| The format for the module. \| \| `style` \| `'bold dimmed green'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `hostname` module. \| \| `aliases` \| `{}` \| Translate system hostnames to something else. If `trim_at` is specified, only the first part will be matched and replaced. \| ### Variables [](https://starship.rs/config/#variables-40) \| Variable \| Example \| Description \| \|---\|---\|---\| \| hostname \| `computer` \| The hostname of the computer \| \| style\ \| \| Mirrors the value of option `style` \| \| ssh\_symbol \| `'🌏 '` \| The symbol to represent when connected to SSH session \| \: This variable can only be used as a part of a style string ### Examples [](https://starship.rs/config/#examples-4) #### Always show the hostname [](https://starship.rs/config/#always-show-the-hostname) toml ``` # ~/.config/starship.toml [hostname] ssh_only = false format = '[$ssh_symbol](bold blue) on [$hostname](bold red) ' trim_at = '.companyname.com' disabled = false ``` #### Hide the hostname in remote tmux sessions [](https://starship.rs/config/#hide-the-hostname-in-remote-tmux-sessions) toml ``` # ~/.config/starship.toml [hostname] ssh_only = false detect_env_vars = ['!TMUX', 'SSH_CONNECTION'] disabled = false ``` #### Replace the hostname with a nickname [](https://starship.rs/config/#replace-the-hostname-with-a-nickname) toml ``` # ~/.config/starship.toml [hostname] aliases = { "Max's MacBook Pro" = "home" } ``` ## Java [](https://starship.rs/config/#java) The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, `build.boot`, or `.sdkmanrc` file - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension ### Options [](https://starship.rs/config/#options-46) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [${symbol}(${version} )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `symbol` \| `'☕ '` \| A format string representing the symbol of Java \| \| `style` \| `'red dimmed'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `java` module. \| ### Variables [](https://starship.rs/config/#variables-41) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v14` \| The version of `java` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-36) toml ``` # ~/.config/starship.toml [java] symbol = '🌟 ' ``` ## Jobs [](https://starship.rs/config/#jobs) The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to always* show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: - 0 jobs -\> Nothing is shown. - 1 job -\> `symbol` is shown. - 2 jobs or more -\> `symbol` + `number` are shown. WARNING This module is not supported on tcsh. WARNING The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ### Options [](https://starship.rs/config/#options-47) \| Option \| Default \| Description \| \|---\|---\|---\| \| `threshold`\* \| `1` \| Show number of jobs if exceeded. \| \| `symbol_threshold` \| `1` \| Show `symbol` if the job count is at least `symbol_threshold`. \| \| `number_threshold` \| `2` \| Show the number of jobs if the job count is at least `number_threshold`. \| \| `format` \| `'[$symbol$number]($style) '` \| The format for the module. \| \| `symbol` \| `'✦'` \| The string used to represent the `symbol` variable. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `jobs` module. \| \: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. ### Variables [](https://starship.rs/config/#variables-42) \| Variable \| Example \| Description \| \|---\|---\|---\| \| number \| `1` \| The number of jobs \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Examples [](https://starship.rs/config/#examples-5) toml ``` # ~/.config/starship.toml [jobs] symbol = '+ ' number_threshold = 4 symbol_threshold = 0 ``` #### Changing process grouping behavior in fish [](https://starship.rs/config/#changing-process-grouping-behavior-in-fish) When using the Fish shell, Starship counts job groups* instead of individual process IDs by default. This prevents overcounting when a pipeline has multiple processes but only one suspended group. To revert to the legacy PID-based counting, please add the following to your shell config: fish ``` set -g __starship_fish_use_job_groups "false" ``` ## Julia [](https://starship.rs/config/#julia) The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Project.toml` file - The current directory contains a `Manifest.toml` file - The current directory contains a file with the `.jl` extension ### Options [](https://starship.rs/config/#options-48) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `['jl']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Project.toml', 'Manifest.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `symbol` \| `'ஃ '` \| A format string representing the symbol of Julia. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `julia` module. \| ### Variables [](https://starship.rs/config/#variables-43) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.4.0` \| The version of `julia` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-37) toml ``` # ~/.config/starship.toml [julia] symbol = '∴ ' ``` ## Kotlin [](https://starship.rs/config/#kotlin) The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `.kt` or a `.kts` file ### Options [](https://starship.rs/config/#options-49) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `['kt', 'kts']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `symbol` \| `'🅺 '` \| A format string representing the symbol of Kotlin. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `kotlin_binary` \| `'kotlin'` \| Configures the kotlin binary that Starship executes when getting the version. \| \| `disabled` \| `false` \| Disables the `kotlin` module. \| ### Variables [](https://starship.rs/config/#variables-44) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.4.21` \| The version of `kotlin` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-38) toml ``` # ~/.config/starship.toml [kotlin] symbol = '🅺 ' ``` toml ``` # ~/.config/starship.toml [kotlin] # Uses the Kotlin Compiler binary to get the installed version kotlin_binary = 'kotlinc' ``` ## Kubernetes [](https://starship.rs/config/#kubernetes) Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly, the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_env_vars`, `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions or one of the environmental variables has been set. ### Options [](https://starship.rs/config/#options-50) WARNING The `context_aliases` and `user_aliases` options are deprecated. Use `contexts` and the corresponding `context_alias` and `user_alias` options instead. \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'☸ '` \| A format string representing the symbol displayed before the Cluster. \| \| `format` \| `'[$symbol$context( $$namespace$)]($style) in '` \| The format for the module. \| \| `style` \| `'cyan bold'` \| The style for the module. \| \| `context_aliases`\ \| `{}` \| Table of context aliases to display. \| \| `user_aliases`\* \| `{}` \| Table of user aliases to display. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this modules. \| \| `detect_env_vars` \| `[]` \| Which environmental variables should trigger this module \| \| `contexts` \| `[]` \| Customized styles and symbols for specific contexts. \| \| `disabled` \| `true` \| Disables the `kubernetes` module. \| \: This option is deprecated, please add `contexts` with the corresponding `context_alias` and `user_alias` options instead. To customize the style of the module for specific environments, use the following configuration as part of the `contexts` list: \| Variable \| Description \| \|---\|---\| \| `context_pattern` \| Required* Regular expression to match current Kubernetes context name. \| \| `user_pattern` \| Regular expression to match current Kubernetes user name. \| \| `context_alias` \| Context alias to display instead of the full context name. \| \| `user_alias` \| User alias to display instead of the full user name. \| \| `style` \| The style for the module when using this context. If not set, will use module's style. \| \| `symbol` \| The symbol for the module when using this context. If not set, will use module's symbol. \| Note that all regular expression are anchored with `^<pattern>$` and so must match the whole string. The `_pattern` regular expressions may contain capture groups, which can be referenced in the corresponding alias via `$name` and `$N` (see example below and the [rust Regex::replace() documentation](https://docs.rs/regex/latest/regex/struct.Regex.html#method.replace)). ### Variables [](https://starship.rs/config/#variables-45) \| Variable \| Example \| Description \| \|---\|---\|---\| \| context \| `starship-context` \| The current kubernetes context name \| \| namespace \| `starship-namespace` \| If set, the current kubernetes namespace \| \| user \| `starship-user` \| If set, the current kubernetes user \| \| cluster \| `starship-cluster` \| If set, the current kubernetes cluster \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-39) toml ``` # ~/.config/starship.toml [kubernetes] format = 'on [⛵ ($user on )($cluster in )$context $$namespace$](dimmed green) ' disabled = false contexts = [ { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " }, ] ``` Only show the module in directories that contain a `k8s` file. toml ``` # ~/.config/starship.toml [kubernetes] disabled = false detect_files = ['k8s'] ``` #### Kubernetes Context specific config [](https://starship.rs/config/#kubernetes-context-specific-config) The `contexts` configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression. toml ``` # ~/.config/starship.toml [[kubernetes.contexts]] # "bold red" style + default symbol when Kubernetes current context name equals "production" and* the current user # equals "admin_user" context_pattern = "production" user_pattern = "admin_user" style = "bold red" context_alias = "prod" user_alias = "admin" [[kubernetes.contexts]] # "green" style + a different symbol when Kubernetes current context name contains openshift context_pattern = ".openshift." style = "green" symbol = "💔 " context_alias = "openshift" [[kubernetes.contexts]] # Using capture groups # Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone. # The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`) # and renames every matching kube context into a more readable format (`gke-cluster-name`): context_pattern = "gke_._(?P<cluster>[\\w-]+)" context_alias = "gke-$cluster" ``` ## Line Break [](https://starship.rs/config/#line-break) The `line_break` module separates the prompt into two lines. ### Options [](https://starship.rs/config/#options-51) \| Option \| Default \| Description \| \|---\|---\|---\| \| `disabled` \| `false` \| Disables the `line_break` module, making the prompt a single line. \| ### Example [](https://starship.rs/config/#example-40) toml ``` # ~/.config/starship.toml [line_break] disabled = true ``` ## Local IP [](https://starship.rs/config/#local-ip) The `localip` module shows the IPv4 address of the primary network interface. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-52) \| Option \| Default \| Description \| \|---\|---\|---\| \| `ssh_only` \| `true` \| Only show IP address when connected to an SSH session. \| \| `format` \| `'[$localipv4]($style) '` \| The format for the module. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `localip` module. \| ### Variables [](https://starship.rs/config/#variables-46) \| Variable \| Example \| Description \| \|---\|---\|---\| \| localipv4 \| 192\.168.1.13 \| Contains the primary IPv4 address \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-41) toml ``` # ~/.config/starship.toml [localip] ssh_only = false format = '@[$localipv4](bold red) ' disabled = false ``` ## Lua [](https://starship.rs/config/#lua) The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `.lua-version` file - The current directory contains a `lua` directory - The current directory contains a file with the `.lua` extension ### Options [](https://starship.rs/config/#options-53) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🌙 '` \| A format string representing the symbol of Lua. \| \| `detect_extensions` \| `['lua']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['.lua-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['lua']` \| Which folders should trigger this module. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `lua_binary` \| `'lua'` \| Configures the lua binary that Starship executes when getting the version. \| \| `disabled` \| `false` \| Disables the `lua` module. \| ### Variables [](https://starship.rs/config/#variables-47) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v5.4.0` \| The version of `lua` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-42) toml ``` # ~/.config/starship.toml [lua] format = 'via [🌕 $version](bold blue) ' ``` ## Memory Usage [](https://starship.rs/config/#memory-usage) The `memory_usage` module shows current system memory and swap usage. By default the swap usage is displayed if the total system swap is non-zero. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-54) \| Option \| Default \| Description \| \|---\|---\|---\| \| `threshold` \| `75` \| Hide the memory usage unless it exceeds this percentage. \| \| `format` \| `'via $symbol [${ram}( \| ${swap})]($style) '` \| The format for the module. \| \| `symbol` \| `'🐏'` \| The symbol used before displaying the memory usage. \| \| `style` \| `'bold dimmed white'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `memory_usage` module. \| ### Variables [](https://starship.rs/config/#variables-48) \| Variable \| Example \| Description \| \|---\|---\|---\| \| ram \| `31GiB/65GiB` \| The usage/total RAM of the current system memory. \| \| ram\_pct \| `48%` \| The percentage of the current system memory. \| \| swap\\* \| `1GiB/4GiB` \| The swap memory size of the current system swap memory file. \| \| swap\_pct\\ \| `77%` \| The swap memory percentage of the current system swap memory file. \| \| symbol \| `🐏` \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string \\: The SWAP file information is only displayed if detected on the current system ### Example [](https://starship.rs/config/#example-43) toml ``` # ~/.config/starship.toml [memory_usage] disabled = false threshold = -1 symbol = ' ' style = 'bold dimmed green' ``` ## Meson [](https://starship.rs/config/#meson) The `meson` module shows the current Meson developer environment status. By default the Meson project name is displayed, if `$MESON_DEVENV` is set. ### Options [](https://starship.rs/config/#options-55) \| Option \| Default \| Description \| \|---\|---\|---\| \| `truncation_length` \| `2^32 - 1` \| Truncates a project name to `N` graphemes. \| \| `truncation_symbol` \| `'…'` \| The symbol used to indicate a project name was truncated. You can use `''` for no symbol. \| \| `format` \| `'via [$symbol$project]($style) '` \| The format for the module. \| \| `symbol` \| `'⬢ '` \| The symbol used before displaying the project name. \| \| `style` \| `'blue bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `meson` module. \| ### Variables [](https://starship.rs/config/#variables-49) \| Variable \| Example \| Description \| \|---\|---\|---\| \| project \| `starship` \| The current Meson project name \| \| symbol \| `🐏` \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-44) toml ``` # ~/.config/starship.toml [meson] disabled = false truncation_symbol = '--' symbol = ' ' style = 'bold dimmed green' ``` ## Mercurial Branch [](https://starship.rs/config/#mercurial-branch) The `hg_branch` module shows the active branch and topic of the repo in your current directory. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-56) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `' '` \| The symbol used before the hg bookmark or branch name of the repo in your current directory. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `format` \| `'on [$symbol$branch(:$topic)]($style) '` \| The format for the module. \| \| `truncation_length` \| `2^63 - 1` \| Truncates the hg branch / topic name to `N` graphemes \| \| `truncation_symbol` \| `'…'` \| The symbol used to indicate a branch name was truncated. \| \| `disabled` \| `true` \| Disables the `hg_branch` module. \| ### Variables [](https://starship.rs/config/#variables-50) \| Variable \| Example \| Description \| \|---\|---\|---\| \| branch \| `master` \| The active mercurial branch \| \| topic \| `feature` \| The active mercurial topic \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-45) toml ``` # ~/.config/starship.toml [hg_branch] format = 'on [🌱 $branch](bold purple)' truncation_length = 4 truncation_symbol = '' ``` ## Mercurial State [](https://starship.rs/config/#mercurial-state) The `hg_state` module will show in directories which are part of a mercurial repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-57) \| Option \| Default \| Description \| \|---\|---\|---\| \| `merge` \| `'MERGING'` \| A format string displayed when a `merge` is in progress. \| \| `rebase` \| `'REBASING'` \| A format string displayed when a `rebase` is in progress. \| \| `update` \| `'UPDATING'` \| A format string displayed when a `update` is in progress. \| \| `bisect` \| `'BISECTING'` \| A format string displayed when a `bisect` is in progress. \| \| `shelve` \| `'SHELVING'` \| A format string displayed when a `shelve` is in progress. \| \| `graft` \| `'GRAFTING'` \| A format string displayed when a `graft` is in progress. \| \| `transplant` \| `'TRANSPLANTING'` \| A format string displayed when a `transplant` is in progress. \| \| `histedit` \| `'HISTEDITING'` \| A format string displayed when a `histedit` is in progress. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `format` \| `'$[$state]($style)$ '` \| The format for the module. \| \| `disabled` \| `true` \| Disables the `hg_state` module. \| ### Variables [](https://starship.rs/config/#variables-51) \| Variable \| Example \| Description \| \|---\|---\|---\| \| state \| `REBASING` \| The current state of the repo \| \| progress\_current \| `1` \| The current operation progress \| \| progress\_total \| `2` \| The total operation progress \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Mise [](https://starship.rs/config/#mise) The `mise` module shows the current mise health as reported by running `mise doctor`. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-58) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'mise '` \| The symbol used before displaying mise* health. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `format` \| `'on [$symbol$health]($style) '` \| The format for the module. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['mise.toml', 'mise.local.toml', '.mise.toml', '.mise.local.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['.mise']` \| Which folders should trigger this module. \| \| `healthy_symbol` \| `healthy` \| The message displayed when mise is healthy. \| \| `unhealthy_symbol` \| `unhealthy` \| The message displayed when mise is unhealthy. \| \| `disabled` \| `true` \| Disables the `mise` module. \| ### Variables [](https://starship.rs/config/#variables-52) \| Variable \| Example \| Description \| \|---\|---\|---\| \| health \| `healthy` \| The health of mise \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-46) toml ``` # ~/.config/starship.toml [mise] health = 'ready' ``` ## Mojo [](https://starship.rs/config/#mojo) The `mojo` module shows the current version of [Mojo programming language](https://www.modular.com/mojo) installed ### Options [](https://starship.rs/config/#options-59) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'with [$symbol($version )]($style)'` \| The format for the module. \| \| `symbol` \| `'🔥 '` \| The symbol used before displaying the version of Mojo. \| \| `style` \| `'bold 208'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `mojo` module. \| \| `detect_extensions` \| `['mojo', '🔥']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| ### Variables [](https://starship.rs/config/#variables-53) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `24.4.0` \| The version of `mojo` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-47) toml ``` # ~/.config/starship.toml [mojo] format = 'via [mojo ($version )($hash )]($style)' ``` ## NATS [](https://starship.rs/config/#nats) The `nats` module shows the name of the current [NATS](https://nats.io/) context. ### Options [](https://starship.rs/config/#options-60) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `'✉️ '` \| The symbol used before the NATS context (defaults to empty). \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `format` \| `'[$symbol$name]($style)'` \| The format for the module. \| \| `disabled` \| `false` \| Disables the `nats` module. \| ### Variables [](https://starship.rs/config/#variables-54) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| `localhost` \| The name of the NATS context \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-48) toml ``` [nats] format = '[$symbol]($style)' style = 'bold purple' ``` ## Network Namespace [](https://starship.rs/config/#network-namespace) The `netns` module shows the current network namespace. This uses `ip netns identify` to get the network namespace, so only network namespaces mounted at `/var/run/netns` will be detected. ### Options [](https://starship.rs/config/#options-61) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[$symbol \[$name\]]($style)'` \| The format for the module. \| \| `symbol` \| `'🛜 '` \| The symbol used before the network namespace (defaults to empty). \| \| `style` \| `'blue bold dimmed'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `netns` module. \| ### Variables [](https://starship.rs/config/#variables-55) \| Variable \| Example \| Description \| \|---\|---\|---\| \| name \| `my-netns` \| The name of the current network namespace \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-49) toml ``` # ~/.config/starship.toml [netns] style = 'bold yellow' symbol = '🌐 ' ``` ## Nim [](https://starship.rs/config/#nim) The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `nim.cfg` file - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension ### Options [](https://starship.rs/config/#options-62) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'👑 '` \| The symbol used before displaying the version of Nim. \| \| `detect_extensions` \| `['nim', 'nims', 'nimble']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['nim.cfg']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `nim` module. \| ### Variables [](https://starship.rs/config/#variables-56) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.2.0` \| The version of `nimc` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-50) toml ``` # ~/.config/starship.toml [nim] style = 'yellow' symbol = '🎣 ' ``` ## Nix-shell [](https://starship.rs/config/#nix-shell) The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Options [](https://starship.rs/config/#options-63) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol$state( $$name$)]($style) '` \| The format for the module. \| \| `symbol` \| `'❄️ '` \| A format string representing the symbol of nix-shell. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `impure_msg` \| `'impure'` \| A format string shown when the shell is impure. \| \| `pure_msg` \| `'pure'` \| A format string shown when the shell is pure. \| \| `unknown_msg` \| `''` \| A format string shown when it is unknown if the shell is pure/impure. \| \| `disabled` \| `false` \| Disables the `nix_shell` module. \| \| `heuristic` \| `false` \| Attempts to detect new `nix shell`\-style shells with a heuristic. \| ### Variables [](https://starship.rs/config/#variables-57) \| Variable \| Example \| Description \| \|---\|---\|---\| \| state \| `pure` \| The state of the nix-shell \| \| name \| `lorri` \| The name of the nix-shell \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-51) toml ``` # ~/.config/starship.toml [nix_shell] disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( $$name$)](bold blue) ' ``` ## Node.js [](https://starship.rs/config/#node-js) The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file - The current directory contains a `node_modules` directory - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts`, `.mts` or `.cts` extension Additionally, the module will be hidden by default if the directory contains a `bunfig.toml`, `bun.lock`, or `bun.lockb` file, overriding the above conditions. ### Options [](https://starship.rs/config/#options-64) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `' '` \| A format string representing the symbol of Node.js. \| \| `detect_extensions` \| `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['package.json', '.node-version', '.nvmrc']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['node_modules']` \| Which folders should trigger this module. \| \| `style` \| `'bold green'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `nodejs` module. \| \| `not_capable_style` \| `'bold red'` \| The style for the module when an engines property in package.json does not match the Node.js version. \| ### Variables [](https://starship.rs/config/#variables-58) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v13.12.0` \| The version of `node` \| \| engines\_version \| `>=12.0.0` \| `node` version requirement as set in the engines property of `package.json`. Will only show if the version requirement does not match the `node` version. \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-52) toml ``` # ~/.config/starship.toml [nodejs] format = 'via [🤖 $version](bold green) ' ``` ## OCaml [](https://starship.rs/config/#ocaml) The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory - The current directory contains a `dune` or `dune-project` file - The current directory contains a `jbuild` or `jbuild-ignore` file - The current directory contains a `.merlin` file - The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension ### Options [](https://starship.rs/config/#options-65) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )($$switch_indicator$switch_name$ )]($style)'` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐫 '` \| The symbol used before displaying the version of OCaml. \| \| `global_switch_indicator` \| `''` \| The format string used to represent global OPAM switch. \| \| `local_switch_indicator` \| `''` \| The format string used to represent local OPAM switch. \| \| `detect_extensions` \| `['opam', 'ml', 'mli', 're', 'rei']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['_opam', 'esy.lock']` \| Which folders should trigger this module. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `ocaml` module. \| ### Variables [](https://starship.rs/config/#variables-59) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v4.10.0` \| The version of `ocaml` \| \| switch\_name \| `my-project` \| The active OPAM switch \| \| switch\_indicator \| \| Mirrors the value of `indicator` for currently active OPAM switch \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-53) toml ``` # ~/.config/starship.toml [ocaml] format = 'via [🐪 $version]($style) ' ``` ## Odin [](https://starship.rs/config/#odin) The `odin` module shows the currently installed version of [Odin](https://odin-lang.org/). By default the module will be shown if the current directory contains a `.odin` file. ### Options [](https://starship.rs/config/#options-66) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `show_commit` \| `false` \| Shows the commit as part of the version. \| \| `symbol` \| `'Ø '` \| The symbol used before displaying the version of Odin. \| \| `style` \| `'bold bright-blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `odin` module. \| \| `detect_extensions` \| `['odin']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| ### Variables [](https://starship.rs/config/#variables-60) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `dev-2024-03` \| The version of `odin` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-54) toml ``` # ~/.config/starship.toml [odin] format = 'via [󰹩 ($version )]($style)' show_commit = true ``` ## Open Policy Agent [](https://starship.rs/config/#open-policy-agent) The `opa` module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a `.rego` file. ### Options [](https://starship.rs/config/#options-67) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🪖 '` \| A format string representing the symbol of OPA. \| \| `detect_extensions` \| `['rego']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `opa` module. \| ### Variables [](https://starship.rs/config/#variables-61) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.44.0` \| The version of `opa` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-55) toml ``` # ~/.config/starship.toml [opa] format = 'via [⛑️ $version](bold red) ' ``` ## OpenStack [](https://starship.rs/config/#openstack) The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. ### Options [](https://starship.rs/config/#options-68) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'on [$symbol$cloud($$project$)]($style) '` \| The format for the module. \| \| `symbol` \| `'☁️ '` \| The symbol used before displaying the current OpenStack cloud. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `openstack` module. \| ### Variables [](https://starship.rs/config/#variables-62) \| Variable \| Example \| Description \| \|---\|---\|---\| \| cloud \| `corp` \| The current OpenStack cloud \| \| project \| `dev` \| The current OpenStack project \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-56) toml ``` # ~/.config/starship.toml [openstack] format = 'on [$symbol$cloud($$project$)]($style) ' style = 'bold yellow' symbol = '☁️ ' ``` ## OS [](https://starship.rs/config/#os) The `os` module shows the current operating system. OS information is detected via the [os\_info](https://lib.rs/crates/os_info) crate. WARNING The [os\_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-69) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[$symbol]($style)'` \| The format for the module. \| \| `style` \| `'bold white'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `os` module. \| \| `symbols` \| \| A table that maps each operating system to its symbol. \| `symbols` allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a [feature request](https://github.com/starship/starship/issues/new/choose). toml ``` # This is the default symbols table. [os.symbols] AIX = "➿ " Alpaquita = "🔔 " AlmaLinux = "💠 " Alpine = "🏔️ " ALTLinux = "Ⓐ " Amazon = "🙂 " Android = "🤖 " AOSC = "🐱 " Arch = "🎗️ " Artix = "🎗️ " Bluefin = "🐟 " CachyOS = "🎗️ " CentOS = "💠 " Debian = "🌀 " DragonFly = "🐉 " Elementary = "🍏 " Emscripten = "🔗 " EndeavourOS = "🚀 " Fedora = "🎩 " FreeBSD = "😈 " Garuda = "🦅 " Gentoo = "🗜️ " HardenedBSD = "🛡️ " Illumos = "🐦 " Ios = "📱 " InstantOS = "⏲️ " Kali = "🐉 " Linux = "🐧 " Mabox = "📦 " Macos = "🍎 " Manjaro = "🥭 " Mariner = "🌊 " MidnightBSD = "🌘 " Mint = "🌿 " NetBSD = "🚩 " NixOS = "❄️ " Nobara = "🎩 " OpenBSD = "🐡 " OpenCloudOS = "☁️ " openEuler = "🦉 " openSUSE = "🦎 " OracleLinux = "🦴 " PikaOS = "🐤 " Pop = "🍭 " Raspbian = "🍓 " Redhat = "🎩 " RedHatEnterprise = "🎩 " RockyLinux = "💠 " Redox = "🧪 " Solus = "⛵ " SUSE = "🦎 " Ubuntu = "🎯 " Ultramarine = "🔷 " Unknown = "❓ " Uos = "🐲 " Void = " " Windows = "🪟 " Zorin = "🔹 " ``` ### Variables [](https://starship.rs/config/#variables-63) \| Variable \| Example \| Description \| \|---\|---\|---\| \| symbol \| `🎗️` \| The current operating system symbol from advanced option `symbols` \| \| name \| `Arch Linux` \| The current operating system name \| \| type \| `Arch` \| The current operating system type \| \| codename \| \| The current operating system codename, if applicable \| \| edition \| \| The current operating system edition, if applicable \| \| version \| \| The current operating system version, if applicable \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-57) toml ``` # ~/.config/starship.toml [os] format = "on [($name )]($style)" style = "bold blue" disabled = false [os.symbols] Windows = " " Arch = "Arch is the best! " ``` ## Package Version [](https://starship.rs/config/#package-version) The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `galaxy`, `daml` and `dart` packages. - [npm](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [JSR](https://jsr.io/) – The `jsr` package version is extracted from the `jsr.json`/`jsr.jsonc` or `deno.json`/`deno.jsonc` present in the current directory - [Cargo](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory - [Nimble](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `.nimble` file present in the current directory with the `nimble dump` command - [Poetry](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [Python](https://www.python.org/) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory - [Composer](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [Gradle](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory - [Julia](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory - [Mix](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory - [Helm](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory - [Maven](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory - [Meson](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory - [Shards](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory - [Galaxy](https://galaxy.ansible.com/) - The `galaxy` package version is extracted from the `galaxy.yml` present in the current directory - [V](https://vlang.io/) - The `vlang` package version is extracted from the `v.mod` present in the current directory - [SBT](https://scala-sbt.org/) - The `sbt` package version is extracted from the `build.sbt` present in the current directory - [Daml](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory - [Dart](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory > ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. ### Options [](https://starship.rs/config/#options-70) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'is [$symbol$version]($style) '` \| The format for the module. \| \| `symbol` \| `'📦 '` \| The symbol used before displaying the version the package. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `style` \| `'bold 208'` \| The style for the module. \| \| `display_private` \| `false` \| Enable displaying version for packages marked as private. \| \| `disabled` \| `false` \| Disables the `package` module. \| ### Variables [](https://starship.rs/config/#variables-64) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.0.0` \| The version of your package \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-58) toml ``` # ~/.config/starship.toml [package] format = 'via [🎁 $version](208 bold) ' ``` ## Perl [](https://starship.rs/config/#perl) The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `META.json` file or `META.yml` file - The current directory contains a `.perl-version` file - The current directory contains a `.pl`, `.pm` or `.pod` ### Options [](https://starship.rs/config/#options-71) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐪 '` \| The symbol used before displaying the version of Perl \| \| `detect_extensions` \| `['pl', 'pm', 'pod']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold 149'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `perl` module. \| ### Variables [](https://starship.rs/config/#variables-65) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v5.26.1` \| The version of `perl` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-59) toml ``` # ~/.config/starship.toml [perl] format = 'via [🦪 $version]($style) ' ``` ## PHP [](https://starship.rs/config/#php) The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` extension ### Options [](https://starship.rs/config/#options-72) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐘 '` \| The symbol used before displaying the version of PHP. \| \| `detect_extensions` \| `['php']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['composer.json', '.php-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'147 bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `php` module. \| ### Variables [](https://starship.rs/config/#variables-66) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v7.3.8` \| The version of `php` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-60) toml ``` # ~/.config/starship.toml [php] format = 'via [🔹 $version](147 bold) ' ``` ## Pijul Channel [](https://starship.rs/config/#pijul-channel) The `pijul_channel` module shows the active channel of the repo in your current directory. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-73) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `' '` \| The symbol used before the pijul channel name of the repo in your current directory. \| \| `style` \| `'bold purple'` \| The style for the module. \| \| `format` \| `'on [$symbol$channel]($style) '` \| The format for the module. \| \| `truncation_length` \| `2^63 - 1` \| Truncates the pijul channel name to `N` graphemes \| \| `truncation_symbol` \| `'…'` \| The symbol used to indicate a branch name was truncated. \| \| `disabled` \| `true` \| Disables the `pijul` module. \| ## Pixi [](https://starship.rs/config/#pixi) The `pixi` module shows the installed [pixi](https://pixi.sh/) version as well as the activated environment, if `$PIXI_ENVIRONMENT_NAME` is set. TIP This does not suppress pixi's own prompt modifier, you may want to run `pixi config set shell.change-ps1 false`. ### Options [](https://starship.rs/config/#options-74) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )($$environment$ )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch`. \| \| `symbol` \| `'🧚 '` \| The symbol used before the environment name. \| \| `style` \| `'yellow bold'` \| The style for the module. \| \| `show_default_environment` \| `true` \| Whether to indicate that the `default` environment of your project is activated. \| \| `pixi_binary` \| `['pixi']` \| Configures the pixi binary that Starship should execute when getting the version. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['pixi.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `pixi` module. \| ### Variables [](https://starship.rs/config/#variables-67) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.33.0` \| The version of `pixi` \| \| environment \| `py311` \| The current pixi environment \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-61) toml ``` # ~/.config/starship.toml [pixi] format = '[$symbol$environment](yellow) ' ``` ## Pulumi [](https://starship.rs/config/#pulumi) The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. TIP By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](https://starship.rs/config/#with-pulumi-version). By default the module will be shown if any of the following conditions are met: - The current directory contains either `Pulumi.yaml` or `Pulumi.yml` - A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` unless `search_upwards` is set to `false` ### Options [](https://starship.rs/config/#options-75) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($username@)$stack]($style) '` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `' '` \| A format string shown before the Pulumi stack. \| \| `style` \| `'bold 5'` \| The style for the module. \| \| `search_upwards` \| `true` \| Enable discovery of pulumi config files in parent directories. \| \| `disabled` \| `false` \| Disables the `pulumi` module. \| ### Variables [](https://starship.rs/config/#variables-68) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.12.24` \| The version of `pulumi` \| \| stack \| `dev` \| The current Pulumi stack \| \| username \| `alice` \| The current Pulumi username \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-62) #### With Pulumi Version [](https://starship.rs/config/#with-pulumi-version) toml ``` # ~/.config/starship.toml [pulumi] format = '[🛥 ($version )$stack]($style) ' ``` #### Without Pulumi version [](https://starship.rs/config/#without-pulumi-version) toml ``` # ~/.config/starship.toml [pulumi] symbol = '🛥 ' format = '[$symbol$stack]($style) ' ``` ## PureScript [](https://starship.rs/config/#purescript) The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: - The current directory contains a `spago.dhall` file - The current directory contains a `spago.yaml` file - The current directory contains a `spago.lock` file - The current directory contains a file with the `.purs` extension ### Options [](https://starship.rs/config/#options-76) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'<=> '` \| The symbol used before displaying the version of PureScript. \| \| `detect_extensions` \| `['purs']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['spago.dhall', 'spago.yaml', 'spago.lock']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold white'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `purescript` module. \| ### Variables [](https://starship.rs/config/#variables-69) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `0.13.5` \| The version of `purescript` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-63) toml ``` # ~/.config/starship.toml [purescript] format = 'via [$symbol$version](bold white)' ``` ## Python [](https://starship.rs/config/#python) The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. By default, the module will be shown if any of the following conditions are met: - The current directory contains a `.python-version` file - The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file - The current directory contains a `pyproject.toml` file - The current directory contains a `requirements.txt` file - The current directory contains a `setup.py` file - The current directory contains a `tox.ini` file - The current directory contains a file with the `.py` extension. - The current directory contains a file with the `.ipynb` extension. - A virtual environment is currently activated ### Options [](https://starship.rs/config/#options-77) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [${symbol}${pyenv_prefix}(${version} )($$virtualenv$ )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐍 '` \| A format string representing the symbol of Python \| \| `style` \| `'yellow bold'` \| The style for the module. \| \| `pyenv_version_name` \| `false` \| Use pyenv to get Python version \| \| `pyenv_prefix` \| `'pyenv'` \| Prefix before pyenv version display, only used if pyenv is used \| \| `python_binary` \| `['python', 'python3', 'python2']` \| Configures the python binaries that Starship should execute when getting the version. \| \| `detect_extensions` \| `['py', 'ipynb']` \| Which extensions should trigger this module \| \| `detect_files` \| `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` \| Which filenames should trigger this module \| \| `detect_folders` \| `[]` \| Which folders should trigger this module \| \| `disabled` \| `false` \| Disables the `python` module. \| TIP The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. ### Variables [](https://starship.rs/config/#variables-70) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `'v3.8.1'` \| The version of `python` \| \| symbol \| `'🐍 '` \| Mirrors the value of option `symbol` \| \| style \| `'yellow bold'` \| Mirrors the value of option `style` \| \| pyenv\_prefix \| `'pyenv '` \| Mirrors the value of option `pyenv_prefix` \| \| virtualenv \| `'venv'` \| The current `virtualenv` name \| ### Example [](https://starship.rs/config/#example-64) toml ``` # ~/.config/starship.toml [python] symbol = '👾 ' pyenv_version_name = true ``` toml ``` # ~/.config/starship.toml [python] # Only use the `python3` binary to get the version. python_binary = 'python3' ``` toml ``` # ~/.config/starship.toml [python] # Don't trigger for files with the py extension detect_extensions = [] ``` ## Quarto [](https://starship.rs/config/#quarto) The `quarto` module shows the current installed version of Quarto used in a project. By default, the module will be shown if any of the following conditions are met: - The current directory contains a `_quarto.yml` file - The current directory contains any `.qmd` file ### Options [](https://starship.rs/config/#options-78) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'⨁ '` \| A format string representing the symbol of Quarto \| \| `style` \| `'bold #75AADB'` \| The style for the module. \| \| `detect_extensions` \| `['.qmd']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['_quarto.yml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `quarto` module. \| ### Variables [](https://starship.rs/config/#variables-71) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `1.4.549` \| The version of `quarto` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## R [](https://starship.rs/config/#r) The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with the `.R` extension. - The current directory contains a file with the `.Rd` extension. - The current directory contains a file with the `.Rmd` extension. - The current directory contains a file with the `.Rproj` extension. - The current directory contains a file with the `.Rsx` extension. - The current directory contains a `.Rprofile` file - The current directory contains a `.Rproj.user` folder ### Options [](https://starship.rs/config/#options-79) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'📐'` \| A format string representing the symbol of R. \| \| `style` \| `'blue bold'` \| The style for the module. \| \| `detect_extensions` \| `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` \| Which extensions should trigger this module \| \| `detect_files` \| `['.Rprofile']` \| Which filenames should trigger this module \| \| `detect_folders` \| `['.Rproj.user']` \| Which folders should trigger this module \| \| `disabled` \| `false` \| Disables the `r` module. \| ### Variables [](https://starship.rs/config/#variables-72) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v4.0.5` \| The version of `R` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style \| `'blue bold'` \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-65) toml ``` # ~/.config/starship.toml [rlang] format = 'with [📐 $version](blue bold) ' ``` ## Raku [](https://starship.rs/config/#raku) The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `META6.json` file - The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6` ### Options [](https://starship.rs/config/#options-80) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version-$vm_version )]($style)'` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🦋 '` \| The symbol used before displaying the version of Raku \| \| `detect_extensions` \| `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['META6.json']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold 149'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `raku` module. \| ### Variables [](https://starship.rs/config/#variables-73) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v6.d` \| The version of `raku` \| \| vm\_version \| `moar` \| The version of VM `raku` is built on \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-66) toml ``` # ~/.config/starship.toml [raku] format = 'via [🦪 $version]($style) ' ``` ## Red [](https://starship.rs/config/#red) By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension ### Options [](https://starship.rs/config/#options-81) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🔺 '` \| A format string representing the symbol of Red. \| \| `detect_extensions` \| `['red']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'red bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `red` module. \| ### Variables [](https://starship.rs/config/#variables-74) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v2.5.1` \| The version of `red` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-67) toml ``` # ~/.config/starship.toml [red] symbol = '🔴 ' ``` ## Ruby [](https://starship.rs/config/#ruby) By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file - The current directory contains a `.rb` file - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set Starship gets the current Ruby version by running `ruby -v`. ### Options [](https://starship.rs/config/#options-82) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'💎 '` \| A format string representing the symbol of Ruby. \| \| `detect_extensions` \| `['rb']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Gemfile', '.ruby-version']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `detect_variables` \| `['RUBY_VERSION', 'RBENV_VERSION']` \| Which environment variables should trigger this module. \| \| `style` \| `'bold red'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `ruby` module. \| ### Variables [](https://starship.rs/config/#variables-75) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v2.5.1` \| The version of `ruby` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \| gemset \| `test` \| Optional, gets the current RVM gemset name. \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-68) toml ``` # ~/.config/starship.toml [ruby] symbol = '🔺 ' ``` ## Rust [](https://starship.rs/config/#rust) By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension ### Options [](https://starship.rs/config/#options-83) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🦀 '` \| A format string representing the symbol of Rust \| \| `detect_extensions` \| `['rs']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Cargo.toml']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold red'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `rust` module. \| ### Variables [](https://starship.rs/config/#variables-76) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v1.43.0-nightly` \| The version of `rustc` \| \| numver \| `1.51.0` \| The numeric component of the `rustc` version \| \| toolchain \| `beta` \| The toolchain version \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-69) toml ``` # ~/.config/starship.toml [rust] format = 'via [⚙️ $version](red bold)' ``` ## Scala [](https://starship.rs/config/#scala) The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension - The current directory contains a directory named `.metals` ### Options [](https://starship.rs/config/#options-84) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [${symbol}(${version} )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `detect_extensions` \| `['sbt', 'scala']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['.scalaenv', '.sbtenv', 'build.sbt']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['.metals']` \| Which folders should trigger this modules. \| \| `symbol` \| `'🆂 '` \| A format string representing the symbol of Scala. \| \| `style` \| `'red dimmed'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `scala` module. \| ### Variables [](https://starship.rs/config/#variables-77) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `2.13.5` \| The version of `scala` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-70) toml ``` # ~/.config/starship.toml [scala] symbol = '🌟 ' ``` ## Shell [](https://starship.rs/config/#shell) The `shell` module shows an indicator for currently used shell. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-85) \| Option \| Default \| Description \| \|---\|---\|---\| \| `bash_indicator` \| `'bsh'` \| A format string used to represent bash. \| \| `fish_indicator` \| `'fsh'` \| A format string used to represent fish. \| \| `zsh_indicator` \| `'zsh'` \| A format string used to represent zsh. \| \| `powershell_indicator` \| `'psh'` \| A format string used to represent powershell. \| \| `pwsh_indicator` \| \| A format string used to represent pwsh. The default value mirrors the value of `powershell_indicator`. \| \| `ion_indicator` \| `'ion'` \| A format string used to represent ion. \| \| `elvish_indicator` \| `'esh'` \| A format string used to represent elvish. \| \| `tcsh_indicator` \| `'tsh'` \| A format string used to represent tcsh. \| \| `xonsh_indicator` \| `'xsh'` \| A format string used to represent xonsh. \| \| `cmd_indicator` \| `'cmd'` \| A format string used to represent cmd. \| \| `nu_indicator` \| `'nu'` \| A format string used to represent nu. \| \| `unknown_indicator` \| `''` \| The default value to be displayed when the shell is unknown. \| \| `format` \| `'[$indicator]($style) '` \| The format for the module. \| \| `style` \| `'white bold'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `shell` module. \| ### Variables [](https://starship.rs/config/#variables-78) \| Variable \| Default \| Description \| \|---\|---\|---\| \| indicator \| \| Mirrors the value of `indicator` for currently used shell. \| \| style\ \| \| Mirrors the value of option `style`. \| \: This variable can only be used as a part of a style string ### Examples [](https://starship.rs/config/#examples-6) toml ``` # ~/.config/starship.toml [shell] fish_indicator = '󰈺 ' powershell_indicator = '_' unknown_indicator = 'mystery shell' style = 'cyan bold' disabled = false ``` ## SHLVL [](https://starship.rs/config/#shlvl) The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-86) \| Option \| Default \| Description \| \|---\|---\|---\| \| `threshold` \| `2` \| Display threshold. \| \| `format` \| `'[$symbol$shlvl]($style) '` \| The format for the module. \| \| `symbol` \| `'↕️ '` \| The symbol used to represent the `SHLVL`. \| \| `repeat` \| `false` \| Causes `symbol` to be repeated by the current `SHLVL` amount. \| \| `repeat_offset` \| `0` \| Decrements number of times `symbol` is repeated by the offset value \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `true` \| Disables the `shlvl` module. \| ### Variables [](https://starship.rs/config/#variables-79) \| Variable \| Example \| Description \| \|---\|---\|---\| \| shlvl \| `3` \| The current value of `SHLVL` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-71) toml ``` # ~/.config/starship.toml [shlvl] disabled = false format = '$shlvl level(s) down' threshold = 3 ``` Using `repeat` and `repeat_offset` along with `character` module, one can get prompt like `❯❯❯` where last character is colored appropriately for return status code and preceding characters are provided by `shlvl`. toml ``` # ~/.config/starship.toml [shlvl] disabled = false format = '[$symbol]($style)' repeat = true symbol = '❯' repeat_offset = 1 ``` ## Singularity [](https://starship.rs/config/#singularity) The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options [](https://starship.rs/config/#options-87) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[$symbol\[$env\]]($style) '` \| The format for the module. \| \| `symbol` \| `''` \| A format string displayed before the image name. \| \| `style` \| `'bold dimmed blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `singularity` module. \| ### Variables [](https://starship.rs/config/#variables-80) \| Variable \| Example \| Description \| \|---\|---\|---\| \| env \| `centos.img` \| The current Singularity image \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-72) toml ``` # ~/.config/starship.toml [singularity] format = '[📦 \[$env\]]($style) ' ``` ## Solidity [](https://starship.rs/config/#solidity) The `solidity` module shows the currently installed version of [Solidity](https://soliditylang.org/) The module will be shown if any of the following conditions are met: - The current directory contains a file with the `.sol` extension ### Options [](https://starship.rs/config/#options-88) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${major}.${minor}.${patch}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'S '` \| A format string representing the symbol of Solidity \| \| \`compiler \| \['solc'\] \| The default compiler for Solidity. \| \| `detect_extensions` \| `['sol']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `disabled` \| `false` \| Disables this module. \| ### Variables [](https://starship.rs/config/#variables-81) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.8.1` \| The version of `solidity` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-73) toml ``` # ~/.config/starship.toml [solidity] format = "via [S $version](blue bold)" ``` ## Spack [](https://starship.rs/config/#spack) The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. ### Options [](https://starship.rs/config/#options-89) \| Option \| Default \| Description \| \|---\|---\|---\| \| `truncation_length` \| `1` \| The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](https://starship.rs/config/#directory) module. \| \| `symbol` \| `'🅢 '` \| The symbol used before the environment name. \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `format` \| `'via [$symbol$environment]($style) '` \| The format for the module. \| \| `disabled` \| `false` \| Disables the `spack` module. \| ### Variables [](https://starship.rs/config/#variables-82) \| Variable \| Example \| Description \| \|---\|---\|---\| \| environment \| `astronauts` \| The current spack environment \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-74) toml ``` # ~/.config/starship.toml [spack] format = '[$symbol$environment](dimmed blue) ' ``` ## Status [](https://starship.rs/config/#status) The `status` module displays the exit code of the previous command. If \$success\_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-90) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[$symbol$status]($style) '` \| The format of the module \| \| `symbol` \| `'❌'` \| The symbol displayed on program error \| \| `success_symbol` \| `''` \| The symbol displayed on program success \| \| `not_executable_symbol` \| `'🚫'` \| The symbol displayed when file isn't executable \| \| `not_found_symbol` \| `'🔍'` \| The symbol displayed when the command can't be found \| \| `sigint_symbol` \| `'🧱'` \| The symbol displayed on SIGINT (Ctrl + c) \| \| `signal_symbol` \| `'⚡'` \| The symbol displayed on any signal \| \| `style` \| `'bold red'` \| The style for the module. \| \| `success_style` \| \| The style used on program success (defaults to `style` if unset). \| \| `failure_style` \| \| The style used on program failure (defaults to `style` if unset). \| \| `recognize_signal_code` \| `true` \| Enable signal mapping from exit code \| \| `map_symbol` \| `false` \| Enable symbols mapping from exit code \| \| `pipestatus` \| `false` \| Enable pipestatus reporting \| \| `pipestatus_separator` \| `\|` \| The symbol used to separate pipestatus segments (supports formatting) \| \| `pipestatus_format` \| `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style) '` \| The format of the module when the command is a pipeline \| \| `pipestatus_segment_format` \| \| When specified, replaces `format` when formatting pipestatus segments \| \| `disabled` \| `true` \| Disables the `status` module. \| ### Variables [](https://starship.rs/config/#variables-83) \| Variable \| Example \| Description \| \|---\|---\|---\| \| status \| `127` \| The exit code of the last command \| \| hex\_status \| `0x7F` \| The exit code of the last command in hex \| \| int \| `127` \| The exit code of the last command \| \| common\_meaning \| `ERROR` \| Meaning of the code if not a signal \| \| signal\_number \| `9` \| Signal number corresponding to the exit code, only if signalled \| \| signal\_name \| `KILL` \| Name of the signal corresponding to the exit code, only if signalled \| \| maybe\_int \| `7` \| Contains the exit code number when no meaning has been found \| \| pipestatus \| \| Rendering of in pipeline programs' exit codes, this is only available in pipestatus\_format \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `success_style` on program success and `failure_style` otherwise \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-75) toml ``` # ~/.config/starship.toml [status] style = 'bg:blue' symbol = '🔴 ' success_symbol = '🟢 SUCCESS' format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` ## Sudo [](https://starship.rs/config/#sudo) The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-91) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'[as $symbol]($style)'` \| The format of the module \| \| `symbol` \| `'🧙 '` \| The symbol displayed when credentials are cached \| \| `style` \| `'bold blue'` \| The style for the module. \| \| `allow_windows` \| `false` \| Since windows has no default sudo, default is disabled. \| \| `disabled` \| `true` \| Disables the `sudo` module. \| ### Variables [](https://starship.rs/config/#variables-84) \| Variable \| Example \| Description \| \|---\|---\|---\| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-76) toml ``` # ~/.config/starship.toml [sudo] style = 'bold green' symbol = '👩‍💻 ' disabled = false ``` toml ``` # On windows # $HOME\.starship\config.toml [sudo] allow_windows = true disabled = false ``` ## Swift [](https://starship.rs/config/#swift) By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension ### Options [](https://starship.rs/config/#options-92) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'🐦 '` \| A format string representing the symbol of Swift \| \| `detect_extensions` \| `['swift']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Package.swift']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'bold 202'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `swift` module. \| ### Variables [](https://starship.rs/config/#variables-85) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v5.2.4` \| The version of `swift` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-77) toml ``` # ~/.config/starship.toml [swift] format = 'via [🏎 $version](red bold)' ``` ## Terraform [](https://starship.rs/config/#terraform) The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. It supports both Hashicorp Terraform and OpenTofu for version detection. TIP By default the Terraform/OpenTofu version is not shown, since this is slow for current versions when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](https://starship.rs/config/#with-terraform-version). By default the module will be shown if any of the following conditions are met: - The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions ### Options [](https://starship.rs/config/#options-93) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol$workspace]($style) '` \| The format string for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'💠'` \| A format string shown before the terraform workspace. \| \| `detect_extensions` \| `['tf', 'tfplan', 'tfstate']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `['.terraform']` \| Which folders should trigger this module. \| \| `style` \| `'bold 105'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `terraform` module. \| \| `commands` \| `[ [ 'terraform', 'version' ], [ 'tofu', 'version' ] ]` \| How to detect what the Terraform version is. \| ### Variables [](https://starship.rs/config/#variables-86) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.12.24` \| The version of `terraform` \| \| workspace \| `default` \| The current Terraform workspace \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-78) #### With Terraform Version [](https://starship.rs/config/#with-terraform-version) toml ``` # ~/.config/starship.toml [terraform] format = 'via [$symbol$version $workspace]($style) ' ``` #### Without Terraform version [](https://starship.rs/config/#without-terraform-version) toml ``` # ~/.config/starship.toml [terraform] format = 'via [$symbol$workspace]($style) ' ``` ## Time [](https://starship.rs/config/#time) The `time` module shows the current local* time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. TIP This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ### Options [](https://starship.rs/config/#options-94) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'at [$time]($style) '` \| The format string for the module. \| \| `use_12hr` \| `false` \| Enables 12 hour formatting \| \| `time_format` \| see below \| The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. \| \| `style` \| `'bold yellow'` \| The style for the module time \| \| `utc_time_offset` \| `'local'` \| Sets the UTC offset to use. Range from -24 \< x \< 24. Allows floats to accommodate 30/45 minute timezone offsets. \| \| `disabled` \| `true` \| Disables the `time` module. \| \| `time_range` \| `'-'` \| Sets the time range during which the module will be shown. Times must be specified in 24-hours format \| If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables [](https://starship.rs/config/#variables-87) \| Variable \| Example \| Description \| \|---\|---\|---\| \| time \| `13:08:10` \| The current time. \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-79) toml ``` # ~/.config/starship.toml [time] disabled = false format = '🕙[\[ $time \]]($style) ' time_format = '%T' utc_time_offset = '-5' time_range = '10:00:00-14:00:00' ``` ## Typst [](https://starship.rs/config/#typst) The `typst` module shows the current installed version of Typst used in a project. By default, the module will be shown if any of the following conditions are met: - The current directory contains a `template.typ` file - The current directory contains any `.typ` file ### Options [](https://starship.rs/config/#options-95) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'t '` \| A format string representing the symbol of Typst \| \| `style` \| `'bold #0093A7'` \| The style for the module. \| \| `detect_extensions` \| `['.typ']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['template.typ']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `disabled` \| `false` \| Disables the `typst` module. \| ### Variables [](https://starship.rs/config/#variables-88) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.9.0` \| The version of `typst`, alias for typst\_version \| \| typst\_version \| `default` \| The current Typst version \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Username [](https://starship.rs/config/#username) The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - The current user is root/admin - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true - The array `detect_env_vars` contains at least the name of one environment variable, that is set TIP SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. ### Options [](https://starship.rs/config/#options-96) \| Option \| Default \| Description \| \|---\|---\|---\| \| `style_root` \| `'bold red'` \| The style used when the user is root/admin. \| \| `style_user` \| `'bold yellow'` \| The style used for non-root users. \| \| `detect_env_vars` \| `[]` \| Which environment variable(s) should trigger this module. \| \| `format` \| `'[$user]($style) in '` \| The format for the module. \| \| `show_always` \| `false` \| Always shows the `username` module. \| \| `disabled` \| `false` \| Disables the `username` module. \| \| `aliases` \| `{}` \| Translate system usernames to something else. \| ### Variables [](https://starship.rs/config/#variables-89) \| Variable \| Example \| Description \| \|---\|---\|---\| \| `style` \| `'red bold'` \| Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. \| \| `user` \| `'matchai'` \| The currently logged-in user ID. \| ### Example [](https://starship.rs/config/#example-80) #### Always show the username [](https://starship.rs/config/#always-show-the-username) toml ``` # ~/.config/starship.toml [username] style_user = 'white bold' style_root = 'black bold' format = 'user: [$user]($style) ' disabled = false show_always = true aliases = { "corpuser034g" = "matchai" } ``` ## Vagrant [](https://starship.rs/config/#vagrant) The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: - The current directory contains a `Vagrantfile` file ### Options [](https://starship.rs/config/#options-97) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'⍱ '` \| A format string representing the symbol of Vagrant. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module. \| \| `detect_files` \| `['Vagrantfile']` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'cyan bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `vagrant` module. \| ### Variables [](https://starship.rs/config/#variables-90) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `Vagrant 2.2.10` \| The version of `Vagrant` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-81) toml ``` # ~/.config/starship.toml [vagrant] format = 'via [⍱ $version](bold white) ' ``` ## V [](https://starship.rs/config/#v) The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met: - The current directory contains a file with `.v` extension - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file ### Options [](https://starship.rs/config/#options-98) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'V '` \| A format string representing the symbol of V \| \| `detect_extensions` \| `['v']` \| Which extensions should trigger this module. \| \| `detect_files` \| `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| \| `style` \| `'blue bold'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `vlang` module. \| ### Variables [](https://starship.rs/config/#variables-91) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.2` \| The version of `v` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| ### Example [](https://starship.rs/config/#example-82) toml ``` # ~/.config/starship.toml [vlang] format = 'via [V $version](blue bold) ' ``` ## VCSH [](https://starship.rs/config/#vcsh) The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Options [](https://starship.rs/config/#options-99) \| Option \| Default \| Description \| \|---\|---\|---\| \| `symbol` \| `''` \| The symbol used before displaying the repository name. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `format` \| `'vcsh [$symbol$repo]($style) '` \| The format for the module. \| \| `disabled` \| `false` \| Disables the `vcsh` module. \| ### Variables [](https://starship.rs/config/#variables-92) \| Variable \| Example \| Description \| \|---\|---\|---\| \| repo \| `dotfiles` if in a VCSH repo named dotfiles \| The active repository name \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\* \| `black bold dimmed` \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-83) toml ``` # ~/.config/starship.toml [vcsh] format = '[🆅 $repo](bold blue) ' ``` ## XMake [](https://starship.rs/config/#xmake) The `xmake` module shows the currently installed version of [XMake](https://xmake.io/). By default the module will be activated if any of the following conditions are met: - The current directory contains a `xmake.lua` file ### Options [](https://starship.rs/config/#options-100) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'△ '` \| The symbol used before the version of cmake. \| \| `detect_extensions` \| `[]` \| Which extensions should trigger this module \| \| `detect_files` \| `['xmake.lua']` \| Which filenames should trigger this module \| \| `detect_folders` \| `[]` \| Which folders should trigger this module \| \| `style` \| `'bold green'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `xmake` module. \| ### Variables [](https://starship.rs/config/#variables-93) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v2.9.5` \| The version of xmake \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ## Zig [](https://starship.rs/config/#zig) By default the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file ### Options [](https://starship.rs/config/#options-101) \| Option \| Default \| Description \| \|---\|---\|---\| \| `format` \| `'via [$symbol($version )]($style)'` \| The format for the module. \| \| `version_format` \| `'v${raw}'` \| The version format. Available vars are `raw`, `major`, `minor`, & `patch` \| \| `symbol` \| `'↯ '` \| The symbol used before displaying the version of Zig. \| \| `style` \| `'bold yellow'` \| The style for the module. \| \| `disabled` \| `false` \| Disables the `zig` module. \| \| `detect_extensions` \| `['zig']` \| Which extensions should trigger this module. \| \| `detect_files` \| `[]` \| Which filenames should trigger this module. \| \| `detect_folders` \| `[]` \| Which folders should trigger this module. \| ### Variables [](https://starship.rs/config/#variables-94) \| Variable \| Example \| Description \| \|---\|---\|---\| \| version \| `v0.6.0` \| The version of `zig` \| \| symbol \| \| Mirrors the value of option `symbol` \| \| style\ \| \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string ### Example [](https://starship.rs/config/#example-84) toml ``` # ~/.config/starship.toml [zig] symbol = '⚡️ ' ``` ## Custom commands [](https://starship.rs/config/#custom-commands) The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: - The current directory contains a file whose name is in `detect_files` - The current directory contains a directory whose name is in `detect_folders` - The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matches with `os` field if defined. TIP Multiple custom modules can be defined by using a `.`. TIP The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. TIP [Issue \#1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there\! WARNING If `unsafe_no_escape` is enabled or prior to starship v1.20 command output is printed unescaped to the prompt. Whatever output the command generates is printed unmodified in the prompt. This means if the output contains shell-specific interpretable sequences, they could be interpreted on display. Depending on the shell, this can mean that e.g. strings enclosed by backticks are executed by the shell. Such sequences are usually shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell. Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). ### Options [](https://starship.rs/config/#options-102) \| Option \| Default \| Description \| \|---\|---\|---\| \| `command` \| `''` \| The command whose output should be printed. The command will be passed on stdin to the shell. \| \| `when` \| `false` \| Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the `shell` returns a `0` status code from executing it. \| \| `require_repo` \| `false` \| If `true`, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options. \| \| `shell` \| \| [See below](https://starship.rs/config/#custom-command-shell) \| \| `description` \| `'<custom module>'` \| The description of the module that is shown when running `starship explain`. \| \| `unsafe_no_escape` \| `false` \| When set, command output is not escaped of characters that could be interpreted by the shell. \| \| `detect_files` \| `[]` \| The files that will be searched in the working directory for a match. \| \| `detect_folders` \| `[]` \| The directories that will be searched in the working directory for a match. \| \| `detect_extensions` \| `[]` \| The extensions that will be searched in the working directory for a match. \| \| `symbol` \| `''` \| The symbol used before displaying the command output. \| \| `style` \| `'bold green'` \| The style for the module. \| \| `format` \| `'[$symbol($output )]($style)'` \| The format for the module. \| \| `disabled` \| `false` \| Disables this `custom` module. \| \| `os` \| \| Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). \| \| `use_stdin` \| \| An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. \| \| `ignore_timeout` \| `false` \| Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. \| ### Variables [](https://starship.rs/config/#variables-95) \| Variable \| Description \| \|---\|---\| \| output \| The output of `command` run in `shell` \| \| symbol \| Mirrors the value of option `symbol` \| \| style\ \| Mirrors the value of option `style` \| \: This variable can only be used as a part of a style string #### Custom command shell [](https://starship.rs/config/#custom-command-shell) `shell` accepts a non-empty list of strings, where: - The first string is the path to the shell to use to execute the command. - Other following arguments are passed to the shell. If unset, it will fallback to STARSHIP\_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows. The `command` (and `when`, if applicable) will be passed in on stdin. If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. toml ``` shell = ['pwsh', '-Command', '-'] ``` WARNING Make sure your custom shell configuration exits gracefully If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option). For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop. Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation. Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. ### Example [](https://starship.rs/config/#example-85) toml ``` # ~/.config/starship.toml [custom.foo] command = 'echo foo' # shows output of command detect_files = ['foo'] # can specify filters but wildcards are not supported when = ''' test "$HOME" = "$PWD" ''' format = ' transcending [$output]($style)' [custom.time] command = 'time /T' detect_extensions = ['pst'] # filters .pst files shell = ['pwsh.exe', '-NoProfile', '-Command', '-'] [custom.time-as-arg] command = 'time /T' detect_extensions = ['pst'] # filters *.pst files shell = ['pwsh.exe', '-NoProfile', '-Command'] use_stdin = false ```
Shard	110 (laksa)
Root Hash	10819465806357049510
Unparsed URL	rs,starship!/config/ s443