Starship

Configuration file for Starship. Documentation: https://starship.rs

Type object
File match starship.toml
Schema URL https://catalog.lintel.tools/schemas/schemastore/starship/latest.json
Source https://starship.rs/config-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

$schema string
Default: "https://starship.rs/config-schema.json"
format string
Default: "$all"
right_format string
Default: ""
continuation_prompt string
Default: "[∙](bright-black) "
scan_timeout integer
Default: 30
format=uint64min=0
command_timeout integer
Default: 500
format=uint64min=0
add_newline boolean
Default: true
palette string | null
palettes Record<string, object>
Default:
{}
profiles Record<string, string>
Default:
{}
aws object

The aws module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the AWS_REGION, AWS_DEFAULT_REGION, and AWS_PROFILE env vars and the ~/.aws/config and ~/.aws/credentials files as required.

The module will display a profile only if its credentials are present in ~/.aws/credentials or if a credential_process or sso_start_url are defined in ~/.aws/config. Alternatively, having any of the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, or AWS_SESSION_TOKEN env vars defined will also suffice. If the option force_display is set to true, all available information will be displayed even if no credentials per the conditions above are detected.

When using aws-vault the profile is read from the AWS_VAULT env var and the credentials expiration date is read from the AWS_SESSION_EXPIRATION or AWS_CREDENTIAL_EXPIRATION var.

When using awsu the profile is read from the AWSU_PROFILE env var.

When using AWSume the profile is read from the AWSUME_PROFILE env var and the credentials expiration date is read from the AWSUME_EXPIRATION env var.

When using aws-sso-cli the profile is read from the AWS_SSO_PROFILE env var.

8 nested properties
format string

The format for the module.

Default: "on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)"
symbol string

The symbol used before displaying the current AWS profile.

Default: "☁️ "
style string

The style for the module.

Default: "bold yellow"
disabled boolean

Disables the AWS module.

Default: false
region_aliases Record<string, string>

Table of region aliases to display in addition to the AWS name.

Default:
{}
profile_aliases Record<string, string>

Table of profile aliases to display in addition to the AWS name.

Default:
{}
expiration_symbol string

The symbol displayed when the temporary credentials have expired.

Default: "X"
force_display boolean

If true displays info even if credentials, credential_process or sso_start_url have not been setup.

Default: false
azure object
5 nested properties
format string
Default: "on [$symbol($subscription)]($style) "
symbol string
Default: "󰠅 "
style string
Default: "blue bold"
disabled boolean
Default: true
subscription_aliases Record<string, string>
Default:
{}
battery object
8 nested properties
full_symbol string
Default: "󰁹 "
charging_symbol string
Default: "󰂄 "
discharging_symbol string
Default: "󰂃 "
unknown_symbol string
Default: "󰁽 "
empty_symbol string
Default: "󰂎 "
display BatteryDisplayConfig[]
Default:
[
  {
    "threshold": 10,
    "style": "red bold",
    "charging_symbol": null,
    "discharging_symbol": null
  }
]
disabled boolean
Default: false
format string
Default: "[$symbol$percentage]($style) "
buf object
8 nested properties
format string
Default: "with [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🐃 "
style string
Default: "bold blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "buf.yaml",
  "buf.gen.yaml",
  "buf.work.yaml"
]
detect_folders string[]
Default:
[]
bun object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🥟 "
style string
Default: "bold red"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "bun.lock",
  "bun.lockb",
  "bunfig.toml"
]
detect_folders string[]
Default:
[]
c object
9 nested properties
format string
Default: "via [$symbol($version(-$name) )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "149 bold"
symbol string
Default: "C "
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "c",
  "h"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
commands string[][]
Default:
[
  [
    "cc",
    "--version"
  ],
  [
    "gcc",
    "--version"
  ],
  [
    "clang",
    "--version"
  ]
]
character object
8 nested properties
format string
Default: "$symbol "
success_symbol string
Default: "[❯](bold green)"
error_symbol string
Default: "[❯](bold red)"
vimcmd_symbol string
Default: "[❮](bold green)"
vimcmd_visual_symbol string
Default: "[❮](bold yellow)"
vimcmd_replace_symbol string
Default: "[❮](bold purple)"
vimcmd_replace_one_symbol string
Default: "[❮](bold purple)"
disabled boolean
Default: false
cmake object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "△ "
style string
Default: "bold blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "CMakeLists.txt",
  "CMakeCache.txt"
]
detect_folders string[]
Default:
[]
cmd_duration object
8 nested properties
min_time integer
Default: 2000
format=int64
format string
Default: "took [$duration]($style) "
style string
Default: "yellow bold"
show_milliseconds boolean
Default: false
disabled boolean
Default: false
show_notifications boolean
Default: false
min_time_to_notify integer
Default: 45000
format=int64
notification_timeout integer | null
format=uint32min=0
cobol object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⚙️ "
style string
Default: "bold blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "cbl",
  "cob",
  "CBL",
  "COB"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
conda object
7 nested properties
truncation_length integer
Default: 1
format=uintmin=0
format string
Default: "via [$symbol$environment]($style) "
symbol string
Default: "🅒 "
style string
Default: "green bold"
ignore_base boolean
Default: true
detect_env_vars string[]
Default:
[
  "!PIXI_ENVIRONMENT_NAME"
]
disabled boolean
Default: false
container object
4 nested properties
format string
Default: "[$symbol \[$name\]]($style) "
symbol string
Default: "⬢"
style string
Default: "red bold dimmed"
disabled boolean
Default: false
cpp object
9 nested properties
format string
Default: "via [$symbol($version(-$name) )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "149 bold"
symbol string
Default: "C "
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "c",
  "h"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
commands string[][]
Default:
[
  [
    "cc",
    "--version"
  ],
  [
    "gcc",
    "--version"
  ],
  [
    "clang",
    "--version"
  ]
]
crystal object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🔮 "
style string
Default: "bold red"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "cr"
]
detect_files string[]
Default:
[
  "shard.yml"
]
detect_folders string[]
Default:
[]
daml object
8 nested properties
symbol string
Default: "Λ "
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "bold cyan"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "daml.yaml"
]
detect_folders string[]
Default:
[]
dart object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🎯 "
style string
Default: "bold blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "dart"
]
detect_files string[]
Default:
[
  "pubspec.yaml",
  "pubspec.yml",
  "pubspec.lock"
]
detect_folders string[]
Default:
[
  ".dart_tool"
]
deno object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🦕 "
style string
Default: "green bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "deno.json",
  "deno.jsonc",
  "deno.lock",
  "mod.ts",
  "deps.ts",
  "mod.js",
  "deps.js"
]
detect_folders string[]
Default:
[]
directory object
16 nested properties
truncation_length integer
Default: 3
format=int64
truncate_to_repo boolean
Default: true
substitutions Record<string, string>
Default:
{}
fish_style_pwd_dir_length integer
Default: 0
format=int64
use_logical_path boolean
Default: true
format string
Default: "[$path]($style)[$read_only]($read_only_style) "
repo_root_format string
Default: "[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "
style string
Default: "cyan bold"
repo_root_style string | null
Default: null
before_repo_root_style string | null
Default: null
disabled boolean
Default: false
read_only string
Default: "🔒"
read_only_style string
Default: "red"
truncation_symbol string
Default: ""
home_symbol string
Default: "~"
use_os_path_sep boolean
Default: true
direnv object
13 nested properties
format string
Default: "[$symbol$loaded/$allowed]($style) "
symbol string
Default: "direnv "
style string
Default: "bold bright-yellow"
disabled boolean
Default: true
detect_extensions string[]
Default:
[]
detect_env_vars string[]
Default:
[
  "DIRENV_FILE"
]
detect_files string[]
Default:
[
  ".envrc"
]
detect_folders string[]
Default:
[]
allowed_msg string
Default: "allowed"
not_allowed_msg string
Default: "not allowed"
denied_msg string
Default: "denied"
loaded_msg string
Default: "loaded"
unloaded_msg string
Default: "not loaded"
docker_context object
8 nested properties
symbol string
Default: "🐳 "
style string
Default: "blue bold"
format string
Default: "via [$symbol$context]($style) "
only_with_files boolean
Default: true
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "compose.yml",
  "compose.yaml",
  "docker-compose.yml",
  "docker-compose.yaml",
  "Dockerfile"
]
detect_folders string[]
Default:
[]
dotnet object
9 nested properties
format string
Default: "via [$symbol($version )(🎯 $tfm )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: ".NET "
style string
Default: "blue bold"
heuristic boolean
Default: true
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "csproj",
  "fsproj",
  "xproj"
]
detect_files string[]
Default:
[
  "global.json",
  "project.json",
  "Directory.Build.props",
  "Directory.Build.targets",
  "Packages.props"
]
detect_folders string[]
Default:
[]
elixir object
8 nested properties
format string
Default: "via [$symbol($version \(OTP $otp_version\) )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "💧 "
style string
Default: "bold purple"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "mix.exs"
]
detect_folders string[]
Default:
[]
elm object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🌳 "
style string
Default: "cyan bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "elm"
]
detect_files string[]
Default:
[
  "elm.json",
  "elm-package.json",
  ".elm-version"
]
detect_folders string[]
Default:
[
  "elm-stuff"
]
env_var Record<string, object>
Default:
{}
erlang object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: " "
style string
Default: "bold red"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "rebar.config",
  "erlang.mk"
]
detect_folders string[]
Default:
[]
fennel object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🧅 "
style string
Default: "bold green"
disabled boolean
Default: true
detect_extensions string[]
Default:
[
  "fnl"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
fill object
3 nested properties
style string
Default: "bold black"
symbol string
Default: "."
disabled boolean
Default: false
fortran object
9 nested properties
format string
Default: "via [$symbol($version(-$name) )]($style)"
version_format string
Default: "${raw}"
symbol string
Default: "🅵 "
style string
Default: "bold purple"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "f",
  "F",
  "for",
  "FOR",
  "ftn",
  "FTN",
  "f77",
  "F77",
  "f90",
  "F90",
  "f95",
  "F95",
  "f03",
  "F03",
  "f08",
  "F08",
  "f18",
  "F18"
]
detect_files string[]
Default:
[
  "fpm.toml"
]
detect_folders string[]
Default:
[]
commands string[][]
Default:
[
  [
    "gfortran",
    "--version"
  ],
  [
    "flang",
    "--version"
  ],
  [
    "flang-new",
    "--version"
  ]
]
fossil_branch object
6 nested properties
format string
Default: "on [$symbol$branch]($style) "
symbol string
Default: " "
style string
Default: "bold purple"
truncation_length integer
Default: 9223372036854775807
format=int64
truncation_symbol string
Default: "…"
disabled boolean
Default: true
fossil_metrics object
5 nested properties
format string
Default: "([+$added]($added_style) )([-$deleted]($deleted_style) )"
added_style string
Default: "bold green"
deleted_style string
Default: "bold red"
only_nonzero_diffs boolean
Default: true
disabled boolean
Default: true
gcloud object
7 nested properties
format string
Default: "on [$symbol$account(@$domain)(\($region\))]($style) "
symbol string
Default: "☁️ "
style string
Default: "bold blue"
disabled boolean
Default: false
region_aliases Record<string, string>
Default:
{}
project_aliases Record<string, string>
Default:
{}
detect_env_vars string[]
Default:
[]
git_branch object
10 nested properties
format string
Default: "on [$symbol$branch(:$remote_branch)]($style) "
symbol string
Default: " "
style string
Default: "bold purple"
truncation_length integer
Default: 9223372036854775807
format=int64
truncation_symbol string
Default: "…"
only_attached boolean
Default: false
always_show_remote boolean
Default: false
ignore_branches string[]
Default:
[]
ignore_bare_repo boolean
Default: false
disabled boolean
Default: false
git_commit object
8 nested properties
commit_hash_length integer
Default: 7
format=uintmin=0
format string
Default: "[\($hash$tag\)]($style) "
style string
Default: "green bold"
only_detached boolean
Default: true
disabled boolean
Default: false
tag_symbol string
Default: " 🏷 "
tag_disabled boolean
Default: true
tag_max_candidates integer
Default: 0
format=uintmin=0
git_metrics object
6 nested properties
added_style string
Default: "bold green"
deleted_style string
Default: "bold red"
only_nonzero_diffs boolean
Default: true
format string
Default: "([+$added]($added_style) )([-$deleted]($deleted_style) )"
disabled boolean
Default: true
ignore_submodules boolean
Default: false
git_state object
10 nested properties
rebase string
Default: "REBASING"
merge string
Default: "MERGING"
revert string
Default: "REVERTING"
cherry_pick string
Default: "CHERRY-PICKING"
bisect string
Default: "BISECTING"
am string
Default: "AM"
am_or_rebase string
Default: "AM/REBASE"
style string
Default: "bold yellow"
format string
Default: "\([$state( $progress_current/$progress_total)]($style)\) "
disabled boolean
Default: false
git_status object
18 nested properties
format string
Default: "([\[$all_status$ahead_behind\]]($style) )"
style string
Default: "red bold"
stashed string
Default: "\$"
ahead string
Default: "⇡"
behind string
Default: "⇣"
up_to_date string
Default: ""
diverged string
Default: "⇕"
conflicted string
Default: "="
deleted string
Default: "✘"
renamed string
Default: "»"
modified string
Default: "!"
staged string
Default: "+"
untracked string
Default: "?"
typechanged string
Default: ""
ignore_submodules boolean
Default: false
disabled boolean
Default: false
use_git_executable boolean
Default: false
windows_starship string | null
gleam object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⭐ "
style string
Default: "bold #FFAFF3"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "gleam"
]
detect_files string[]
Default:
[
  "gleam.toml"
]
detect_folders string[]
Default:
[]
golang object
9 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🐹 "
style string
Default: "bold cyan"
disabled boolean
Default: false
not_capable_style string
Default: "bold red"
detect_extensions string[]
Default:
[
  "go"
]
detect_files string[]
Default:
[
  "go.mod",
  "go.sum",
  "go.work",
  "glide.yaml",
  "Gopkg.yml",
  "Gopkg.lock",
  ".go-version"
]
detect_folders string[]
Default:
[
  "Godeps"
]
gradle object
9 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🅶 "
style string
Default: "bold bright-cyan"
disabled boolean
Default: false
recursive boolean
Default: false
detect_extensions string[]
Default:
[
  "gradle",
  "gradle.kts"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[
  "gradle"
]
guix_shell object
4 nested properties
format string
Default: "via [$symbol]($style) "
symbol string
Default: "🐃 "
style string
Default: "yellow bold"
disabled boolean
Default: false
haskell object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "λ "
style string
Default: "bold purple"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "hs",
  "cabal",
  "hs-boot"
]
detect_files string[]
Default:
[
  "stack.yaml",
  "cabal.project"
]
detect_folders string[]
Default:
[]
haxe object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⌘ "
style string
Default: "bold fg:202"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "hx",
  "hxml"
]
detect_files string[]
Default:
[
  "haxelib.json",
  "hxformat.json",
  ".haxerc"
]
detect_folders string[]
Default:
[
  ".haxelib",
  "haxe_libraries"
]
helm object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⎈ "
style string
Default: "bold white"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "helmfile.yaml",
  "Chart.yaml"
]
detect_folders string[]
Default:
[]
hg_branch object
6 nested properties
symbol string
Default: " "
style string
Default: "bold purple"
format string
Default: "on [$symbol$branch(:$topic)]($style) "
truncation_length integer
Default: 9223372036854775807
format=int64
truncation_symbol string
Default: "…"
disabled boolean
Default: true
hg_state object
11 nested properties
merge string
Default: "MERGING"
rebase string
Default: "REBASING"
update string
Default: "UPDATING"
bisect string
Default: "BISECTING"
shelve string
Default: "SHELVING"
graft string
Default: "GRAFTING"
transplant string
Default: "TRANSPLANTING"
histedit string
Default: "HISTEDITING"
style string
Default: "bold yellow"
format string
Default: "\([$state]($style)\) "
disabled boolean
Default: true
hostname object
8 nested properties
ssh_only boolean
Default: true
ssh_symbol string
Default: "🌐 "
trim_at string
Default: "."
detect_env_vars string[]
Default:
[]
format string
Default: "[$ssh_symbol$hostname]($style) in "
style string
Default: "green dimmed bold"
disabled boolean
Default: false
aliases Record<string, string>
Default:
{}
java object
8 nested properties
disabled boolean
Default: false
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "red dimmed"
symbol string
Default: "☕ "
detect_extensions string[]
Default:
[
  "java",
  "class",
  "jar",
  "gradle",
  "clj",
  "cljc"
]
detect_files string[]
Default:
[
  "pom.xml",
  "build.gradle.kts",
  "build.sbt",
  ".java-version",
  "deps.edn",
  "project.clj",
  "build.boot",
  ".sdkmanrc"
]
detect_folders string[]
Default:
[]
jobs object
7 nested properties
threshold integer
Default: 1
format=int64
symbol_threshold integer
Default: 1
format=int64
number_threshold integer
Default: 2
format=int64
format string
Default: "[$symbol$number]($style) "
symbol string
Default: "✦"
style string
Default: "bold blue"
disabled boolean
Default: false
julia object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "ஃ "
style string
Default: "bold purple"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "jl"
]
detect_files string[]
Default:
[
  "Project.toml",
  "Manifest.toml"
]
detect_folders string[]
Default:
[]
kotlin object
9 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🅺 "
style string
Default: "bold blue"
kotlin_binary string
Default: "kotlin"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "kt",
  "kts"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
kubernetes object
11 nested properties
symbol string
Default: "☸ "
format string
Default: "[$symbol$context( \($namespace\))]($style) in "
style string
Default: "cyan bold"
disabled boolean
Default: true
context_aliases Record<string, string>
Default:
{}
user_aliases Record<string, string>
Default:
{}
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
detect_env_vars string[]
Default:
[]
contexts KubernetesContextConfig[]
Default:
[]
line_break object
1 nested properties
disabled boolean
Default: false
localip object
4 nested properties
ssh_only boolean
Default: true
format string
Default: "[$localipv4]($style) "
style string
Default: "yellow bold"
disabled boolean
Default: true
lua object
9 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🌙 "
style string
Default: "bold blue"
lua_binary string
Default: "lua"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "lua"
]
detect_files string[]
Default:
[
  ".lua-version"
]
detect_folders string[]
Default:
[
  "lua"
]
memory_usage object
5 nested properties
threshold integer
Default: 75
format=int64
format string
Default: "via $symbol[$ram( | $swap)]($style) "
style string
Default: "white bold dimmed"
symbol string
Default: "🐏 "
disabled boolean
Default: true
meson object
6 nested properties
truncation_length integer
Default: 4294967295
format=uint32min=0
truncation_symbol string
Default: "…"
format string
Default: "via [$symbol$project]($style) "
symbol string
Default: "⬢ "
style string
Default: "blue bold"
disabled boolean
Default: false
mise object
9 nested properties
format string
Default: "on [$symbol$health]($style) "
symbol string
Default: "mise "
style string
Default: "bold purple"
disabled boolean
Default: true
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "mise.toml",
  "mise.local.toml",
  ".mise.toml",
  ".mise.local.toml"
]
detect_folders string[]
Default:
[
  ".mise"
]
healthy_symbol string
Default: "healthy"
unhealthy_symbol string
Default: "unhealthy"
mojo object
7 nested properties
format string
Default: "with [$symbol($version )]($style)"
symbol string
Default: "🔥 "
style string
Default: "bold 208"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "mojo",
  "🔥"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
nats object
4 nested properties
format string
Default: "[$symbol($name )]($style)"
symbol string
Default: "✉️ "
style string
Default: "bold purple"
disabled boolean
Default: true
netns object
4 nested properties
format string
Default: "[$symbol \[$name\]]($style) "
symbol string
Default: "🛜"
style string
Default: "blue bold dimmed"
disabled boolean
Default: false
nim object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "👑 "
style string
Default: "yellow bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "nim",
  "nims",
  "nimble"
]
detect_files string[]
Default:
[
  "nim.cfg"
]
detect_folders string[]
Default:
[]
nix_shell object
8 nested properties
format string
Default: "via [$symbol$state( \($name\))]($style) "
symbol string
Default: "❄️ "
style string
Default: "bold blue"
impure_msg string
Default: "impure"
pure_msg string
Default: "pure"
unknown_msg string
Default: ""
disabled boolean
Default: false
heuristic boolean
Default: false
nodejs object
9 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: " "
style string
Default: "bold green"
disabled boolean
Default: false
not_capable_style string
Default: "bold red"
detect_extensions string[]
Default:
[
  "js",
  "mjs",
  "cjs",
  "ts",
  "mts",
  "cts"
]
detect_files string[]
Default:
[
  "package.json",
  ".node-version",
  ".nvmrc",
  "!bunfig.toml",
  "!bun.lock",
  "!bun.lockb"
]
detect_folders string[]
Default:
[
  "node_modules"
]
ocaml object
10 nested properties
format string
Default: "via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"
version_format string
Default: "v${raw}"
global_switch_indicator string
Default: ""
local_switch_indicator string
Default: "*"
symbol string
Default: "🐫 "
style string
Default: "bold yellow"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "opam",
  "ml",
  "mli",
  "re",
  "rei"
]
detect_files string[]
Default:
[
  "dune",
  "dune-project",
  "jbuild",
  "jbuild-ignore",
  ".merlin"
]
detect_folders string[]
Default:
[
  "_opam",
  "esy.lock"
]
odin object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
show_commit boolean
Default: false
symbol string
Default: "Ø "
style string
Default: "bold bright-blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "odin"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
opa object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🪖 "
style string
Default: "bold blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "rego"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
openstack object
4 nested properties
format string
Default: "on [$symbol$cloud(\($project\))]($style) "
symbol string
Default: "☁️ "
style string
Default: "bold yellow"
disabled boolean
Default: false
os object
4 nested properties
format string
Default: "[$symbol]($style)"
style string
Default: "bold white"
symbols Record<string, string>
Default:
{
  "AIX": "➿ ",
  "Alpaquita": "🔔 ",
  "AlmaLinux": "💠 ",
  "Alpine": "🏔️ ",
  "ALTLinux": "Ⓐ ",
  "Amazon": "🙂 ",
  "Android": "🤖 ",
  "AOSC": "🐱 ",
  "Arch": "🎗️ ",
  "Artix": "🎗️ ",
  "Bluefin": "🐟 ",
  "CachyOS": "🎗️ ",
  "CentOS": "💠 ",
  "Debian": "🌀 ",
  "Elementary": "🍏 ",
  "DragonFly": "🐉 ",
  "Emscripten": "🔗 ",
  "EndeavourOS": "🚀 ",
  "Fedora": "🎩 ",
  "FreeBSD": "😈 ",
  "Garuda": "🦅 ",
  "Gentoo": "🗜️ ",
  "HardenedBSD": "🛡️ ",
  "Illumos": "🐦 ",
  "Ios": "📱 ",
  "InstantOS": "⏲️ ",
  "Kali": "🐉 ",
  "Linux": "🐧 ",
  "Mabox": "📦 ",
  "Macos": "🍎 ",
  "Manjaro": "🥭 ",
  "Mariner": "🌊 ",
  "MidnightBSD": "🌘 ",
  "Mint": "🌿 ",
  "NetBSD": "🚩 ",
  "NixOS": "❄️ ",
  "Nobara": "🎩 ",
  "OpenBSD": "🐡 ",
  "OpenCloudOS": "☁️ ",
  "openEuler": "🦉 ",
  "openSUSE": "🦎 ",
  "OracleLinux": "🦴 ",
  "PikaOS": "🐤 ",
  "Pop": "🍭 ",
  "Raspbian": "🍓 ",
  "Redhat": "🎩 ",
  "RedHatEnterprise": "🎩 ",
  "RockyLinux": "💠 ",
  "Redox": "🧪 ",
  "Solus": "⛵ ",
  "SUSE": "🦎 ",
  "Ubuntu": "🎯 ",
  "Ultramarine": "🔷 ",
  "Unknown": "❓ ",
  "Uos": "🐲 ",
  "Void": " ",
  "Windows": "🪟 ",
  "Zorin": "🔹 "
}
disabled boolean
Default: true
package object
6 nested properties
format string
Default: "is [$symbol$version]($style) "
symbol string
Default: "📦 "
style string
Default: "208 bold"
display_private boolean
Default: false
disabled boolean
Default: false
version_format string
Default: "v${raw}"
perl object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🐪 "
style string
Default: "149 bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "pl",
  "pm",
  "pod"
]
detect_files string[]
Default:
[
  "Makefile.PL",
  "Build.PL",
  "cpanfile",
  "cpanfile.snapshot",
  "META.json",
  "META.yml",
  ".perl-version"
]
detect_folders string[]
Default:
[]
php object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🐘 "
style string
Default: "147 bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "php"
]
detect_files string[]
Default:
[
  "composer.json",
  ".php-version"
]
detect_folders string[]
Default:
[]
pijul_channel object
6 nested properties
symbol string
Default: " "
style string
Default: "bold purple"
format string
Default: "on [$symbol$channel]($style) "
truncation_length integer
Default: 9223372036854775807
format=int64
truncation_symbol string
Default: "…"
disabled boolean
Default: true
pixi object
10 nested properties
pixi_binary string | string[]
show_default_environment boolean
Default: true
format string
Default: "via [$symbol($version )(\($environment\) )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🧚 "
style string
Default: "yellow bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "pixi.toml",
  "pixi.lock"
]
detect_folders string[]
Default:
[]
pulumi object
6 nested properties
format string
Default: "via [$symbol($username@)$stack]($style) "
version_format string
Default: "v${raw}"
symbol string
Default: " "
style string
Default: "bold 5"
disabled boolean
Default: false
search_upwards boolean
Default: true
purescript object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "<=> "
style string
Default: "bold white"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "purs"
]
detect_files string[]
Default:
[
  "spago.dhall",
  "spago.yaml",
  "spago.lock"
]
detect_folders string[]
Default:
[]
python object
12 nested properties
pyenv_version_name boolean
Default: false
pyenv_prefix string
Default: "pyenv "
python_binary string | string[]
format string
Default: "via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "yellow bold"
symbol string
Default: "🐍 "
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "py",
  "ipynb"
]
detect_files string[]
Default:
[
  "requirements.txt",
  ".python-version",
  "pyproject.toml",
  "Pipfile",
  "tox.ini",
  "setup.py",
  "__init__.py"
]
detect_folders string[]
Default:
[]
detect_env_vars string[]
Default:
[
  "VIRTUAL_ENV"
]
quarto object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⨁ "
style string
Default: "bold #75AADB"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "qmd"
]
detect_files string[]
Default:
[
  "_quarto.yml"
]
detect_folders string[]
Default:
[]
raku object
8 nested properties
format string
Default: "via [$symbol($version-$vm_version )]($style)"
version_format string
Default: "${raw}"
symbol string
Default: "🦋 "
style string
Default: "149 bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "p6",
  "pm6",
  "pod6",
  "raku",
  "rakumod"
]
detect_files string[]
Default:
[
  "META6.json"
]
detect_folders string[]
Default:
[]
red object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🔺 "
style string
Default: "red bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "red",
  "reds"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
rlang object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "blue bold"
symbol string
Default: "📐 "
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "R",
  "Rd",
  "Rmd",
  "Rproj",
  "Rsx"
]
detect_files string[]
Default:
[
  "DESCRIPTION"
]
detect_folders string[]
Default:
[
  ".Rproj.user"
]
ruby object
9 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "💎 "
style string
Default: "bold red"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "rb"
]
detect_files string[]
Default:
[
  "Gemfile",
  ".ruby-version"
]
detect_folders string[]
Default:
[]
detect_variables string[]
Default:
[
  "RUBY_VERSION",
  "RBENV_VERSION"
]
rust object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🦀 "
style string
Default: "bold red"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "rs"
]
detect_files string[]
Default:
[
  "Cargo.toml"
]
detect_folders string[]
Default:
[]
scala object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
disabled boolean
Default: false
style string
Default: "red bold"
symbol string
Default: "🆂 "
detect_extensions string[]
Default:
[
  "sbt",
  "scala"
]
detect_files string[]
Default:
[
  ".scalaenv",
  ".sbtenv",
  "build.sbt"
]
detect_folders string[]
Default:
[
  ".metals"
]
shell object
15 nested properties
format string
Default: "[$indicator]($style) "
bash_indicator string
Default: "bsh"
fish_indicator string
Default: "fsh"
zsh_indicator string
Default: "zsh"
powershell_indicator string
Default: "psh"
pwsh_indicator string | null
ion_indicator string
Default: "ion"
elvish_indicator string
Default: "esh"
tcsh_indicator string
Default: "tsh"
nu_indicator string
Default: "nu"
xonsh_indicator string
Default: "xsh"
cmd_indicator string
Default: "cmd"
unknown_indicator string
Default: ""
style string
Default: "white bold"
disabled boolean
Default: true
shlvl object
7 nested properties
threshold integer
Default: 2
format=int64
format string
Default: "[$symbol$shlvl]($style) "
symbol string
Default: "↕️ "
repeat boolean
Default: false
repeat_offset integer
Default: 0
format=uint64min=0
style string
Default: "bold yellow"
disabled boolean
Default: true
singularity object
4 nested properties
symbol string
Default: ""
format string
Default: "[$symbol\[$env\]]($style) "
style string
Default: "blue bold dimmed"
disabled boolean
Default: false
solidity object
9 nested properties
format string
Default: "via [$symbol($version)]($style)"
version_format string
Default: "v${major}.${minor}.${patch}"
disabled boolean
Default: false
style string
Default: "bold blue"
symbol string
Default: "S "
compiler string | string[]
detect_extensions string[]
Default:
[
  "sol"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
spack object
5 nested properties
truncation_length integer
Default: 1
format=uintmin=0
format string
Default: "via [$symbol$environment]($style) "
symbol string
Default: "🅢 "
style string
Default: "blue bold"
disabled boolean
Default: false
status object
17 nested properties
format string
Default: "[$symbol$status]($style) "
symbol string
Default: "❌"
success_symbol string
Default: ""
not_executable_symbol string
Default: "🚫"
not_found_symbol string
Default: "🔍"
sigint_symbol string
Default: "🧱"
signal_symbol string
Default: "⚡"
style string
Default: "bold red"
success_style string | null
failure_style string | null
map_symbol boolean
Default: false
recognize_signal_code boolean
Default: true
pipestatus boolean
Default: false
pipestatus_separator string
Default: "|"
pipestatus_format string
Default: "\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style) "
pipestatus_segment_format string | null
disabled boolean
Default: true
sudo object
5 nested properties
format string
Default: "[as $symbol]($style)"
symbol string
Default: "🧙 "
style string
Default: "bold blue"
allow_windows boolean
Default: false
disabled boolean
Default: true
swift object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🐦 "
style string
Default: "bold 202"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "swift"
]
detect_files string[]
Default:
[
  "Package.swift"
]
detect_folders string[]
Default:
[]
terraform object
9 nested properties
format string
Default: "via [$symbol$workspace]($style) "
version_format string
Default: "v${raw}"
symbol string
Default: "💠 "
style string
Default: "bold 105"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "tf",
  "tfplan",
  "tfstate"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[
  ".terraform"
]
commands string[][]
Default:
[
  [
    "terraform",
    "version"
  ],
  [
    "tofu",
    "version"
  ]
]
time object
7 nested properties
format string
Default: "at [$time]($style) "
style string
Default: "bold yellow"
use_12hr boolean
Default: false
time_format string | null
disabled boolean
Default: true
utc_time_offset string
Default: "local"
time_range string
Default: "-"
typst object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "t "
style string
Default: "bold #0093A7"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "typ"
]
detect_files string[]
Default:
[
  "template.typ"
]
detect_folders string[]
Default:
[]
username object
7 nested properties
detect_env_vars string[]
Default:
[]
format string
Default: "[$user]($style) in "
style_root string
Default: "red bold"
style_user string
Default: "yellow bold"
show_always boolean
Default: false
disabled boolean
Default: false
aliases Record<string, string>
Default:
{}
vagrant object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⍱ "
style string
Default: "cyan bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "Vagrantfile"
]
detect_folders string[]
Default:
[]
vcsh object
4 nested properties
symbol string
Default: ""
style string
Default: "bold yellow"
format string
Default: "vcsh [$symbol$repo]($style) "
disabled boolean
Default: false
vlang object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "V "
style string
Default: "blue bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "v"
]
detect_files string[]
Default:
[
  "v.mod",
  "vpkg.json",
  ".vpkg-lock.json"
]
detect_folders string[]
Default:
[]
xmake object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "△ "
style string
Default: "bold green"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "xmake.lua"
]
detect_folders string[]
Default:
[]
zig object
8 nested properties
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "↯ "
style string
Default: "bold yellow"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "zig"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
custom Record<string, object>
Default:
{}

Definitions

AwsConfig object

The aws module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the AWS_REGION, AWS_DEFAULT_REGION, and AWS_PROFILE env vars and the ~/.aws/config and ~/.aws/credentials files as required.

The module will display a profile only if its credentials are present in ~/.aws/credentials or if a credential_process or sso_start_url are defined in ~/.aws/config. Alternatively, having any of the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, or AWS_SESSION_TOKEN env vars defined will also suffice. If the option force_display is set to true, all available information will be displayed even if no credentials per the conditions above are detected.

When using aws-vault the profile is read from the AWS_VAULT env var and the credentials expiration date is read from the AWS_SESSION_EXPIRATION or AWS_CREDENTIAL_EXPIRATION var.

When using awsu the profile is read from the AWSU_PROFILE env var.

When using AWSume the profile is read from the AWSUME_PROFILE env var and the credentials expiration date is read from the AWSUME_EXPIRATION env var.

When using aws-sso-cli the profile is read from the AWS_SSO_PROFILE env var.

format string

The format for the module.

Default: "on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)"
symbol string

The symbol used before displaying the current AWS profile.

Default: "☁️ "
style string

The style for the module.

Default: "bold yellow"
disabled boolean

Disables the AWS module.

Default: false
region_aliases Record<string, string>

Table of region aliases to display in addition to the AWS name.

Default:
{}
profile_aliases Record<string, string>

Table of profile aliases to display in addition to the AWS name.

Default:
{}
expiration_symbol string

The symbol displayed when the temporary credentials have expired.

Default: "X"
force_display boolean

If true displays info even if credentials, credential_process or sso_start_url have not been setup.

Default: false
AzureConfig object
format string
Default: "on [$symbol($subscription)]($style) "
symbol string
Default: "󰠅 "
style string
Default: "blue bold"
disabled boolean
Default: true
subscription_aliases Record<string, string>
Default:
{}
BatteryConfig object
full_symbol string
Default: "󰁹 "
charging_symbol string
Default: "󰂄 "
discharging_symbol string
Default: "󰂃 "
unknown_symbol string
Default: "󰁽 "
empty_symbol string
Default: "󰂎 "
display BatteryDisplayConfig[]
Default:
[
  {
    "threshold": 10,
    "style": "red bold",
    "charging_symbol": null,
    "discharging_symbol": null
  }
]
disabled boolean
Default: false
format string
Default: "[$symbol$percentage]($style) "
BatteryDisplayConfig object
threshold integer
Default: 10
format=int64
style string
Default: "red bold"
charging_symbol string | null
Default: null
discharging_symbol string | null
Default: null
BufConfig object
format string
Default: "with [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🐃 "
style string
Default: "bold blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "buf.yaml",
  "buf.gen.yaml",
  "buf.work.yaml"
]
detect_folders string[]
Default:
[]
BunConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🥟 "
style string
Default: "bold red"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "bun.lock",
  "bun.lockb",
  "bunfig.toml"
]
detect_folders string[]
Default:
[]
CcConfig object
format string
Default: "via [$symbol($version(-$name) )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "149 bold"
symbol string
Default: "C "
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "c",
  "h"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
commands string[][]
Default:
[
  [
    "cc",
    "--version"
  ],
  [
    "gcc",
    "--version"
  ],
  [
    "clang",
    "--version"
  ]
]
CharacterConfig object
format string
Default: "$symbol "
success_symbol string
Default: "[❯](bold green)"
error_symbol string
Default: "[❯](bold red)"
vimcmd_symbol string
Default: "[❮](bold green)"
vimcmd_visual_symbol string
Default: "[❮](bold yellow)"
vimcmd_replace_symbol string
Default: "[❮](bold purple)"
vimcmd_replace_one_symbol string
Default: "[❮](bold purple)"
disabled boolean
Default: false
CMakeConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "△ "
style string
Default: "bold blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "CMakeLists.txt",
  "CMakeCache.txt"
]
detect_folders string[]
Default:
[]
CmdDurationConfig object
min_time integer
Default: 2000
format=int64
format string
Default: "took [$duration]($style) "
style string
Default: "yellow bold"
show_milliseconds boolean
Default: false
disabled boolean
Default: false
show_notifications boolean
Default: false
min_time_to_notify integer
Default: 45000
format=int64
notification_timeout integer | null
format=uint32min=0
CobolConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⚙️ "
style string
Default: "bold blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "cbl",
  "cob",
  "CBL",
  "COB"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
CondaConfig object
truncation_length integer
Default: 1
format=uintmin=0
format string
Default: "via [$symbol$environment]($style) "
symbol string
Default: "🅒 "
style string
Default: "green bold"
ignore_base boolean
Default: true
detect_env_vars string[]
Default:
[
  "!PIXI_ENVIRONMENT_NAME"
]
disabled boolean
Default: false
ContainerConfig object
format string
Default: "[$symbol \[$name\]]($style) "
symbol string
Default: "⬢"
style string
Default: "red bold dimmed"
disabled boolean
Default: false
CrystalConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🔮 "
style string
Default: "bold red"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "cr"
]
detect_files string[]
Default:
[
  "shard.yml"
]
detect_folders string[]
Default:
[]
DamlConfig object
symbol string
Default: "Λ "
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "bold cyan"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "daml.yaml"
]
detect_folders string[]
Default:
[]
DartConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🎯 "
style string
Default: "bold blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "dart"
]
detect_files string[]
Default:
[
  "pubspec.yaml",
  "pubspec.yml",
  "pubspec.lock"
]
detect_folders string[]
Default:
[
  ".dart_tool"
]
DenoConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🦕 "
style string
Default: "green bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "deno.json",
  "deno.jsonc",
  "deno.lock",
  "mod.ts",
  "deps.ts",
  "mod.js",
  "deps.js"
]
detect_folders string[]
Default:
[]
DirectoryConfig object
truncation_length integer
Default: 3
format=int64
truncate_to_repo boolean
Default: true
substitutions Record<string, string>
Default:
{}
fish_style_pwd_dir_length integer
Default: 0
format=int64
use_logical_path boolean
Default: true
format string
Default: "[$path]($style)[$read_only]($read_only_style) "
repo_root_format string
Default: "[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "
style string
Default: "cyan bold"
repo_root_style string | null
Default: null
before_repo_root_style string | null
Default: null
disabled boolean
Default: false
read_only string
Default: "🔒"
read_only_style string
Default: "red"
truncation_symbol string
Default: ""
home_symbol string
Default: "~"
use_os_path_sep boolean
Default: true
DirenvConfig object
format string
Default: "[$symbol$loaded/$allowed]($style) "
symbol string
Default: "direnv "
style string
Default: "bold bright-yellow"
disabled boolean
Default: true
detect_extensions string[]
Default:
[]
detect_env_vars string[]
Default:
[
  "DIRENV_FILE"
]
detect_files string[]
Default:
[
  ".envrc"
]
detect_folders string[]
Default:
[]
allowed_msg string
Default: "allowed"
not_allowed_msg string
Default: "not allowed"
denied_msg string
Default: "denied"
loaded_msg string
Default: "loaded"
unloaded_msg string
Default: "not loaded"
DockerContextConfig object
symbol string
Default: "🐳 "
style string
Default: "blue bold"
format string
Default: "via [$symbol$context]($style) "
only_with_files boolean
Default: true
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "compose.yml",
  "compose.yaml",
  "docker-compose.yml",
  "docker-compose.yaml",
  "Dockerfile"
]
detect_folders string[]
Default:
[]
DotnetConfig object
format string
Default: "via [$symbol($version )(🎯 $tfm )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: ".NET "
style string
Default: "blue bold"
heuristic boolean
Default: true
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "csproj",
  "fsproj",
  "xproj"
]
detect_files string[]
Default:
[
  "global.json",
  "project.json",
  "Directory.Build.props",
  "Directory.Build.targets",
  "Packages.props"
]
detect_folders string[]
Default:
[]
ElixirConfig object
format string
Default: "via [$symbol($version \(OTP $otp_version\) )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "💧 "
style string
Default: "bold purple"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "mix.exs"
]
detect_folders string[]
Default:
[]
ElmConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🌳 "
style string
Default: "cyan bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "elm"
]
detect_files string[]
Default:
[
  "elm.json",
  "elm-package.json",
  ".elm-version"
]
detect_folders string[]
Default:
[
  "elm-stuff"
]
EnvVarConfig object
symbol string
Default: ""
style string
Default: "black bold dimmed"
variable string | null
default string | null
format string
Default: "with [$env_value]($style) "
disabled boolean
Default: false
description string
Default: "<env_var module>"
ErlangConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: " "
style string
Default: "bold red"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "rebar.config",
  "erlang.mk"
]
detect_folders string[]
Default:
[]
FennelConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🧅 "
style string
Default: "bold green"
disabled boolean
Default: true
detect_extensions string[]
Default:
[
  "fnl"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
FillConfig object
style string
Default: "bold black"
symbol string
Default: "."
disabled boolean
Default: false
FortranConfig object
format string
Default: "via [$symbol($version(-$name) )]($style)"
version_format string
Default: "${raw}"
symbol string
Default: "🅵 "
style string
Default: "bold purple"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "f",
  "F",
  "for",
  "FOR",
  "ftn",
  "FTN",
  "f77",
  "F77",
  "f90",
  "F90",
  "f95",
  "F95",
  "f03",
  "F03",
  "f08",
  "F08",
  "f18",
  "F18"
]
detect_files string[]
Default:
[
  "fpm.toml"
]
detect_folders string[]
Default:
[]
commands string[][]
Default:
[
  [
    "gfortran",
    "--version"
  ],
  [
    "flang",
    "--version"
  ],
  [
    "flang-new",
    "--version"
  ]
]
FossilBranchConfig object
format string
Default: "on [$symbol$branch]($style) "
symbol string
Default: " "
style string
Default: "bold purple"
truncation_length integer
Default: 9223372036854775807
format=int64
truncation_symbol string
Default: "…"
disabled boolean
Default: true
FossilMetricsConfig object
format string
Default: "([+$added]($added_style) )([-$deleted]($deleted_style) )"
added_style string
Default: "bold green"
deleted_style string
Default: "bold red"
only_nonzero_diffs boolean
Default: true
disabled boolean
Default: true
GcloudConfig object
format string
Default: "on [$symbol$account(@$domain)(\($region\))]($style) "
symbol string
Default: "☁️ "
style string
Default: "bold blue"
disabled boolean
Default: false
region_aliases Record<string, string>
Default:
{}
project_aliases Record<string, string>
Default:
{}
detect_env_vars string[]
Default:
[]
GitBranchConfig object
format string
Default: "on [$symbol$branch(:$remote_branch)]($style) "
symbol string
Default: " "
style string
Default: "bold purple"
truncation_length integer
Default: 9223372036854775807
format=int64
truncation_symbol string
Default: "…"
only_attached boolean
Default: false
always_show_remote boolean
Default: false
ignore_branches string[]
Default:
[]
ignore_bare_repo boolean
Default: false
disabled boolean
Default: false
GitCommitConfig object
commit_hash_length integer
Default: 7
format=uintmin=0
format string
Default: "[\($hash$tag\)]($style) "
style string
Default: "green bold"
only_detached boolean
Default: true
disabled boolean
Default: false
tag_symbol string
Default: " 🏷 "
tag_disabled boolean
Default: true
tag_max_candidates integer
Default: 0
format=uintmin=0
GitMetricsConfig object
added_style string
Default: "bold green"
deleted_style string
Default: "bold red"
only_nonzero_diffs boolean
Default: true
format string
Default: "([+$added]($added_style) )([-$deleted]($deleted_style) )"
disabled boolean
Default: true
ignore_submodules boolean
Default: false
GitStateConfig object
rebase string
Default: "REBASING"
merge string
Default: "MERGING"
revert string
Default: "REVERTING"
cherry_pick string
Default: "CHERRY-PICKING"
bisect string
Default: "BISECTING"
am string
Default: "AM"
am_or_rebase string
Default: "AM/REBASE"
style string
Default: "bold yellow"
format string
Default: "\([$state( $progress_current/$progress_total)]($style)\) "
disabled boolean
Default: false
GitStatusConfig object
format string
Default: "([\[$all_status$ahead_behind\]]($style) )"
style string
Default: "red bold"
stashed string
Default: "\$"
ahead string
Default: "⇡"
behind string
Default: "⇣"
up_to_date string
Default: ""
diverged string
Default: "⇕"
conflicted string
Default: "="
deleted string
Default: "✘"
renamed string
Default: "»"
modified string
Default: "!"
staged string
Default: "+"
untracked string
Default: "?"
typechanged string
Default: ""
ignore_submodules boolean
Default: false
disabled boolean
Default: false
use_git_executable boolean
Default: false
windows_starship string | null
GleamConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⭐ "
style string
Default: "bold #FFAFF3"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "gleam"
]
detect_files string[]
Default:
[
  "gleam.toml"
]
detect_folders string[]
Default:
[]
GoConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🐹 "
style string
Default: "bold cyan"
disabled boolean
Default: false
not_capable_style string
Default: "bold red"
detect_extensions string[]
Default:
[
  "go"
]
detect_files string[]
Default:
[
  "go.mod",
  "go.sum",
  "go.work",
  "glide.yaml",
  "Gopkg.yml",
  "Gopkg.lock",
  ".go-version"
]
detect_folders string[]
Default:
[
  "Godeps"
]
GradleConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🅶 "
style string
Default: "bold bright-cyan"
disabled boolean
Default: false
recursive boolean
Default: false
detect_extensions string[]
Default:
[
  "gradle",
  "gradle.kts"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[
  "gradle"
]
GuixShellConfig object
format string
Default: "via [$symbol]($style) "
symbol string
Default: "🐃 "
style string
Default: "yellow bold"
disabled boolean
Default: false
HaskellConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "λ "
style string
Default: "bold purple"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "hs",
  "cabal",
  "hs-boot"
]
detect_files string[]
Default:
[
  "stack.yaml",
  "cabal.project"
]
detect_folders string[]
Default:
[]
HaxeConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⌘ "
style string
Default: "bold fg:202"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "hx",
  "hxml"
]
detect_files string[]
Default:
[
  "haxelib.json",
  "hxformat.json",
  ".haxerc"
]
detect_folders string[]
Default:
[
  ".haxelib",
  "haxe_libraries"
]
HelmConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⎈ "
style string
Default: "bold white"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "helmfile.yaml",
  "Chart.yaml"
]
detect_folders string[]
Default:
[]
HgBranchConfig object
symbol string
Default: " "
style string
Default: "bold purple"
format string
Default: "on [$symbol$branch(:$topic)]($style) "
truncation_length integer
Default: 9223372036854775807
format=int64
truncation_symbol string
Default: "…"
disabled boolean
Default: true
HgStateConfig object
merge string
Default: "MERGING"
rebase string
Default: "REBASING"
update string
Default: "UPDATING"
bisect string
Default: "BISECTING"
shelve string
Default: "SHELVING"
graft string
Default: "GRAFTING"
transplant string
Default: "TRANSPLANTING"
histedit string
Default: "HISTEDITING"
style string
Default: "bold yellow"
format string
Default: "\([$state]($style)\) "
disabled boolean
Default: true
HostnameConfig object
ssh_only boolean
Default: true
ssh_symbol string
Default: "🌐 "
trim_at string
Default: "."
detect_env_vars string[]
Default:
[]
format string
Default: "[$ssh_symbol$hostname]($style) in "
style string
Default: "green dimmed bold"
disabled boolean
Default: false
aliases Record<string, string>
Default:
{}
JavaConfig object
disabled boolean
Default: false
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "red dimmed"
symbol string
Default: "☕ "
detect_extensions string[]
Default:
[
  "java",
  "class",
  "jar",
  "gradle",
  "clj",
  "cljc"
]
detect_files string[]
Default:
[
  "pom.xml",
  "build.gradle.kts",
  "build.sbt",
  ".java-version",
  "deps.edn",
  "project.clj",
  "build.boot",
  ".sdkmanrc"
]
detect_folders string[]
Default:
[]
JobsConfig object
threshold integer
Default: 1
format=int64
symbol_threshold integer
Default: 1
format=int64
number_threshold integer
Default: 2
format=int64
format string
Default: "[$symbol$number]($style) "
symbol string
Default: "✦"
style string
Default: "bold blue"
disabled boolean
Default: false
JuliaConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "ஃ "
style string
Default: "bold purple"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "jl"
]
detect_files string[]
Default:
[
  "Project.toml",
  "Manifest.toml"
]
detect_folders string[]
Default:
[]
KotlinConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🅺 "
style string
Default: "bold blue"
kotlin_binary string
Default: "kotlin"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "kt",
  "kts"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
KubernetesConfig object
symbol string
Default: "☸ "
format string
Default: "[$symbol$context( \($namespace\))]($style) in "
style string
Default: "cyan bold"
disabled boolean
Default: true
context_aliases Record<string, string>
Default:
{}
user_aliases Record<string, string>
Default:
{}
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
detect_env_vars string[]
Default:
[]
contexts KubernetesContextConfig[]
Default:
[]
KubernetesContextConfig object
context_pattern string
Default: ""
user_pattern string | null
Default: null
symbol string | null
Default: null
style string | null
Default: null
context_alias string | null
Default: null
user_alias string | null
Default: null
LineBreakConfig object
disabled boolean
Default: false
LocalipConfig object
ssh_only boolean
Default: true
format string
Default: "[$localipv4]($style) "
style string
Default: "yellow bold"
disabled boolean
Default: true
LuaConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🌙 "
style string
Default: "bold blue"
lua_binary string
Default: "lua"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "lua"
]
detect_files string[]
Default:
[
  ".lua-version"
]
detect_folders string[]
Default:
[
  "lua"
]
MemoryConfig object
threshold integer
Default: 75
format=int64
format string
Default: "via $symbol[$ram( | $swap)]($style) "
style string
Default: "white bold dimmed"
symbol string
Default: "🐏 "
disabled boolean
Default: true
MesonConfig object
truncation_length integer
Default: 4294967295
format=uint32min=0
truncation_symbol string
Default: "…"
format string
Default: "via [$symbol$project]($style) "
symbol string
Default: "⬢ "
style string
Default: "blue bold"
disabled boolean
Default: false
MiseConfig object
format string
Default: "on [$symbol$health]($style) "
symbol string
Default: "mise "
style string
Default: "bold purple"
disabled boolean
Default: true
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "mise.toml",
  "mise.local.toml",
  ".mise.toml",
  ".mise.local.toml"
]
detect_folders string[]
Default:
[
  ".mise"
]
healthy_symbol string
Default: "healthy"
unhealthy_symbol string
Default: "unhealthy"
MojoConfig object
format string
Default: "with [$symbol($version )]($style)"
symbol string
Default: "🔥 "
style string
Default: "bold 208"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "mojo",
  "🔥"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
NatsConfig object
format string
Default: "[$symbol($name )]($style)"
symbol string
Default: "✉️ "
style string
Default: "bold purple"
disabled boolean
Default: true
NetnsConfig object
format string
Default: "[$symbol \[$name\]]($style) "
symbol string
Default: "🛜"
style string
Default: "blue bold dimmed"
disabled boolean
Default: false
NimConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "👑 "
style string
Default: "yellow bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "nim",
  "nims",
  "nimble"
]
detect_files string[]
Default:
[
  "nim.cfg"
]
detect_folders string[]
Default:
[]
NixShellConfig object
format string
Default: "via [$symbol$state( \($name\))]($style) "
symbol string
Default: "❄️ "
style string
Default: "bold blue"
impure_msg string
Default: "impure"
pure_msg string
Default: "pure"
unknown_msg string
Default: ""
disabled boolean
Default: false
heuristic boolean
Default: false
NodejsConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: " "
style string
Default: "bold green"
disabled boolean
Default: false
not_capable_style string
Default: "bold red"
detect_extensions string[]
Default:
[
  "js",
  "mjs",
  "cjs",
  "ts",
  "mts",
  "cts"
]
detect_files string[]
Default:
[
  "package.json",
  ".node-version",
  ".nvmrc",
  "!bunfig.toml",
  "!bun.lock",
  "!bun.lockb"
]
detect_folders string[]
Default:
[
  "node_modules"
]
OCamlConfig object
format string
Default: "via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"
version_format string
Default: "v${raw}"
global_switch_indicator string
Default: ""
local_switch_indicator string
Default: "*"
symbol string
Default: "🐫 "
style string
Default: "bold yellow"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "opam",
  "ml",
  "mli",
  "re",
  "rei"
]
detect_files string[]
Default:
[
  "dune",
  "dune-project",
  "jbuild",
  "jbuild-ignore",
  ".merlin"
]
detect_folders string[]
Default:
[
  "_opam",
  "esy.lock"
]
OdinConfig object
format string
Default: "via [$symbol($version )]($style)"
show_commit boolean
Default: false
symbol string
Default: "Ø "
style string
Default: "bold bright-blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "odin"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
OpaConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🪖 "
style string
Default: "bold blue"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "rego"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
OspConfig object
format string
Default: "on [$symbol$cloud(\($project\))]($style) "
symbol string
Default: "☁️ "
style string
Default: "bold yellow"
disabled boolean
Default: false
OSConfig object
format string
Default: "[$symbol]($style)"
style string
Default: "bold white"
symbols Record<string, string>
Default:
{
  "AIX": "➿ ",
  "Alpaquita": "🔔 ",
  "AlmaLinux": "💠 ",
  "Alpine": "🏔️ ",
  "ALTLinux": "Ⓐ ",
  "Amazon": "🙂 ",
  "Android": "🤖 ",
  "AOSC": "🐱 ",
  "Arch": "🎗️ ",
  "Artix": "🎗️ ",
  "Bluefin": "🐟 ",
  "CachyOS": "🎗️ ",
  "CentOS": "💠 ",
  "Debian": "🌀 ",
  "Elementary": "🍏 ",
  "DragonFly": "🐉 ",
  "Emscripten": "🔗 ",
  "EndeavourOS": "🚀 ",
  "Fedora": "🎩 ",
  "FreeBSD": "😈 ",
  "Garuda": "🦅 ",
  "Gentoo": "🗜️ ",
  "HardenedBSD": "🛡️ ",
  "Illumos": "🐦 ",
  "Ios": "📱 ",
  "InstantOS": "⏲️ ",
  "Kali": "🐉 ",
  "Linux": "🐧 ",
  "Mabox": "📦 ",
  "Macos": "🍎 ",
  "Manjaro": "🥭 ",
  "Mariner": "🌊 ",
  "MidnightBSD": "🌘 ",
  "Mint": "🌿 ",
  "NetBSD": "🚩 ",
  "NixOS": "❄️ ",
  "Nobara": "🎩 ",
  "OpenBSD": "🐡 ",
  "OpenCloudOS": "☁️ ",
  "openEuler": "🦉 ",
  "openSUSE": "🦎 ",
  "OracleLinux": "🦴 ",
  "PikaOS": "🐤 ",
  "Pop": "🍭 ",
  "Raspbian": "🍓 ",
  "Redhat": "🎩 ",
  "RedHatEnterprise": "🎩 ",
  "RockyLinux": "💠 ",
  "Redox": "🧪 ",
  "Solus": "⛵ ",
  "SUSE": "🦎 ",
  "Ubuntu": "🎯 ",
  "Ultramarine": "🔷 ",
  "Unknown": "❓ ",
  "Uos": "🐲 ",
  "Void": " ",
  "Windows": "🪟 ",
  "Zorin": "🔹 "
}
disabled boolean
Default: true
PackageConfig object
format string
Default: "is [$symbol$version]($style) "
symbol string
Default: "📦 "
style string
Default: "208 bold"
display_private boolean
Default: false
disabled boolean
Default: false
version_format string
Default: "v${raw}"
PerlConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🐪 "
style string
Default: "149 bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "pl",
  "pm",
  "pod"
]
detect_files string[]
Default:
[
  "Makefile.PL",
  "Build.PL",
  "cpanfile",
  "cpanfile.snapshot",
  "META.json",
  "META.yml",
  ".perl-version"
]
detect_folders string[]
Default:
[]
PhpConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🐘 "
style string
Default: "147 bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "php"
]
detect_files string[]
Default:
[
  "composer.json",
  ".php-version"
]
detect_folders string[]
Default:
[]
PijulConfig object
symbol string
Default: " "
style string
Default: "bold purple"
format string
Default: "on [$symbol$channel]($style) "
truncation_length integer
Default: 9223372036854775807
format=int64
truncation_symbol string
Default: "…"
disabled boolean
Default: true
PixiConfig object
pixi_binary string | string[]
show_default_environment boolean
Default: true
format string
Default: "via [$symbol($version )(\($environment\) )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🧚 "
style string
Default: "yellow bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "pixi.toml",
  "pixi.lock"
]
detect_folders string[]
Default:
[]
Either string | string[]
PulumiConfig object
format string
Default: "via [$symbol($username@)$stack]($style) "
version_format string
Default: "v${raw}"
symbol string
Default: " "
style string
Default: "bold 5"
disabled boolean
Default: false
search_upwards boolean
Default: true
PureScriptConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "<=> "
style string
Default: "bold white"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "purs"
]
detect_files string[]
Default:
[
  "spago.dhall",
  "spago.yaml",
  "spago.lock"
]
detect_folders string[]
Default:
[]
PythonConfig object
pyenv_version_name boolean
Default: false
pyenv_prefix string
Default: "pyenv "
python_binary string | string[]
format string
Default: "via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "yellow bold"
symbol string
Default: "🐍 "
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "py",
  "ipynb"
]
detect_files string[]
Default:
[
  "requirements.txt",
  ".python-version",
  "pyproject.toml",
  "Pipfile",
  "tox.ini",
  "setup.py",
  "__init__.py"
]
detect_folders string[]
Default:
[]
detect_env_vars string[]
Default:
[
  "VIRTUAL_ENV"
]
QuartoConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⨁ "
style string
Default: "bold #75AADB"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "qmd"
]
detect_files string[]
Default:
[
  "_quarto.yml"
]
detect_folders string[]
Default:
[]
RakuConfig object
format string
Default: "via [$symbol($version-$vm_version )]($style)"
version_format string
Default: "${raw}"
symbol string
Default: "🦋 "
style string
Default: "149 bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "p6",
  "pm6",
  "pod6",
  "raku",
  "rakumod"
]
detect_files string[]
Default:
[
  "META6.json"
]
detect_folders string[]
Default:
[]
RedConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🔺 "
style string
Default: "red bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "red",
  "reds"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
RLangConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
style string
Default: "blue bold"
symbol string
Default: "📐 "
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "R",
  "Rd",
  "Rmd",
  "Rproj",
  "Rsx"
]
detect_files string[]
Default:
[
  "DESCRIPTION"
]
detect_folders string[]
Default:
[
  ".Rproj.user"
]
RubyConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "💎 "
style string
Default: "bold red"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "rb"
]
detect_files string[]
Default:
[
  "Gemfile",
  ".ruby-version"
]
detect_folders string[]
Default:
[]
detect_variables string[]
Default:
[
  "RUBY_VERSION",
  "RBENV_VERSION"
]
RustConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🦀 "
style string
Default: "bold red"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "rs"
]
detect_files string[]
Default:
[
  "Cargo.toml"
]
detect_folders string[]
Default:
[]
ScalaConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
disabled boolean
Default: false
style string
Default: "red bold"
symbol string
Default: "🆂 "
detect_extensions string[]
Default:
[
  "sbt",
  "scala"
]
detect_files string[]
Default:
[
  ".scalaenv",
  ".sbtenv",
  "build.sbt"
]
detect_folders string[]
Default:
[
  ".metals"
]
ShellConfig object
format string
Default: "[$indicator]($style) "
bash_indicator string
Default: "bsh"
fish_indicator string
Default: "fsh"
zsh_indicator string
Default: "zsh"
powershell_indicator string
Default: "psh"
pwsh_indicator string | null
ion_indicator string
Default: "ion"
elvish_indicator string
Default: "esh"
tcsh_indicator string
Default: "tsh"
nu_indicator string
Default: "nu"
xonsh_indicator string
Default: "xsh"
cmd_indicator string
Default: "cmd"
unknown_indicator string
Default: ""
style string
Default: "white bold"
disabled boolean
Default: true
ShLvlConfig object
threshold integer
Default: 2
format=int64
format string
Default: "[$symbol$shlvl]($style) "
symbol string
Default: "↕️ "
repeat boolean
Default: false
repeat_offset integer
Default: 0
format=uint64min=0
style string
Default: "bold yellow"
disabled boolean
Default: true
SingularityConfig object
symbol string
Default: ""
format string
Default: "[$symbol\[$env\]]($style) "
style string
Default: "blue bold dimmed"
disabled boolean
Default: false
SolidityConfig object
format string
Default: "via [$symbol($version)]($style)"
version_format string
Default: "v${major}.${minor}.${patch}"
disabled boolean
Default: false
style string
Default: "bold blue"
symbol string
Default: "S "
compiler string | string[]
detect_extensions string[]
Default:
[
  "sol"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
SpackConfig object
truncation_length integer
Default: 1
format=uintmin=0
format string
Default: "via [$symbol$environment]($style) "
symbol string
Default: "🅢 "
style string
Default: "blue bold"
disabled boolean
Default: false
StatusConfig object
format string
Default: "[$symbol$status]($style) "
symbol string
Default: "❌"
success_symbol string
Default: ""
not_executable_symbol string
Default: "🚫"
not_found_symbol string
Default: "🔍"
sigint_symbol string
Default: "🧱"
signal_symbol string
Default: "⚡"
style string
Default: "bold red"
success_style string | null
failure_style string | null
map_symbol boolean
Default: false
recognize_signal_code boolean
Default: true
pipestatus boolean
Default: false
pipestatus_separator string
Default: "|"
pipestatus_format string
Default: "\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style) "
pipestatus_segment_format string | null
disabled boolean
Default: true
SudoConfig object
format string
Default: "[as $symbol]($style)"
symbol string
Default: "🧙 "
style string
Default: "bold blue"
allow_windows boolean
Default: false
disabled boolean
Default: true
SwiftConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "🐦 "
style string
Default: "bold 202"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "swift"
]
detect_files string[]
Default:
[
  "Package.swift"
]
detect_folders string[]
Default:
[]
TerraformConfig object
format string
Default: "via [$symbol$workspace]($style) "
version_format string
Default: "v${raw}"
symbol string
Default: "💠 "
style string
Default: "bold 105"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "tf",
  "tfplan",
  "tfstate"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[
  ".terraform"
]
commands string[][]
Default:
[
  [
    "terraform",
    "version"
  ],
  [
    "tofu",
    "version"
  ]
]
TimeConfig object
format string
Default: "at [$time]($style) "
style string
Default: "bold yellow"
use_12hr boolean
Default: false
time_format string | null
disabled boolean
Default: true
utc_time_offset string
Default: "local"
time_range string
Default: "-"
TypstConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "t "
style string
Default: "bold #0093A7"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "typ"
]
detect_files string[]
Default:
[
  "template.typ"
]
detect_folders string[]
Default:
[]
UsernameConfig object
detect_env_vars string[]
Default:
[]
format string
Default: "[$user]($style) in "
style_root string
Default: "red bold"
style_user string
Default: "yellow bold"
show_always boolean
Default: false
disabled boolean
Default: false
aliases Record<string, string>
Default:
{}
VagrantConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "⍱ "
style string
Default: "cyan bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "Vagrantfile"
]
detect_folders string[]
Default:
[]
VcshConfig object
symbol string
Default: ""
style string
Default: "bold yellow"
format string
Default: "vcsh [$symbol$repo]($style) "
disabled boolean
Default: false
VConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "V "
style string
Default: "blue bold"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "v"
]
detect_files string[]
Default:
[
  "v.mod",
  "vpkg.json",
  ".vpkg-lock.json"
]
detect_folders string[]
Default:
[]
XMakeConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "△ "
style string
Default: "bold green"
disabled boolean
Default: false
detect_extensions string[]
Default:
[]
detect_files string[]
Default:
[
  "xmake.lua"
]
detect_folders string[]
Default:
[]
ZigConfig object
format string
Default: "via [$symbol($version )]($style)"
version_format string
Default: "v${raw}"
symbol string
Default: "↯ "
style string
Default: "bold yellow"
disabled boolean
Default: false
detect_extensions string[]
Default:
[
  "zig"
]
detect_files string[]
Default:
[]
detect_folders string[]
Default:
[]
CustomConfig object
format string
Default: "[$symbol($output )]($style)"
symbol string
Default: ""
command string
Default: ""
when boolean | string
require_repo boolean
Default: false
shell string | string[]
description string
Default: "<custom config>"
style string
Default: "green bold"
disabled boolean
Default: false
detect_files string[]
Default:
[]
detect_extensions string[]
Default:
[]
detect_folders string[]
Default:
[]
os string | null
use_stdin boolean | null
ignore_timeout boolean
Default: false
unsafe_no_escape boolean
Default: false
Either2 boolean | string