mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2025-02-21 02:55:37 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

docs: add default column to properties table

Browse source
This commit is contained in:
ivan-the-terrible 2024-04-04 21:20:48 +00:00 committed by Jan De Dobbeleer
parent aaaa83f0a5
commit 2b5a62386b
76 changed files with 923 additions and 756 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

424
themes/schema.json
View file

@ -114,6 +114,39 @@
"description": "Override the status format for a specific change. Example: {\"Added\": \"Added: %d\"}",
"default": {}
},
"folders": {
"type": "array",
"title": "Folders",
"description": "The folders to look for when determining if a folder is a workspace",
"default": [],
"items": {
"type": "string"
}
},
"branch_max_length": {
"type": "integer",
"title": "Branch max length",
"description": "the max length for the displayed branch name where 0 implies full length",
"default": 0
},
"truncate_symbol": {
"type": "string",
"title": "Truncate Symbol",
"description": "Icon/text to use to indicate that the branch name has been truncated",
"default": ""
},
"native_fallback": {
"type": "boolean",
"title": "Native Fallback",
"description": "Use the native command when executable is not found",
"default": false
},
"full_branch_path": {
"type": "boolean",
"title": "Full branch path",
"description": "display the full branch path instead of only the branch name",
"default": true
},
"extra_prompt": {
"type": "object",
"default": {},
@ -514,13 +547,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is an NPM workspace",
"default": [
"package.json",
"package-lock.json"
],
"default": ["package.json", "package-lock.json"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -748,6 +781,9 @@
"fetch_version": {
"$ref": "#/definitions/fetch_version"
},
"missing_command_text": {
"$ref": "#/definitions/missing_command_text"
},
"display_mode": {
"$ref": "#/definitions/display_mode"
},
@ -761,14 +797,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Buf workspace",
"default": [
"buf.yaml",
"buf.gen.yaml",
"buf.work.yaml"
],
"default": ["buf.yaml", "buf.gen.yaml", "buf.work.yaml"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -922,14 +957,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a CMake workspace",
"default": [
"*.cmake",
"CMakeLists.txt"
],
"default": ["*.cmake", "CMakeLists.txt"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1001,6 +1035,9 @@
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1027,6 +1064,12 @@
"description": "Always show the status",
"default": false
},
"status_template": {
"type": "string",
"title": "Status Template",
"description": "The template to use for the status segment",
"default": "|"
},
"status_separator": {
"type": "string",
"title": "Status Separator",
@ -1115,10 +1158,7 @@
"properties": {
"properties": {
"native_fallback": {
"type": "boolean",
"title": "Native Fallback",
"description": "Use the native fossil command when the fossil executable is not found",
"default": false
"$ref": "#/definitions/native_fallback"
}
}
}
@ -1312,6 +1352,12 @@
},
"status_formats": {
"$ref": "#/definitions/status_formats"
},
"upstream_icons": {
"type": "object",
"title": "Status string formats",
"description": "a key, value map representing the remote URL (or a part of that URL) and icon to use in case the upstream URL contains the key. These get precedence over the standard icons",
"default": {}
}
}
}
@ -1360,13 +1406,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Go workspace",
"default": [
"*.go",
"go.mod"
],
"default": ["*.go", "go.mod"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1455,6 +1501,9 @@
"fetch_version": {
"$ref": "#/definitions/fetch_version"
},
"missing_command_text": {
"$ref": "#/definitions/missing_command_text"
},
"display_mode": {
"$ref": "#/definitions/display_mode"
},
@ -1468,14 +1517,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Deno workspace",
"default": [
"*.js",
"*.ts",
"deno.json"
],
"default": ["*.js", "*.ts", "deno.json"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1518,13 +1566,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Crystal workspace",
"default": [
"*.cr",
"shard.yml"
],
"default": ["*.cr", "shard.yml"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1567,12 +1615,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Julia workspace",
"default": [
"*.jl"
],
"default": ["*.jl"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1605,6 +1654,9 @@
"missing_command_text": {
"$ref": "#/definitions/missing_command_text"
},
"version_url_template": {
"$ref": "#/definitions/version_url_template"
},
"cache_version": {
"$ref": "#/definitions/cache_version"
},
@ -1612,15 +1664,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Perl workspace",
"default": [
".perl-version",
"*.pl",
"*.pm",
"*.t"
],
"default": [".perl-version", "*.pl", "*.pm", "*.t"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1672,6 +1722,9 @@
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1707,6 +1760,9 @@
"cache_version": {
"$ref": "#/definitions/cache_version"
},
"version_url_template": {
"$ref": "#/definitions/version_url_template"
},
"extensions": {
"type": "array",
"title": "Extensions",
@ -1726,6 +1782,9 @@
"*.clj",
"*.cljc"
]
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1761,15 +1820,17 @@
"cache_version": {
"$ref": "#/definitions/cache_version"
},
"version_url_template": {
"$ref": "#/definitions/version_url_template"
},
"extensions": {
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Ruby workspace",
"default": [
"*.rb",
"Rakefile",
"Gemfile"
]
"default": ["*.rb", "Rakefile", "Gemfile"]
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1805,15 +1866,17 @@
"cache_version": {
"$ref": "#/definitions/cache_version"
},
"version_url_template": {
"$ref": "#/definitions/version_url_template"
},
"extensions": {
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Rust workspace",
"default": [
"*.rs",
"Cargo.toml",
"Cargo.lock"
]
"default": ["*.rs", "Cargo.toml", "Cargo.lock"]
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1849,16 +1912,20 @@
"cache_version": {
"$ref": "#/definitions/cache_version"
},
"version_url_template": {
"$ref": "#/definitions/version_url_template"
},
"extensions": {
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a XMake workspace",
"default": [
"xmake.lua"
],
"default": ["xmake.lua"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -1969,13 +2036,13 @@
"type": "string",
"title": "Yarn Icon",
"description": "Icon/text to use for Yarn",
"default": " \udb80\udd1b"
"default": "\uF011B"
},
"npm_icon": {
"type": "string",
"title": "NPM Icon",
"description": "Icon/text to use for NPM",
"default": " \uE71E"
"default": "\uE71E"
},
"extensions": {
"type": "array",
@ -1993,6 +2060,9 @@
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -2231,11 +2301,17 @@
"description": "The symbol to use as a separator between folders",
"default": "/"
},
"folder_separator_template": {
"type": "string",
"title": "Folder Separator Template",
"description": "the path which is split will be separated by this template",
"pattern": ""
},
"home_icon": {
"type": "string",
"title": "Home Icon",
"description": "The icon to display when at $HOME",
"default": "/"
"default": "~"
},
"folder_icon": {
"type": "string",
@ -2247,7 +2323,7 @@
"type": "string",
"title": "Windows Registry Icon",
"description": "The icon to display when in the Windows registry",
"default": "\uE0B1"
"default": "\uF013"
},
"style": {
"type": "string",
@ -2266,7 +2342,7 @@
"unique",
"powerlevel"
],
"default": "folder"
"default": "agnoster"
},
"mapped_locations": {
"type": "object",
@ -2280,6 +2356,12 @@
"description": "Maximum path depth to display without shortening",
"default": 1
},
"max_width": {
"type": "integer",
"title": "Maximum Width",
"description": "Maximum path width to display for powerlevel style",
"default": 0
},
"mapped_locations_enabled": {
"type": "boolean",
"title": "Enable the Mapped Locations feature",
@ -2315,13 +2397,25 @@
"type": "string",
"title": "The folder format",
"description": "Golang string format to apply to the folder name",
"pattern": ".*%s.*"
"pattern": "%s"
},
"edge_format": {
"type": "string",
"title": "The format to use on the start and end folder",
"description": "Golang string format to apply to the start and end folder",
"pattern": ".*%s.*"
"pattern": "%s"
},
"left_format": {
"type": "string",
"title": "The format to use on first folder of the path",
"description": "Will default to whatever edge_format is set to",
"pattern": "%s"
},
"right_format": {
"type": "string",
"title": "The format to use on the last folder of the path",
"description": "Will default to whatever edge_format is set to",
"pattern": "%s"
},
"gitdir_format": {
"type": "string",
@ -2463,6 +2557,9 @@
"fetch_version": {
"$ref": "#/definitions/fetch_version"
},
"display_mode": {
"$ref": "#/definitions/display_mode"
},
"missing_command_text": {
"$ref": "#/definitions/missing_command_text"
},
@ -2477,6 +2574,15 @@
},
"cache_version": {
"$ref": "#/definitions/cache_version"
},
"extensions": {
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Quasar workspace",
"default": ["quasar.config", "quasar.config.js"]
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -2518,6 +2624,9 @@
},
"status_formats": {
"$ref": "#/definitions/status_formats"
},
"native_fallback": {
"$ref": "#/definitions/native_fallback"
}
}
}
@ -2729,19 +2838,19 @@
"type": "string",
"title": "Playing Icon",
"description": "Text/icon to show when playing",
"default": "\uE602"
"default": "\uE602 "
},
"paused_icon": {
"type": "string",
"title": "Paused Icon",
"description": "Text/icon to show when paused",
"default": "\uF8E3"
"default": "\uF8E3 "
},
"stopped_icon": {
"type": "string",
"title": "Stopped Icon",
"description": "Text/icon to show when stopped",
"default": "\uF04D"
"default": "\uF04D "
},
"api_url": {
"type": "string",
@ -2780,9 +2889,21 @@
"location": {
"type": "string",
"title": "location",
"description": "Location to use for the API call. Formatted as <City>,<STATE>,<COUNTRY_CODE>. City name, state code and country code divided by comma. Please, refer to ISO 3166 for the state codes or country codes.",
"description": "Location to use for the API call interpretted only if valid coordinates aren't given. Formatted as <City>,<STATE>,<COUNTRY_CODE>. City name, state code and country code divided by comma. Please, refer to ISO 3166 for the state codes or country codes.",
"default": "De Bilt,NL"
},
"latitude" : {
"type": "number",
"title": "Latitude",
"description": "The latitude of the requested location, valid between -90 and 90",
"default": 91
},
"longitude" : {
"type": "number",
"title": "Longitude",
"description": "The longitude of the requested location, valid between -180 and 180",
"default": 181
},
"units": {
"type": "string",
"title": "units",
@ -2841,13 +2962,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if a folder is a Elixir workspace",
"default": [
"*.ex",
"*.exs"
],
"default": ["*.ex", "*.exs"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -2949,25 +3070,25 @@
},
"ride_icon": {
"type": "string",
"title": "Alternative icon",
"title": "Ride icon",
"description": "Alternative icon for this activity type",
"default": "\uf206"
},
"run_icon": {
"type": "string",
"title": "Alternative icon",
"title": "Run icon",
"description": "Alternative icon for this activity type",
"default": "\ue213"
},
"skiing_icon": {
"type": "string",
"title": "Alternative icon",
"title": "Skiing icon",
"description": "Alternative icon for this activity type",
"default": "\ue213"
},
"workout_icon": {
"type": "string",
"title": "Alternative icon",
"title": "Workout icon",
"description": "Alternative icon for this activity type",
"default": "\ue213"
},
@ -3019,6 +3140,9 @@
},
"status_formats": {
"$ref": "#/definitions/status_formats"
},
"native_fallback": {
"$ref": "#/definitions/native_fallback"
}
}
}
@ -3045,6 +3169,9 @@
"fetch_version": {
"$ref": "#/definitions/fetch_version"
},
"missing_command_text": {
"$ref": "#/definitions/missing_command_text"
},
"display_mode": {
"$ref": "#/definitions/display_mode"
},
@ -3065,6 +3192,9 @@
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -3094,6 +3224,9 @@
"display_mode": {
"$ref": "#/definitions/display_mode"
},
"missing_command_text": {
"$ref": "#/definitions/missing_command_text"
},
"version_url_template": {
"$ref": "#/definitions/version_url_template"
},
@ -3104,13 +3237,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is a React project",
"default":
[
"package.json"
],
"default": ["package.json"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -3137,6 +3270,9 @@
"fetch_version": {
"$ref": "#/definitions/fetch_version"
},
"missing_command_text": {
"$ref": "#/definitions/missing_command_text"
},
"display_mode": {
"$ref": "#/definitions/display_mode"
},
@ -3150,14 +3286,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is an Nx project",
"default":
[
"workspace.json",
"nx.json"
],
"default": ["workspace.json", "nx.json"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -3193,12 +3328,14 @@
"cache_version": {
"$ref": "#/definitions/cache_version"
},
"version_url_template": {
"$ref": "#/definitions/version_url_template"
},
"extensions": {
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is an OCaml project",
"default":
[
"default": [
"*.ml",
"*.mli",
"dune",
@ -3208,6 +3345,9 @@
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -3352,22 +3492,16 @@
"default": "\uF412"
},
"truncate_symbol": {
"type": "string",
"title": "Truncate Symbol",
"description": "Icon/text to use to indicate that the branch name has been truncated",
"default": ""
"$ref": "#/definitions/truncate_symbol"
},
"branch_max_length": {
"type": "integer",
"title": "Branch max length",
"description": "the max length for the displayed branch name where 0 implies full length",
"default": 0
"$ref": "#/definitions/branch_max_length"
},
"full_branch_path": {
"type": "boolean",
"title": "Full branch path",
"description": "display the full branch path instead of only the branch name",
"default": false
"$ref": "#/definitions/full_branch_path"
},
"native_fallback": {
"$ref": "#/definitions/native_fallback"
}
}
}
@ -3571,11 +3705,7 @@
"type": "string",
"title": "Use Stack GHC",
"description": "Get the GHC version used by Stack. Will decrease performance. Boolean indicating whether stack ghc was used available in template as .StackGhc",
"enum": [
"always",
"package",
"never"
],
"enum": ["always", "package", "never"],
"default": "never"
},
"extensions": {
@ -3593,6 +3723,9 @@
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -3657,12 +3790,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is a UI5 project",
"default": [
"*ui5*.y*ml"
],
"default": ["*ui5*.y*ml"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -3742,16 +3876,20 @@
"cache_version": {
"$ref": "#/definitions/cache_version"
},
"version_url_template": {
"$ref": "#/definitions/version_url_template"
},
"extensions": {
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is a Vala project",
"default": [
"*.vala"
],
"default": ["*.vala"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -3794,14 +3932,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is a Cloud Foundry project",
"default":
[
"manifest.yml",
"mta.yaml"
],
"default": ["manifest.yml", "mta.yaml"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -3823,7 +3960,14 @@
"properties": {
"properties": {
"display_mode": {
"$ref": "#/definitions/display_mode"
"type": "string",
"title": "Display Mode",
"description": "Determines whether the segment is displayed always or only if a file matching the extensions are present in the current folder",
"enum": [
"always",
"files"
],
"default": "always"
}
}
}
@ -3866,15 +4010,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is a Kotlin project",
"default":
[
"*.kt",
"*.kts",
"*.ktm"
],
"default": ["*.kt", "*.kts", "*.ktm"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -3966,24 +4108,20 @@
"type": "string",
"title": "Preferred Executable",
"description": "The preferred executable to use when fetching the version.",
"enum": [
"lua",
"luajit"
],
"enum": ["lua", "luajit"],
"default": "lua"
},
"extensions": {
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is a Lua project",
"default":
[
"*.lua",
"*.rockspec"
],
"default": ["*.lua", "*.rockspec"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -4026,13 +4164,13 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is a Swift project",
"default": [
"*.swift",
"*.SWIFT"
],
"default": ["*.swift", "*.SWIFT"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -4068,20 +4206,20 @@
"cache_version": {
"$ref": "#/definitions/cache_version"
},
"version_url_template": {
"$ref": "#/definitions/version_url_template"
},
"extensions": {
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is a CDS project",
"default":
[
".cdsrc.json",
".cdsrc-private.json",
"*.cds"
],
"default": [".cdsrc.json", ".cdsrc-private.json", "*.cds"],
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -4124,8 +4262,7 @@
"type": "array",
"title": "Extensions",
"description": "The extensions to look for when determining if the current directory is an R project",
"default":
[
"default": [
"*.R",
"*.Rmd",
"*.Rsx",
@ -4137,6 +4274,9 @@
"items": {
"type": "string"
}
},
"folders": {
"$ref": "#/definitions/folders"
}
}
}
@ -4199,7 +4339,7 @@
"type": "boolean",
"title": "Display Status",
"description": "Display the local changes or not",
"default": true
"default": false
},
"status_formats": {
"$ref": "#/definitions/status_formats"
@ -4227,7 +4367,7 @@
"type": "string",
"title": "URL",
"description": "The URL to the Nightscout API",
"default": "https://your.nightscout.url/api/v1/entries.json"
"default": ""
},
"cache_timeout": {
"type": "integer",

19
website/docs/segments/angular.mdx
View file

@ -25,15 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the active version or not; useful if all you need is an icon indicating `ng` |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `angular.json` file is present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the angular version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `angular.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

6
website/docs/segments/aws.mdx
View file

@ -25,9 +25,9 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ----------------- | ------------------------------------------------------------------------------ | ------------------ |
| `display_default` | `boolean` - display the segment or not when the user profile matches `default` | defaults to `true` |
| Name | Type | Default | Description |
| ----------------- | :-------: | :-----: | -------------------------------------------- |
| `display_default` | `boolean` | `true` | display the segment when default user or not |
## Template ([info][templates])

6
website/docs/segments/az.mdx
View file

@ -29,9 +29,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `source` | `string` | <ul><li>`first_match`: try the CLI config first, then the PowerShell module. The first to resolve is displayed (**default**)</li><li>`cli`: fetch the information from the CLI config</li><li>`pwsh`: fetch the information from the PowerShell Module config</li></ul> |
| Name | Type | Default | Description |
| -------- | :------: | :-----------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `source` | `string` | `first_match` | <ul><li>`first_match`: try the CLI config first, then the PowerShell module. The first to resolve is displayed</li><li>`cli`: fetch the information from the CLI config</li><li>`pwsh`: fetch the information from the PowerShell Module config</li></ul> |
## Template ([info][templates])

22
website/docs/segments/azfunc.mdx
View file

@ -29,15 +29,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the Azure Functions CLI version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when a `host.json` or `local.settings.json` files is present (**default**)</li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the Azure Functions CLI version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `host.json, local.settings.json, function.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])
@ -59,5 +60,6 @@ import Config from "@site/src/components/Config.js";
| `.Patch` | `string` | patch number |
| `.Error` | `string` | error encountered when fetching the version string |
[templates]: /docs/configuration/templates
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: configuration/templates.mdx
[az-func-core-tools]: https://github.com/Azure/azure-functions-core-tools

14
website/docs/segments/battery.mdx
View file

@ -37,13 +37,13 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| ------------------- | --------- | --------------------------------------------------------------------------------------------- |
| `display_error` | `boolean` | show the error context when failing to retrieve the battery information - defaults to `false` |
| `charging_icon` | `string` | icon to display when charging - defaults to empty |
| `discharging_icon` | `string` | icon to display when discharging - defaults to empty |
| `charged_icon` | `string` | icon to display when fully charged - defaults to empty |
| `not_charging_icon` | `string` | icon to display when fully charged - defaults to empty |
| Name | Type | Default | Description |
| ------------------- | :-------: | :-----: | ----------------------------------------------------------------------- |
| `display_error` | `boolean` | `false` | show the error context when failing to retrieve the battery information |
| `charging_icon` | `string` | | icon to display when charging |
| `discharging_icon` | `string` | | icon to display when discharging |
| `charged_icon` | `string` | | icon to display when fully charged |
| `not_charging_icon` | `string` | | icon to display when fully charged |
## Template ([info][templates])

22
website/docs/segments/bazel.mdx
View file

@ -24,17 +24,17 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the Bazel version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.bazel`, `*.bzl`, `.bazelrc`, `.bazelversion`, `BUILD` or `WORKSPACE` files or any of Bazel's output folders are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info documentation |
| `icon` | `string` | the icon for the segment - defaults to `"\ue63a"` |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | display the Bazel version - defaults to |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info documentation |
| `icon` | `string` | `\ue63a` | the icon for the segment |
| `extensions` | `[]string` | `*.bazel, *.bzl, BUILD, WORKSPACE, .bazelrc, .bazelversion` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

16
website/docs/segments/brewfather.mdx
View file

@ -43,14 +43,14 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `user_id` | `string` | as provided by Brewfather's Generate API Key screen |
| `api_key` | `string` | as provided by Brewfather's Generate API Key screen |
| `batch_id` | `string` | Get this by navigating to the desired batch on the brewfather website, the batch id is at the end of the URL in the address bar |
| `http_timeout` | `int` | in milliseconds - How long to wait for the Brewfather service to answer the request. Default 2 seconds |
| `cache_timeout` | `int` | in minutes - How long to wait before updating the data from Brewfather. Default is 5 minutes |
| `day_icon` | `string` | icon or letter to use to indicate days. Default is "d" |
| Name | Type | Default | Description |
| --------------- | :------: | :-----: | ------------------------------------------------------------------------------------------------------------------------------- |
| `user_id` | `string` | | as provided by Brewfather's Generate API Key screen |
| `api_key` | `string` | | as provided by Brewfather's Generate API Key screen |
| `batch_id` | `string` | | Get this by navigating to the desired batch on the brewfather website, the batch id is at the end of the URL in the address bar |
| `http_timeout` | `int` | `2` | in milliseconds - How long to wait for the Brewfather service to answer the request |
| `cache_timeout` | `int` | `5` | in minutes - How long to wait before updating the data from Brewfather |
| `day_icon` | `string` | `d` | icon or letter to use to indicate days |
## Icons

19
website/docs/segments/buf.mdx
View file

@ -23,15 +23,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the active version or not; useful if all you need is an icon indicating `buf` |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `buf.yaml`, `buf.gen.yaml` or `buf.work.yaml` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `buf` |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `buf.yaml, buf.gen.yaml, buf.work.yaml` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

8
website/docs/segments/carbonintensity.mdx
View file

@ -45,10 +45,10 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| --------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `http_timeout` | `int` | Timeout (in milliseconds) for HTTP requests. The default is 20ms, but you may need to set this to as high as 5000ms to handle slow API requests. |
| `cache_timeout` | `int` | Timeout (in minutes) for the response cache. The default is 10m. A value of 0 disables the cache. |
| Name | Type | Default | Description |
| --------------- | :---: | :-----: | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `http_timeout` | `int` | `20` | Timeout (in milliseconds) for HTTP requests. The default is 20ms, but you may need to set this to as high as 5000ms to handle slow API requests. |
| `cache_timeout` | `int` | `10` | Timeout (in minutes) for the response cache. The default is 10m. A value of 0 disables the cache. |
## Template ([info][templates])

22
website/docs/segments/cds.mdx
View file

@ -25,15 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the CDS version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the cds command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is displayed when `.cdsrc.json`, `.cdsrc-private` or `*.cds` file is present</li><li>`context`: the segment is displayed when conditions from `files` mode are fulfilled or `package.json` file is present and `@sap/cds` is in `dependencies` section (**default**)</li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the CDS version |
| `missing_command_text` | `string` | `""` | text to display when the cds command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `.cdsrc.json, .cdsrc-private.json, *.cds` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])
@ -56,5 +57,6 @@ import Config from "@site/src/components/Config.js";
| `.Error` | `string` | error encountered when fetching the version string |
| `.HasDependency` | `bool` | a flag if `@sap/cds` was found in `package.json` |
[templates]: /docs/configuration/templates
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: configuration/templates.mdx
[sap-cap-cds]: https://cap.cloud.sap/docs/tools/#command-line-interface-cli

20
website/docs/segments/cf.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the Cloud Foundry CLI version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the java command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is displayed when `manifest.yml` or `mta.yaml` file is present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | display the Cloud Foundry CLI version |
| `missing_command_text` | `string` | | text to display when the java command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `manifest.yml, mta.yaml` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

6
website/docs/segments/cftarget.mdx
View file

@ -23,9 +23,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed (**default**)</li><li>`files`: the segment is only displayed when a `manifest.yml` file is present </li></ul> |
| Name | Type | Default | Description |
| -------------- | :------: | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `display_mode` | `string` | `always` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when a `manifest.yml` file is present </li></ul> |
## Template ([info][templates])

20
website/docs/segments/cmake.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the cmake version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.cmake` or `CMakeLists.txt` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | display the cmake version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.cmake, CMakeLists.txt` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

10
website/docs/segments/command.mdx
View file

@ -42,11 +42,11 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| --------- | -------- | --------------------------------------------------------------------------------- |
| `shell` | `string` | the shell in which to run the command in. Uses `shell -c command` under the hood. |
| `command` | `string` | the command(s) to run |
| `script` | `string` | the path to a script to run |
| Name | Type | Default | Description |
| --------- | :------: | :-----: | --------------------------------------------------------------------------------- |
| `shell` | `string` | `bash` | the shell in which to run the command in. Uses `shell -c command` under the hood. |
| `command` | `string` | | the command(s) to run |
| `script` | `string` | | the path to a script to run |
## Template ([info][templates])

6
website/docs/segments/connection.mdx
View file

@ -26,9 +26,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | `string` | the type of connection to display. Can be a single value or multiple joined by <inlineCode>\|</inlineCode> . The first to resolve is shown (**default value** is <inlineCode>wifi\|ethernet</inlineCode>). Possible values:<ul><li>`wifi`</li><li>`ethernet`</li><li>`bluetooth`</li><li>`cellular`</li></ul> |
| Name | Type | Default | Description |
| ------ | :------: | :--------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | `string` | `wifi\|ethernet` | the type of connection to display. Can be a single value or multiple joined by a pipe <inlineCode>\|</inlineCode> . The first to resolve is shown. Possible values:<ul><li>`wifi`</li><li>`ethernet`</li><li>`bluetooth`</li><li>`cellular`</li></ul> |
## Template ([info][templates])

20
website/docs/segments/crystal.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the julia version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.cr` or `shard.yml` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the crystal version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.cr, shard.yml` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

20
website/docs/segments/dart.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the dart version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.dart`, `pubspec.yaml`, `pubspec.yml`, `pubspec.lock` files or the `.dart_tool` folder are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the dart version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.dart, pubspec.yaml, pubspec.yml, pubspec.lock` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | `.dart_tool` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

19
website/docs/segments/deno.mdx
View file

@ -23,15 +23,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the active version or not; useful if all you need is an icon indicating `deno` |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.ts*`, `*.js` or `deno.json` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `deno` |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.ts, *.js, deno.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

17
website/docs/segments/dotnet.mdx
View file

@ -23,13 +23,16 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| ---------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the active version or not; useful if all you need is an icon indicating `dotnet` is present - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.cs`, `*.vb`, `*.fs`, `*.fsx`, `*.sln`, `*.slnf`, `*.csproj`, `*.vbproj`, or `*.fsproj` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not; useful if all you need is an icon indicating `dotnet` |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.cs, *.csx, *.vb, *.fs, *.fsx, *.sln, *.slnf, *.csproj, *.fsproj, *.vbproj, global.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

20
website/docs/segments/elixir.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the elixir version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.ex` or `*.exs` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the elixir version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.ex, *.exs` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

10
website/docs/segments/executiontime.mdx
View file

@ -28,11 +28,11 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| ---------------- | --------- | ----------------------------------------------------------------------------------- |
| `always_enabled` | `boolean` | always show the duration - defaults to `false` |
| `threshold` | `number` | minimum duration (milliseconds) required to enable this segment - defaults to `500` |
| `style` | `enum` | one of the available format options - defaults to `austin` |
| Name | Type | Default | Description |
| ---------------- | :-------: | :------: | ------------------------------------------------------------------------- |
| `always_enabled` | `boolean` | `false` | always show the duration |
| `threshold` | `number` | `500` | minimum duration (milliseconds) required to enable this segment |
| `style` | `enum` | `austin` | one of the available format options |
### Style

20
website/docs/segments/flutter.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the flutter version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.dart`, `pubspec.yaml`, `pubspec.yml`, `pubspec.lock` files or the `.dart_tool` folder are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the flutter version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.dart, pubspec.yaml, pubspec.yml, pubspec.lock` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | `.dart_tool` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

6
website/docs/segments/fossil.mdx
View file

@ -22,9 +22,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| ----------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `native_fallback` | `boolean` | when set to `true` and `fossil.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native fossil executable to fetch data. Not all information can be displayed in this case. Defaults to `false` |
| Name | Type | Default | Description |
| ----------------- | :-------: | :-----: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `native_fallback` | `boolean` | `false` | when set to `true` and `fossil.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native fossil executable to fetch data. Not all information can be displayed in this case |
## Template ([info][templates])

76
website/docs/segments/git.mdx
View file

@ -69,55 +69,55 @@ import Config from "@site/src/components/Config.js";
As doing multiple git calls can slow down the prompt experience, we do not fetch information by default.
You can set the following properties to `true` to enable fetching additional information (and populate the template).
| Name | Type | Description |
| --------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch_status` | `boolean` | fetch the local changes - defaults to `false` |
| `ignore_status` | `[]string` | do not fetch status for these repo's. Uses the repo's root folder and same logic as the [exclude_folders][exclude_folders] property |
| `fetch_upstream_icon` | `boolean` | fetch upstream icon - defaults to `false` |
| `fetch_bare_info` | `boolean` | fetch bare repo info - defaults to `false` |
| `untracked_modes` | `map[string]string` | map of repo's where to override the default [untracked files mode][untracked]:<ul><li>`no`</li><li>`normal`</li><li>`all`</li></ul>For example `"untracked_modes": { "/Users/me/repos/repo1": "no" }` - defaults to `normal` for all repo's. If you want to override for all repo's, use `*` to set the mode instead of the repo path |
| `ignore_submodules` | `map[string]string` | map of repo's where to change the [--ignore-submodules][submodules] flag (`none`, `untracked`, `dirty` or `all`). For example `"ignore_submodules": { "/Users/me/repos/repo1": "all" }`. If you want to override for all repo's, use `*` to set the mode instead of the repo path |
| `native_fallback` | `boolean` | when set to `true` and `git.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native git executable to fetch data. Not all information can be displayed in this case. Defaults to `false` |
| `fetch_user` | [`User`](#user) | fetch the current configured user for the repository - defaults to `false` |
| `status_formats` | `map[string]string` | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides. Defaults to an empty map. |
| Name | Type | Default | Description |
| --------------------- | :-----------------: | :-----: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch_status` | `boolean` | `false` | fetch the local changes |
| `ignore_status` | `[]string` | | do not fetch status for these repo's. Uses the repo's root folder and same logic as the [exclude_folders][exclude_folders] property |
| `fetch_upstream_icon` | `boolean` | `false` | fetch upstream icon |
| `fetch_bare_info` | `boolean` | `false` | fetch bare repo info |
| `untracked_modes` | `map[string]string` | | map of repo's where to override the default [untracked files mode][untracked]:<ul><li>`no`</li><li>`normal`</li><li>`all`</li></ul>For example `"untracked_modes": { "/Users/me/repos/repo1": "no" }` - defaults to `normal` for all repo's. If you want to override for all repo's, use `*` to set the mode instead of the repo path |
| `ignore_submodules` | `map[string]string` | | map of repo's where to change the [--ignore-submodules][submodules] flag (`none`, `untracked`, `dirty` or `all`). For example `"ignore_submodules": { "/Users/me/repos/repo1": "all" }`. If you want to override for all repo's, use `*` to set the mode instead of the repo path |
| `native_fallback` | `boolean` | `false` | when set to `true` and `git.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native git executable to fetch data. Not all information can be displayed in this case |
| `fetch_user` | [`User`](#user) | `false` | fetch the current configured user for the repository |
| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides. |
### Icons
#### Branch
| Name | Type | Description |
| ----------------------- | -------- | -------------------------------------------------------------------------------------------- |
| `branch_icon` | `string` | the icon to use in front of the git branch name - defaults to `\uE0A0 ` |
| `branch_identical_icon` | `string` | the icon to display when remote and local are identical - defaults to `\u2261` |
| `branch_ahead_icon` | `string` | the icon to display when the local branch is ahead of its remote - defaults to `\u2191` |
| `branch_behind_icon` | `string` | the icon to display when the local branch is behind its remote - defaults to `\u2193` |
| `branch_gone_icon` | `string` | the icon to display when there's no remote branch - defaults to `\u2262` |
| `branch_max_length` | `int` | the max length for the displayed branch name where `0` implies full length - defaults to `0` |
| `truncate_symbol` | `string` | the icon to display when a branch name is truncated - defaults to empty |
| Name | Type | Default | Description |
| ----------------------- | :------: | :------: | -------------------------------------------------------------------------- |
| `branch_icon` | `string` | `\uE0A0` | the icon to use in front of the git branch name |
| `branch_identical_icon` | `string` | `\u2261` | the icon to display when remote and local are identical |
| `branch_ahead_icon` | `string` | `\u2191` | the icon to display when the local branch is ahead of its remote |
| `branch_behind_icon` | `string` | `\u2193` | the icon to display when the local branch is behind its remote |
| `branch_gone_icon` | `string` | `\u2262` | the icon to display when there's no remote branch |
| `branch_max_length` | `int` | `0` | the max length for the displayed branch name where `0` implies full length |
| `truncate_symbol` | `string` | | the icon to display when a branch name is truncated |
#### HEAD
| Name | Type | Description |
| ------------------ | -------- | ---------------------------------------------------------------------------------------- |
| `commit_icon` | `string` | icon/text to display before the commit context (detached HEAD) - defaults to `\uF417` |
| `tag_icon` | `string` | icon/text to display before the tag context - defaults to `\uF412` |
| `rebase_icon` | `string` | icon/text to display before the context when in a rebase - defaults to `\uE728 ` |
| `cherry_pick_icon` | `string` | icon/text to display before the context when doing a cherry-pick - defaults to `\uE29B ` |
| `revert_icon` | `string` | icon/text to display before the context when doing a revert - defaults to `\uF0E2 ` |
| `merge_icon` | `string` | icon/text to display before the merge context - defaults to `\uE727 ` |
| `no_commits_icon` | `string` | icon/text to display when there are no commits in the repo - defaults to `\uF594 ` |
| Name | Type | Default | Description |
| ------------------ | :------: | :------: | ---------------------------------------------------------------- |
| `commit_icon` | `string` | `\uF417` | icon/text to display before the commit context (detached HEAD) |
| `tag_icon` | `string` | `\uF412` | icon/text to display before the tag context |
| `rebase_icon` | `string` | `\uE728` | icon/text to display before the context when in a rebase |
| `cherry_pick_icon` | `string` | `\uE29B` | icon/text to display before the context when doing a cherry-pick |
| `revert_icon` | `string` | `\uF0E2` | icon/text to display before the context when doing a revert |
| `merge_icon` | `string` | `\uE727` | icon/text to display before the merge context |
| `no_commits_icon` | `string` | `\uF594` | icon/text to display when there are no commits in the repo |
#### Upstream
| Name | Type | Description |
| ------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `github_icon` | `string` | icon/text to display when the upstream is Github - defaults to `\uF408 ` |
| `gitlab_icon` | `string` | icon/text to display when the upstream is Gitlab - defaults to `\uF296 ` |
| `bitbucket_icon` | `string` | icon/text to display when the upstream is Bitbucket - defaults to `\uF171 ` |
| `azure_devops_icon` | `string` | icon/text to display when the upstream is Azure DevOps - defaults to `\uEBE8 ` |
| `codecommit_icon` | `string` | icon/text to display when the upstream is AWS CodeCommit - defaults to `\uF270 ` |
| `git_icon` | `string` | icon/text to display when the upstream is not known/mapped - defaults to `\uE5FB ` |
| `upstream_icons` | `map[string]string` | a key, value map representing the remote URL (or a part of that URL) and icon to use in case the upstream URL contains the key. These get precedence over the standard icons |
| Name | Type | Default | Description |
| ------------------- | :-----------------: | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `github_icon` | `string` | `\uF408` | icon/text to display when the upstream is Github |
| `gitlab_icon` | `string` | `\uF296` | icon/text to display when the upstream is Gitlab |
| `bitbucket_icon` | `string` | `\uF171` | icon/text to display when the upstream is Bitbucket |
| `azure_devops_icon` | `string` | `\uEBE8` | icon/text to display when the upstream is Azure DevOps |
| `codecommit_icon` | `string` | `\uF270` | icon/text to display when the upstream is AWS CodeCommit |
| `git_icon` | `string` | `\uE5FB` | icon/text to display when the upstream is not known/mapped |
| `upstream_icons` | `map[string]string` | | a key, value map representing the remote URL (or a part of that URL) and icon to use in case the upstream URL contains the key. These get precedence over the standard icons |
## Template ([info][templates])

6
website/docs/segments/gitversion.mdx
View file

@ -29,9 +29,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| --------------- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `cache_timeout` | `int` | in minutes - How long to wait before fetching new information using the gitversion CLI. Default is 30 minutes, a value of 0 disables the cache. |
| Name | Type | Default | Description |
| --------------- | :---: | :------: | ------------------------------------------------------------------------------------------------------------------------ |
| `cache_timeout` | `int` | `30` | in minutes - How long to wait before fetching new information using the gitversion CLI. A value of 0 disables the cache. |
## Template ([info][templates])

22
website/docs/segments/golang.mdx
View file

@ -25,17 +25,17 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the golang version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.go` or `go.mod` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `parse_mod_file` | `boolean` | parse the go.mod file instead of calling `go version` |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the golang version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `parse_mod_file` | `boolean` | `false` | parse the go.mod file instead of calling `go version` |
| `extensions` | `[]string` | `*.go, go.mod` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

22
website/docs/segments/haskell.mdx
View file

@ -25,17 +25,17 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the GHC version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.hs`, `*.lhs`, `stack.yaml`, `package.yaml`, `*.cabal`, or `cabal.project` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `stack_ghc_mode` | `string` | determines when to use `stack ghc` to retrieve the version information. Using `stack ghc` will decrease performance.<ul><li>`never`: never use `stack ghc` (**default**)</li><li>`package`: only use `stack ghc` when `stack.yaml` is in the root of the </li><li>`always`: always use `stack ghc`</li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the GHC version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `stack_ghc_mode` | `string` | `never` | determines when to use `stack ghc` to retrieve the version information. Using `stack ghc` will decrease performance.<ul><li>`never`: never use `stack ghc`</li><li>`package`: only use `stack ghc` when `stack.yaml` is in the root of the </li><li>`always`: always use `stack ghc`</li></ul> |
| `extensions` | `[]string` | `*.hs, *.lhs, stack.yaml, package.yaml, *.cabal, cabal.project` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

6
website/docs/segments/helm.mdx
View file

@ -23,9 +23,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| -------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed (**default**)</li><li>`files`: the segment is only displayed when a `Chart.yaml` (or `Chart.yml`) file is present </li></ul> |
| Name | Type | Default | Description |
| -------------- | :------: | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `display_mode` | `string` | `always` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when a `Chart.yaml` (or `Chart.yml`) file is present </li></ul> |
## Template ([info][templates])

10
website/docs/segments/ipify.mdx
View file

@ -28,11 +28,11 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| --------------- | -------- | -------------------------------------------------------------------------------------------------------------------- |
| `url` | `string` | The Ipify URL, by default IPv4 is used, use `https://api64.ipify.org` for IPv6 - defaults to `https://api.ipify.org` |
| `http_timeout` | `int` | How long may the segment wait for a response of the ipify API? - defaults to 20ms |
| `cache_timeout` | `int` | in minutes - How long you want your IP address cached - defaults to 10 min |
| Name | Type | Default | Description |
| --------------- | :------: | :---------------------: | ------------------------------------------------------------------------------- |
| `url` | `string` | `https://api.ipify.org` | The Ipify URL, by default IPv4 is used, use `https://api64.ipify.org` for IPv6 |
| `http_timeout` | `int` | `20` | in milliseconds - how long may the segment wait for a response of the ipify API |
| `cache_timeout` | `int` | `10` | in minutes - How long you want your IP address cached |
## Template ([info][templates])

22
website/docs/segments/java.mdx
View file

@ -25,15 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the java version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the java command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when one of the following files is present<ul><li>`pom.xml`</li><li>`build.gradle.kts`</li><li>`build.sbt`</li><li>`.java-version`</li><li>`.deps.edn`</li><li>`project.clj`</li><li>`build.boot`</li><li>`*.java`</li><li>`*.class`</li><li>`*.gradle`</li><li>`*.jar`</li><li>`*.clj`</li><li>`*.cljc`</li></ul></li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------------------------------------------------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the java version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.java, *.class, *.gradle, *.jar, *.clj, *.cljr, pom.xml, build.gradle.kts, build.sbt, .java-version, .deps.edn, project.clj, build.boot` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])
@ -55,4 +56,5 @@ import Config from "@site/src/components/Config.js";
| `.Patch` | `string` | patch number |
| `.Error` | `string` | error encountered when fetching the version string |
[templates]: /docs/configuration/templates
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: configuration/templates.mdx

20
website/docs/segments/julia.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the julia version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.jl` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the julia version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.jl` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

22
website/docs/segments/kotlin.mdx
View file

@ -25,16 +25,18 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the kotlin version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.kt`, `*.kts` or `*.ktm` files are present (**default**) </li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
## Properties
| Name | Type | Default | Description |
| ---------------------- | :--------: | :------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the kotlin version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.kt, *.kts, *.ktm` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

10
website/docs/segments/kubectl.mdx
View file

@ -30,11 +30,11 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ------------------ | --------- | ----------------------------------------------------------------------------------------------------- |
| `display_error` | `boolean` | show the error context when failing to retrieve the kubectl information - defaults to `false` |
| `parse_kubeconfig` | `boolean` | parse kubeconfig files instead of calling out to kubectl to improve performance - defaults to `false` |
| `context_aliases` | `object` | custom context names |
| Name | Type | Default | Description |
| ------------------ | :-------: | :-----: | ------------------------------------------------------------------------------- |
| `display_error` | `boolean` | `false` | show the error context when failing to retrieve the kubectl information |
| `parse_kubeconfig` | `boolean` | `false` | parse kubeconfig files instead of calling out to kubectl to improve performance |
| `context_aliases` | `object` | | custom context namespace |
## Template ([info][templates])

14
website/docs/segments/lastfm.mdx
View file

@ -40,12 +40,12 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| -------------- | -------- | ------------------------------------------------------ |
| `playing_icon` | `string` | text/icon to show when playing - defaults to `\uE602 ` |
| `stopped_icon` | `string` | text/icon to show when stopped - defaults to `\uF04D ` |
| `api_key` | `string` | your LastFM [API key][api-key] |
| `username` | `string` | your LastFM username |
| Name | Type | Default | Description |
| -------------- | :------: | :-------: | ------------------------------ |
| `playing_icon` | `string` | `\uE602 ` | text/icon to show when playing |
| `stopped_icon` | `string` | `\uF04D ` | text/icon to show when stopped |
| `api_key` | `string` | | your LastFM [API key][api-key] |
| `username` | `string` | | your LastFM username |
## Template ([info][templates])
@ -67,6 +67,6 @@ import Config from "@site/src/components/Config.js";
| `.Full` | `string` | will output `Artist - Track` |
| `.Icon` | `string` | icon (based on `.Status`) |
[templates]: /docs/configuration/templates
[templates]: configuration/templates.mdx
[lastfm]: https://www.last.fm
[api-key]: https://www.last.fm/api/account/create

22
website/docs/segments/lua.mdx
View file

@ -25,17 +25,17 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the lua version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.lua`, `*.rockspec` files or the `lua` folder are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `preferred_executable` | `string` | the preferred executable to use when fetching the version<ul><li>`lua`: the Lua executable (**default**)</li><li>`luajit`: the LuaJIT executable</li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the lua version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `preferred_executable` | `string` | `lua` | the preferred executable to use when fetching the version<ul><li>`lua`: the Lua executable (**default**)</li><li>`luajit`: the LuaJIT executable</li></ul> |
| `extensions` | `[]string` | `*.lua, *.rockspec` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

8
website/docs/segments/mercurial.mdx
View file

@ -33,10 +33,10 @@ import Config from "@site/src/components/Config.js";
As doing Mercurial (hg) calls can slow down the prompt experience, we do not fetch information by default.
You can set the following properties to `true` to enable fetching additional information (and populate the template).
| Name | Type | Description |
| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch_status` | `boolean` | fetch the local changes - defaults to `false` |
| `status_formats` | `map[string]string` | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides. Defaults to an empty map. |
| Name | Type | Default | Description |
| ---------------- | :-----------------: | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch_status` | `boolean` | `false` | fetch the local changes |
| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides |
## Template ([info][templates])

10
website/docs/segments/nightscout.mdx
View file

@ -57,11 +57,11 @@ Or display in mmol/l (instead of the default mg/dl) with the following template:
## Properties
| Name | Type | Description |
| --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | `string` | Your Nightscout URL, including the full path to entries.json AND count=1 AND token. Example above. You'll know this works if you can curl it yourself and get a single value. - defaults to `` |
| `http_timeout` | `int` | How long do you want to wait before you want to see your prompt more than your sugar? I figure a half second is a good default - defaults to 500ms |
| `cache_timeout` | `int` | in minutes - How long do you want your numbers cached? - defaults to 5 min |
| Name | Type | Default | Description |
| --------------- | :------: | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | `string` | | Your Nightscout URL, including the full path to entries.json AND count=1 AND token. Example above. You'll know this works if you can curl it yourself and get a single value |
| `http_timeout` | `int` | `500` | in milliseconds - how long do you want to wait before you want to see your prompt more than your sugar? I figure a half second is a good default |
| `cache_timeout` | `int` | `5` | in minutes - how long do you want your numbers cached? |
:::info
You can change the icons for trend, put the trend elsewhere, add text, however you like!

26
website/docs/segments/node.mdx
View file

@ -25,19 +25,19 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ----------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the Node.js version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: The segment is always displayed</li><li>`files`: The segment is only displayed when one of the following files is present (**default**):<ul><li>`*.js`</li><li>`*.ts`</li><li>`package.json`</li><li>`.nvmrc`</li><li>`pnpm-workspace.yaml`</li><li>`.pnpmfile.cjs`</li><li>`.vue`</li></ul></li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `fetch_package_manager` | `boolean` | define if the current project uses Yarn or NPM - defaults to `false` |
| `yarn_icon` | `string` | the icon/text to display when using Yarn - defaults to ` \uF011B` |
| `npm_icon` | `string` | the icon/text to display when using NPM - defaults to ` \uE71E` |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ----------------------- | :--------: | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the Node.js version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `fetch_package_manager` | `boolean` | `false` | define if the current project uses Yarn or NPM |
| `yarn_icon` | `string` | `\uF011B` | the icon/text to display when using Yarn |
| `npm_icon` | `string` | `\uE71E` | the icon/text to display when using NPM |
| `extensions` | `[]string` | `*.js, *.ts, package.json, .nvmrc, pnpm-workspace.yaml, .pnpmfile.cjs, .vue` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

20
website/docs/segments/npm.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `fetch_version` | `boolean` | fetch the NPM version - defaults to `true` |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `package.json` or `package-lock.json` file are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the NPM version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `package.json, package-lock.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

19
website/docs/segments/nx.mdx
View file

@ -25,15 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the active version or not; useful if all you need is an icon indicating `ng` |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when a `workspace.json` or `nx.json` file is present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the active version or not |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `workspace.json, nx.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

20
website/docs/segments/ocaml.mdx
View file

@ -24,15 +24,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the ocaml version (`ocaml -version`) - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.rs`, `Cargo.toml` or `Cargo.lock` files are present (**default**)</li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | display the ocaml version (`ocaml -version`) |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.ml, *.mli, dune, dune-project, dune-workspace` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])
@ -55,4 +56,5 @@ import Config from "@site/src/components/Config.js";
| `.Prerelease` | `string` | channel name |
| `.Error` | `string` | error encountered when fetching the version string |
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates

56
website/docs/segments/os.mdx
View file

@ -25,34 +25,34 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| --------------------- | --------- | ------------------------------------------------------------------------- |
| `macos` | `string` | the string to use for macOS - defaults to `\uF179` |
| `linux` | `string` | the icon to use for Linux - defaults to `\uF17C` |
| `windows` | `string` | the icon to use for Windows - defaults to `\uE62A` |
| `display_distro_name` | `boolean` | display the distro name or icon (for WSL and Linux) - defaults to `false` |
| `alma` | `string` | the icon to use for Alma - defaults to `\uF31D` |
| `alpine` | `string` | the icon to use for Alpine - defaults to `\uF300` |
| `aosc` | `string` | the icon to use for Aosc - defaults to `\uF301` |
| `arch` | `string` | the icon to use for Arch - defaults to `\uF303` |
| `centos` | `string` | the icon to use for Centos - defaults to `\uF304` |
| `coreos` | `string` | the icon to use for Coreos - defaults to `\uF305` |
| `debian` | `string` | the icon to use for Debian - defaults to `\uF306` |
| `devuan` | `string` | the icon to use for Devuan - defaults to `\uF307` |
| `raspbian` | `string` | the icon to use for Raspbian - defaults to `\uF315` |
| `elementary` | `string` | the icon to use for Elementary - defaults to `\uF309` |
| `fedora` | `string` | the icon to use for Fedora - defaults to `\uF30a` |
| `gentoo` | `string` | the icon to use for Gentoo - defaults to `\uF30d` |
| `mageia` | `string` | the icon to use for Mageia - defaults to `\uF310` |
| `manjaro` | `string` | the icon to use for Manjaro - defaults to `\uF312` |
| `mint` | `string` | the icon to use for Mint - defaults to `\uF30e` |
| `nixos` | `string` | the icon to use for Nixos - defaults to `\uF313` |
| `opensuse` | `string` | the icon to use for Opensuse - defaults to `\uF314` |
| `redhat` | `string` | the icon to use for Redhat - defaults to `\uF316` |
| `rocky` | `string` | the icon to use for Rocky - defaults to `\uF32B` |
| `sabayon` | `string` | the icon to use for Sabayon - defaults to `\uF317` |
| `slackware` | `string` | the icon to use for Slackware - defaults to `\uF319` |
| `ubuntu` | `string` | the icon to use for Ubuntu - defaults to `\uF31b` |
| Name | Type | Default | Description |
| --------------------- | :-------: | :------: | --------------------------------------------------- |
| `macos` | `string` | `\uF179` | the string to use for macOS |
| `linux` | `string` | `\uF17C` | the icon to use for Linux |
| `windows` | `string` | `\uE62A` | the icon to use for Windows |
| `display_distro_name` | `boolean` | `false` | display the distro name or icon (for WSL and Linux) |
| `alma` | `string` | `\uF31D` | the icon to use for Alma |
| `alpine` | `string` | `\uF300` | the icon to use for Alpine |
| `aosc` | `string` | `\uF301` | the icon to use for Aosc |
| `arch` | `string` | `\uF303` | the icon to use for Arch |
| `centos` | `string` | `\uF304` | the icon to use for Centos |
| `coreos` | `string` | `\uF305` | the icon to use for Coreos |
| `debian` | `string` | `\uF306` | the icon to use for Debian |
| `devuan` | `string` | `\uF307` | the icon to use for Devuan |
| `raspbian` | `string` | `\uF315` | the icon to use for Raspbian |
| `elementary` | `string` | `\uF309` | the icon to use for Elementary |
| `fedora` | `string` | `\uF30a` | the icon to use for Fedora |
| `gentoo` | `string` | `\uF30d` | the icon to use for Gentoo |
| `mageia` | `string` | `\uF310` | the icon to use for Mageia |
| `manjaro` | `string` | `\uF312` | the icon to use for Manjaro |
| `mint` | `string` | `\uF30e` | the icon to use for Mint |
| `nixos` | `string` | `\uF313` | the icon to use for Nixos |
| `opensuse` | `string` | `\uF314` | the icon to use for Opensuse |
| `redhat` | `string` | `\uF316` | the icon to use for Redhat |
| `rocky` | `string` | `\uF32B` | the icon to use for Rocky |
| `sabayon` | `string` | `\uF317` | the icon to use for Sabayon |
| `slackware` | `string` | `\uF319` | the icon to use for Slackware |
| `ubuntu` | `string` | `\uF31b` | the icon to use for Ubuntu |
## Template ([info][templates])

19
website/docs/segments/owm.mdx
View file

@ -37,16 +37,15 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| --------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `api_key` | `string` | Your API key from [Open Weather Map][owm]. Can also be set using the `POSH_OWM_API_KEY` environment variable. |
| `latitude` | `float64` | The latitude of the requested location. |
| `longitude` | `float64` | The longitude of the requested location. |
| `location` | `string` | The requested location. Formatted as \<City,STATE,COUNTRY_CODE\>. City name, state code and country code divided by comma. Please, refer to ISO 3166 for the state codes or country codes - defaults to `DE BILT,NL` |
| `units` | `string` | Units of measurement. Available values are standard (kelvin), metric (celsius), and imperial (fahrenheit) - defaults to `standard` |
| `http_timeout` | `int` | The default timeout for http request is 20ms. |
| `cache_timeout` | `int` | The default timeout for request caching is 10m. A value of 0 disables the cache. |
| `template` | `string` | A go [text/template][go-text-template] template extended with [sprig][sprig] utilizing the properties below - defaults to `{{.Weather}} ({{.Temperature}}{{.UnitIcon}})` |
| Name | Type | Default | Description |
| --------------- | :-------: | :----------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `api_key` | `string` | `.` | Your API key from [Open Weather Map][owm]. Can also be set using the `POSH_OWM_API_KEY` environment variable. |
| `latitude` | `float64` | `91` | The latitude of the requested location, valid between -90 and 90 |
| `longitude` | `float64` | `181` | The longitude of the requested location, valid between -180 and 180 |
| `location` | `string` | `De Bilt,NL` | The requested location interpretted only if valid coordinates aren't given. Formatted as \<City,STATE,COUNTRY_CODE\>. City name, state code and country code divided by comma. Please, refer to ISO 3166 for the state codes or country codes |
| `units` | `string` | `standard` | Units of measurement. Available values are standard (kelvin), metric (celsius), and imperial (fahrenheit) |
| `http_timeout` | `int` | `20` | in milliseconds, the timeout for http request |
| `cache_timeout` | `int` | `10` | in minutes, the timeout for request caching. A value of 0 disables the cache. |
### Specifying Location

46
website/docs/segments/path.mdx
View file

@ -30,25 +30,25 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| --------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `folder_separator_icon` | `string` | the symbol to use as a separator between folders - defaults to platform path separator |
| `folder_separator_template` | `string` | the [template][templates] to use as a separator between folders - defaults to `` |
| `home_icon` | `string` | the icon to display when at `$HOME` - defaults to `~` |
| `folder_icon` | `string` | the icon to use as a folder indication - defaults to `..` |
| `windows_registry_icon` | `string` | the icon to display when in the Windows registry - defaults to `\uE0B1` |
| `style` | `enum` | how to display the current path |
| `mixed_threshold` | `number` | the maximum length of a path segment that will be displayed when using `Mixed` - defaults to `4` |
| `max_depth` | `number` | maximum path depth to display before shortening when using `agnoster_short`, defaults to `1` |
| `max_width` | `number` | maximum path length to display when using `powerlevel` - defaults to `0` |
| `hide_root_location` | `boolean` | hides the root location if it doesn't fit in the last `max_depth` folders, when using `agnoster_short` - defaults to `false` |
| `cycle` | `[]string` | a list of color overrides to cycle through to colorize the individual path folders, e.g. `[ "#ffffff,#111111" ]` |
| `cycle_folder_separator` | `boolean` | colorize the `folder_separator_icon` as well when using a cycle - defaults to `false` |
| `folder_format` | `string` | format to use on individual path folders - defaults to `%s` |
| `edge_format` | `string` | format to use on the first and last folder of the path - defaults to `%s` |
| `left_format` | `string` | format to use on the firstfolder of the path - defaults to `edge_format` |
| `right_format` | `string` | format to use on the last folder of the path - defaults to `edge_format` |
| `gitdir_format` | `string` | format to use for a git root directory - defaults to `` |
| Name | Type | Default | Description |
| --------------------------- | :--------: | :--------: | ---------------------------------------------------------------------------------------------------------------- |
| `folder_separator_icon` | `string` | `/` | the symbol to use as a separator between folders |
| `folder_separator_template` | `string` | | the [template][templates] to use as a separator between folders |
| `home_icon` | `string` | `~` | the icon to display when at `$HOME` |
| `folder_icon` | `string` | `..` | the icon to use as a folder indication |
| `windows_registry_icon` | `string` | `\uF013` | the icon to display when in the Windows registry |
| `style` | `enum` | `agnoster` | how to display the current path |
| `mixed_threshold` | `number` | `4` | the maximum length of a path segment that will be displayed when using `Mixed` |
| `max_depth` | `number` | `1` | maximum path depth to display before shortening when using `agnoster_short` |
| `max_width` | `number` | `0` | maximum path length to display when using `powerlevel` |
| `hide_root_location` | `boolean` | `false` | ides the root location if it doesn't fit in the last `max_depth` folders, when using `agnoster_short` |
| `cycle` | `[]string` | | a list of color overrides to cycle through to colorize the individual path folders, e.g. `[ "#ffffff,#111111" ]` |
| `cycle_folder_separator` | `boolean` | `false` | colorize the `folder_separator_icon` as well when using a cycle |
| `folder_format` | `string` | `%s` | format to use on individual path folders |
| `edge_format` | `string` | `%s` | format to use on the first and last folder of the path |
| `left_format` | `string` | `%s` | format to use on the firstfolder of the path - defaults to `edge_format` |
| `right_format` | `string` | `%s` | format to use on the last folder of the path - defaults to `edge_format` |
| `gitdir_format` | `string` | | format to use for a git root directory |
## Mapped Locations
@ -56,10 +56,10 @@ Allows you to override a location with an icon/string.
It validates if the current path **starts with the specific elements** and replaces it with the icon/string if there's a match.
To avoid issues with nested overrides, Oh My Posh will sort the list of mapped locations before doing a replacement.
| Name | Type | Description |
| -------------------------- | --------- | -------------------------------------------------------------------------------------------------------- |
| `mapped_locations_enabled` | `boolean` | replace known locations in the path with the replacements before applying the style - defaults to `true` |
| `mapped_locations` | `object` | custom glyph/text for specific paths. Works regardless of the `mapped_locations_enabled` |
| Name | Type | Default | Description |
| -------------------------- | :-------: | :-----: | ---------------------------------------------------------------------------------------- |
| `mapped_locations_enabled` | `boolean` | `true` | replace known locations in the path with the replacements before applying the style |
| `mapped_locations` | `object` | | custom glyph/text for specific paths. Works regardless of the `mapped_locations_enabled` |
setting.

19
website/docs/segments/perl.mdx
View file

@ -25,15 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the perl version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the perl command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when one of the following files is present (**default**):<ul><li>`.perl-version`</li><li>`*.pl`</li><li>`*.p`</li><li>`*.t`</li></ul></li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the perl version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.pl, *.pm, *.t, .perl-version` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

20
website/docs/segments/php.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the php version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when one of the following files is present (**default**):<ul><li>`*.php`</li><li>`composer.json`</li><li>`composer.lock`</li><li>`.php-version`</li><li>`blade.php`</li></ul></li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the php version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.php, .php-version, composer.json, composer.lock` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

28
website/docs/segments/plastic.mdx
View file

@ -50,28 +50,28 @@ by leaving a like!
As doing multiple `cm` calls can slow down the prompt experience, we do not fetch information by default.
You can set the following property to `true` to enable fetching additional information (and populate the template).
| Name | Type | Description |
| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch_status` | `boolean` | fetch the local changes - defaults to `false` |
| `status_formats` | `map[string]string` | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides. Defaults to an empty map. |
| Name | Type | Default | Description |
| ---------------- | :-----------------: | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch_status` | `boolean` | `false` | fetch the local changes |
| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides |
### Icons
#### Branch
| Name | Type | Description |
| ------------------- | -------- | -------------------------------------------------------------------------------------------- |
| `branch_icon` | `string` | the icon to use in front of the git branch name - defaults to `\uE0A0 ` |
| `full_branch_path` | `bool` | display the full branch path: `_/main/fix-001_` instead of `_fix-001_` - defaults to `true` |
| `branch_max_length` | `int` | the max length for the displayed branch name where `0` implies full length - defaults to `0` |
| `truncate_symbol` | `string` | the icon to display when a branch name is truncated - defaults to empty |
| Name | Type | Default | Description |
| ------------------- | :------: | :------: | -------------------------------------------------------------------------- |
| `branch_icon` | `string` | `\uE0A0` | the icon to use in front of the git branch name |
| `full_branch_path` | `bool` | `true` | display the full branch path: `_/main/fix-001_` instead of `_fix-001_` |
| `branch_max_length` | `int` | `0` | the max length for the displayed branch name where `0` implies full length |
| `truncate_symbol` | `string` | | the icon to display when a branch name is truncated |
#### Selector
| Name | Type | Description |
| ------------- | -------- | ------------------------------------------------------------------------------------- |
| `commit_icon` | `string` | icon/text to display before the commit context (detached HEAD) - defaults to `\uF417` |
| `tag_icon` | `string` | icon/text to display before the tag context - defaults to `\uF412` |
| Name | Type | Default | Description |
| ------------- | :------: | :------: | -------------------------------------------------------------- |
| `commit_icon` | `string` | `\uF417` | icon/text to display before the commit context (detached HEAD) |
| `tag_icon` | `string` | `\uF412` | icon/text to display before the tag context |
## Template ([info][templates])

6
website/docs/segments/project.mdx
View file

@ -37,9 +37,9 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------- | --------- | --------------------------------------------- |
| `always_enabled` | `boolean` | always show the segment - defaults to `false` |
| Name | Type | Default | Description |
| ---------------- | :-------: | :-----: | ----------------------- |
| `always_enabled` | `boolean` | `false` | always show the segment |
## Template ([info][templates])

2
website/docs/segments/pulumi.mdx
View file

@ -31,7 +31,7 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Default | Description |
| ------------- | --------- | ------- | ---------------------------------------------------------------------------------- |
| ------------- | :-------: | :-----: | ---------------------------------------------------------------------------------- |
| `fetch_stack` | `boolean` | `false` | fetch the current stack name |
| `fetch_about` | `boolean` | `false` | fetch the URL and user for the current stask. Requires `fetch_stack` set to `true` |

26
website/docs/segments/python.mdx
View file

@ -26,19 +26,19 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_virtual_env` | `boolean` | fetch the name of the virtualenv or not - defaults to `true` |
| `display_default` | `boolean` | show the name of the virtualenv when it's default (`system`, `base`) or not - defaults to `true` |
| `fetch_version` | `boolean` | fetch the python version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when one of the following files is present:<ul><li>`*.py`</li><li>`*.ipynb`</li><li>`pyproject.toml`</li><li>`venv.bak`</li><li>`venv`</li><li>`.venv`</li></ul></li><li>`environment`: the segment is only displayed when a virtual env is present (**default**)</li><li>`context`: the segment is only displayed when either `environment` or `files` is active</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| `folder_name_fallback` | `boolean` | instead of `venv` or `.venv` (case sensitive), use the parent folder name as the virtual environment's name or not - defaults to `true` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :---------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_virtual_env` | `boolean` | `true` | fetch the name of the virtualenv or not |
| `display_default` | `boolean` | `true` | show the name of the virtualenv when it's default (`system`, `base`) or not |
| `fetch_version` | `boolean` | `true` | fetch the python version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.py, *.ipynb, pyproject.toml, venv.bak` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
| `folder_name_fallback` | `boolean` | `true` | instead of `venv` or `.venv` (case sensitive), use the parent folder name as the virtual environment's name or not |
## Template ([info][templates])

21
website/docs/segments/quasar.mdx
View file

@ -26,16 +26,17 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `fetch_version` | `boolean` | fetch the NPM version - defaults to `true` |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `fetch_dependencies` | `boolean` | fetch the version number of the `vite` and `@quasar/app-vite` dependencies if present - defaults to `false` |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `fetch_version` | `boolean` | `true` | fetch the NPM version |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `fetch_dependencies` | `boolean` | `false` | fetch the version number of the `vite` and `@quasar/app-vite` dependencies if present |
| `extensions` | `[]string` | `quasar.config, quasar.config.js` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

20
website/docs/segments/r.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the R version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when one of the following files is present (**default**):<ul><li>`*.R`</li><li>`*.Rmd`</li><li>`*.Rsx`</li><li>`*.Rda`</li><li>`*.Rd`</li><li>`*.Rproj`</li><li>`.Rproj.user`</li></ul></li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the R version or not |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.R, *.Rmd, *.Rsx, *.Rda, *.Rd, *.Rproj, .Rproj.user` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

19
website/docs/segments/react.mdx
View file

@ -24,15 +24,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the active version or not; useful if all you need is an icon indicating `ng` |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `package.json` file is present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the react version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `package.json` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

20
website/docs/segments/ruby.mdx
View file

@ -25,15 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the ruby version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.rb`, `Gemfile` or `Rakefile` files are present (**default**)</li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-----------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the ruby version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.rb, Rakefile, Gemfile` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])
@ -52,4 +53,5 @@ import Config from "@site/src/components/Config.js";
| `.Full` | `string` | the full version |
| `.Error` | `string` | error encountered when fetching the version string |
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates

20
website/docs/segments/rust.mdx
View file

@ -25,15 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the rust version (`rustc --version`) - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.rs`, `Cargo.toml` or `Cargo.lock` files are present (**default**)</li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the rust version (`rustc --version`) |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.rs, Cargo.toml, Cargo.lock` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])
@ -56,4 +57,5 @@ import Config from "@site/src/components/Config.js";
| `.Prerelease` | `string` | channel name |
| `.Error` | `string` | error encountered when fetching the version string |
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: /docs/configuration/templates

10
website/docs/segments/sapling.mdx
View file

@ -30,11 +30,11 @@ import Config from "@site/src/components/Config.js";
### Fetching information
| Name | Type | Description |
| ----------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch_status` | `boolean` | fetch the local changes - defaults to `true` |
| `native_fallback` | `boolean` | when set to `true` and `sl.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native sapling executable to fetch data. Not all information can be displayed in this case. Defaults to `false` |
| `status_formats` | `map[string]string` | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides. Defaults to an empty map. |
| Name | Type | Default | Description |
| ------------------- | :-----------------: | :-----: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch_status` | `boolean` | `true` | fetch the local changes - defaults to |
| `native_fallback` | `boolean` | `false` | when set to `true` and `sl.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native sapling executable to fetch data. Not all information can be displayed in this case |
| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides |
## Template ([info][templates])

4
website/docs/segments/shell.mdx
View file

@ -27,7 +27,9 @@ import Config from '@site/src/components/Config.js';
## Properties
|`mapped_shell_names`|`object`|custom glyph/text to use in place of specified shell names (case-insensitive)|
| Name | Type | Default | Description |
| -------------------- | :------: | :-----: | ----------------------------------------------------------------------------- |
| `mapped_shell_names` | `object` | | custom glyph/text to use in place of specified shell names (case-insensitive) |
## Template ([info][templates])

6
website/docs/segments/sitecore.mdx
View file

@ -22,9 +22,9 @@ Display current Sitecore environment. Will not be active when sitecore.json and
## Properties
| Name | Type | Description |
| ----------------- | --------- | -------------------------------------------------------------------------------------------------- |
| `display_default` | `boolean` | display the segment or not when the Sitecore environment name matches `default` - defaults to true |
| Name | Type | Default | Description |
| ----------------- | :-------: | :-----: | ------------------------------------------------------------------------------- |
| `display_default` | `boolean` | `true` | display the segment or not when the Sitecore environment name matches `default` |
## Template ([info][templates])

10
website/docs/segments/spotify.mdx
View file

@ -36,11 +36,11 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| -------------- | -------- | ------------------------------------------------------ |
| `playing_icon` | `string` | text/icon to show when playing - defaults to `\uE602 ` |
| `paused_icon` | `string` | text/icon to show when paused - defaults to `\uF8E3 ` |
| `stopped_icon` | `string` | text/icon to show when stopped - defaults to `\uF04D ` |
| Name | Type | Default | Description |
| -------------- | :------: | :-------: | ------------------------------ |
| `playing_icon` | `string` | `\uE602 ` | text/icon to show when playing |
| `paused_icon` | `string` | `\uF8E3 ` | text/icon to show when paused |
| `stopped_icon` | `string` | `\uF04D` | text/icon to show when stopped |
## Template ([info][templates])

10
website/docs/segments/status.mdx
View file

@ -29,11 +29,11 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ------------------ | --------- | ---------------------------------------------------------------------------------------------------- |
| `always_enabled` | `boolean` | always show the status - defaults to `false` |
| `status_template` | `string` | [template][status-template] used to render an individual status code - defaults to `{{ .Code }}` |
| `status_separator` | `string` | used to separate multiple statuses when `$PIPESTATUS` is available - defaults to <code>&#124;</code> |
| Name | Type | Default | Description |
| ------------------ | :-------: | :-----------: | -------------------------------------------------------------------- |
| `always_enabled` | `boolean` | `false` | always show the status |
| `status_template` | `string` | `{{ .Code }}` | [template][status-template] used to render an individual status code |
| `status_separator` | `string` | `\|` | used to separate multiple statuses when `$PIPESTATUS` is available |
[colors]: /docs/configuration/colors

24
website/docs/segments/strava.mdx
View file

@ -58,18 +58,18 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| `access_token` | `string` | token from Strava login, see login link in section above. |
| `refresh_token` | `string` | token from Strava login, see login link in section above. |
| `expires_in` | `int` | the default timeout of the token from the Strava login |
| `http_timeout` | `int` | how long do you want to wait before you want to see your prompt more than your strava data? - defaults to 500ms |
| `cache_timeout` | `int` | in minutes - How long do you want your Strava data cached? - defaults to 5 min |
| `ride_icon` | `string` | defaults to `\uf206` |
| `run_icon` | `string` | defaults to `\ue213` |
| `skiing_icon` | `string` | defaults to `\ue213` |
| `workout_icon` | `string` | defaults to `\ue213` |
| `unknown_activity_icon` | `string` | defaults to `\ue213` |
| Name | Type | Default | Description |
| ----------------------- | :------: | :------: | ------------------------------------------------------------------------------------------------------------- |
| `access_token` | `string` | | token from Strava login, see login link in section above. |
| `refresh_token` | `string` | | token from Strava login, see login link in section above. |
| `expires_in` | `int` | `0` | the default timeout of the token from the Strava login |
| `http_timeout` | `int` | `500` | in milliseconds - how long do you want to wait before you want to see your prompt more than your strava data? |
| `cache_timeout` | `int` | `5` | in minutes - How long do you want your Strava data cached? |
| `ride_icon` | `string` | `\uf206` | |
| `run_icon` | `string` | `\ue213` | |
| `skiing_icon` | `string` | `\ue213` | |
| `workout_icon` | `string` | `\ue213` | |
| `unknown_activity_icon` | `string` | `\ue213` | |
## Template ([info][templates])

10
website/docs/segments/svn.mdx
View file

@ -33,11 +33,11 @@ import Config from "@site/src/components/Config.js";
As doing multiple [subversion][svn] calls can slow down the prompt experience, we do not fetch information by default.
You can set the following properties to `true` to enable fetching additional information (and populate the template).
| Name | Type | Description |
| ----------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch_status` | `boolean` | fetch the local changes - defaults to `false` |
| `native_fallback` | `boolean` | when set to `true` and `svn.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native svn executable to fetch data. Not all information can be displayed in this case. Defaults to `false`. |
| `status_formats` | `map[string]string` | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides. Defaults to an empty map. |
| Name | Type | Default | Description |
| ------------------- | :-----------------: | :-----: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `fetch_status` | `boolean` | `false` | fetch the local changes |
| `native_fallback` | `boolean` | `false` | when set to `true` and `svn.exe` is not available when inside a WSL2 shared Windows drive, we will fallback to the native svn executable to fetch data. Not all information can be displayed in this case |
| `status_formats` | `map[string]string` | | a key, value map allowing to override how individual status items are displayed. For example, `"status_formats": { "Added": "Added: %d" }` will display the added count as `Added: 1` instead of `+1`. See the [Status](#status) section for available overrides |
## Template ([info][templates])

20
website/docs/segments/swift.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the swift version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.swift` or `*.SWIFT` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :----------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the swift version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.swift, *.SWIFT` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

6
website/docs/segments/sysinfo.mdx
View file

@ -26,9 +26,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| ----------- | ----- | ------------------------------------------------------- |
| `Precision` | `int` | The precision used for any float values - defaults to 2 |
| Name | Type | Default | Description |
| ----------- | :---: | :-----: | --------------------------------------- |
| `Precision` | `int` | `2` | The precision used for any float values |
## Template ([info][templates])

6
website/docs/segments/terraform.mdx
View file

@ -27,9 +27,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| --------------- | --------- | -------------------------------------------------------------------------------------------------------- |
| `fetch_version` | `boolean` | fetch the version information from `versions.tf`, `main.tf` or `terraform.tfstate` - defaults to `false` |
| Name | Type | Default | Description |
| --------------- | :-------: | :-----: | ---------------------------------------------------------------------------------- |
| `fetch_version` | `boolean` | `false` | fetch the version information from `versions.tf`, `main.tf` or `terraform.tfstate` |
## Template ([info][templates])

6
website/docs/segments/time.mdx
View file

@ -23,9 +23,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| ------------- | -------- | ----------------------------------------------------------------------------- |
| `time_format` | `string` | format to use, follows the [golang standard][format] - defaults to `15:04:05` |
| Name | Type | Default | Description |
| ------------- | :------: | :--------: | ---------------------------------------------------- |
| `time_format` | `string` | `15:04:05` | format to use, follows the [golang standard][format] |
## Template ([info][templates])

20
website/docs/segments/ui5tooling.mdx
View file

@ -26,16 +26,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the UI5 tooling version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the java command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*ui5*.y(a)ml` file is present in the current folder</li><li>`context`: the segment is only displayed when `*ui5*.y(a)ml` file is present in the current folder or it has been found in the parent folders (check up to 4 levels) (**default**) </li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :----------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the ui5tooling version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*ui5*.y*ml` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

6
website/docs/segments/unity.mdx
View file

@ -36,9 +36,9 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| --------------- | -------- | ----------------------------------------------- |
| `http_timeout` | `int` | The default timeout for http request is 2000ms. |
| Name | Type | Default | Description |
| -------------- | :---: | :-----: | ---------------------------------------------- |
| `http_timeout` | `int` | `2000` | in milliseconds - the timeout for http request |
## Template ([info][templates])

6
website/docs/segments/upgrade.mdx
View file

@ -23,9 +23,9 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| --------------- | ----- | --------------------------------------------------------------------------------------------- |
| `cache_timeout` | `int` | in minutes - How long to wait before checking for a new version. Default is 10080 (one week). |
| Name | Type | Default | Description |
| --------------- | :---: | :-----: | ------------------------------------------------------------------------------------- |
| `cache_timeout` | `int` | `10080` | in minutes - how long to wait before checking for a new version. Default is one week. |
## Template ([info][templates])

20
website/docs/segments/vala.mdx
View file

@ -25,16 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | fetch the flutter version - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when `*.vala` files are present (**default**)</li></ul> |
| `version_url_template` | `string` | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the vala version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `*.vala` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([info][templates])

10
website/docs/segments/wakatime.mdx
View file

@ -32,11 +32,11 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| --------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | `string` | The Wakatime [summaries][wk-summaries] URL, including the API key. Example above. Defaults to ``. |
| `http_timeout` | `int` | The time (_in milliseconds_, `ms`) it takes to consider an http request as **timed-out**. Defaults to `20`. If no segment is shown, try increasing this timeout. |
| `cache_timeout` | `int` | The time (_in minutes_, `m`) it takes to invalidate/renew the Wakatime segment output. Defaults to `10`. Setting this to `0` disables the cache and requests to the API everytime the user presses the Enter key. |
| Name | Type | Default | Description |
| --------------- | :-------: | :-----: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | `string` | | The Wakatime [summaries][wk-summaries] URL, including the API key. Example above. |
| `http_timeout` | `int` | `20` | The time (_in milliseconds_, `ms`) it takes to consider an http request as **timed-out**. If no segment is shown, try increasing this timeout. |
| `cache_timeout` | `int` | `10` | The time (_in minutes_, `m`) it takes to invalidate/renew the Wakatime segment output. Setting this to `0` disables the cache and requests to the API everytime the user presses the Enter key. |
### Dynamic API Key

8
website/docs/segments/winreg.mdx
View file

@ -35,10 +35,10 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `path` | `string` | registry path to the desired key using backslashes and with a valid root HKEY name. Ending path with \ will get the (Default) key from that path |
| `fallback` | `string` | the value to fall back to if no entry is found |
| Name | Type | Default | Description |
| ---------- | :------: | :-----: | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `path` | `string` | | registry path to the desired key using backslashes and with a valid root HKEY name. Ending path with \ will get the (Default) key from that path |
| `fallback` | `string` | | the value to fall back to if no entry is found |
## Template ([info][templates])

14
website/docs/segments/withings.mdx
View file

@ -44,13 +44,13 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `access_token` | `string` | token from Withings login, see login link in section above. |
| `refresh_token` | `string` | token from Withings login, see login link in section above. |
| `expires_in` | `int` | the default timeout of the token from the Withings login |
| `http_timeout` | `int` | how long do you want to wait before you want to see your prompt more than your Withings data? - defaults to 500ms |
| `cache_timeout` | `int` | in minutes - How long do you want your Withings data cached? - defaults to 5 min |
| Name | Type | Default | Description |
| ---------------- | :------: | :-----: | --------------------------------------------------------------------------------------------- |
| `access_token` | `string` | | token from Withings login, see login link in section above. |
| `refresh_token` | `string` | | token from Withings login, see login link in section above. |
| `expires_in` | `int` | `0` | the default timeout of the token from the Withings login |
| `http_timeout` | `int` | `500` | how long do you want to wait before you want to see your prompt more than your Withings data? |
| `cache_timeout` | `int` | `5` | in minutes - How long do you want your Withings data cached? |
## Template ([info][templates])

22
website/docs/segments/xmake.mdx
View file

@ -25,15 +25,16 @@ import Config from "@site/src/components/Config.js";
## Properties
| Name | Type | Description |
| ---------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `home_enabled` | `boolean` | display the segment in the HOME folder or not - defaults to `false` |
| `fetch_version` | `boolean` | display the xmake version (`xmake --version`) - defaults to `true` |
| `missing_command_text` | `string` | text to display when the command is missing - defaults to empty |
| `display_mode` | `string` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when a `xmake.lua` file is present (**default**)</li></ul> |
| `extensions` | `[]string` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | cache the executable's version or not - defaults to `false` |
| Name | Type | Default | Description |
| ---------------------- | :--------: | :---------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `home_enabled` | `boolean` | `false` | display the segment in the HOME folder or not |
| `fetch_version` | `boolean` | `true` | fetch the xmake version |
| `missing_command_text` | `string` | | text to display when the command is missing |
| `display_mode` | `string` | `context` | <ul><li>`always`: the segment is always displayed</li><li>`files`: the segment is only displayed when file `extensions` listed are present</li><li>`context`: displays the segment when the environment or files is active</li></ul> |
| `version_url_template` | `string` | | a go [text/template][go-text-template] [template][templates] that creates the URL of the version info / release notes |
| `extensions` | `[]string` | `xmake.lua` | allows to override the default list of file extensions to validate |
| `folders` | `[]string` | | allows to override the list of folder names to validate |
| `cache_version` | `boolean` | `false` | cache the executable's version or not |
## Template ([into][templates])
@ -55,4 +56,5 @@ import Config from "@site/src/components/Config.js";
| `.Patch` | `string` | patch number |
| `.Error` | `string` | error encountered when fetching the version string |
[templates]: /docs/configuration/templates
[go-text-template]: https://golang.org/pkg/text/template/
[templates]: configuration/templates.mdx

12
website/docs/segments/ytm.mdx
View file

@ -32,12 +32,12 @@ import Config from '@site/src/components/Config.js';
## Properties
| Name | Type | Description |
| -------------- | -------- | --------------------------------------------------------------------- |
| `playing_icon` | `string` | text/icon to show when playing - defaults to `\uE602 ` |
| `paused_icon` | `string` | text/icon to show when paused - defaults to `\uF8E3 ` |
| `stopped_icon` | `string` | text/icon to show when paused - defaults to `\uF04D ` |
| `api_url` | `string` | the YTMDA Remote Control API URL- defaults to `http://127.0.0.1:9863` |
| Name | Type | Default | Description |
| -------------- | :------: | :----------------------: | -------------------------------- |
| `playing_icon` | `string` | `\uE602 ` | text/icon to show when playing |
| `paused_icon` | `string` | `\uF8E3 ` | text/icon to show when paused |
| `stopped_icon` | `string` | `\uF04D ` | text/icon to show when stopped |
| `api_url` | `string` | `http://127.0.0.1:13091` | the YTMDA Remote Control API URL |
## Template ([info][templates])