Skip to content

Shell Module

Sam edited this page Aug 7, 2024 · 2 revisions

The shell module displays the name of your current shell.

Using

Insert into the modules array.

Configuration

  • title -> (String) The module title.
  • format -> (String) The format used to display the module. Check below to see available placeholders
  • show_default_shell -> (Bool) Whether to use your default shell, opposed to your current one.
  • title_color -> (Optional/String) Override the title color to be used.
  • title_bold -> (Optional/Bool) Make the title bold.
  • title_italic -> (Optional/Bool) Make the title italic.
  • separator -> (Optional/Char) Override the separator to be used.
format placeholders;
  • {name} -> The name of the shell.
  • {path} -> The executable path of the shell.
  • {version} -> The version of the shell.
Default Configuration
[shell]
title = "Shell"
format = "{name} {version}"
show_default_shell = false

Example

modules = [
    "shell"
]

[shell]
title = "Default Shell"
format = "{name}"
show_default_shell = true