Starship Prompt Builder

Time module

Shows the current **local** time

When it appears

This module is disabled by default. Enable it, then it renders when Starship detects the matching context.

Preview

Rendered from the starting configuration in a representative simulated environment.

starship — preview
at 09:41:00 

Starting configuration

[time]
disabled = false
format = "at [$time]($style) "
style = "bold yellow"
Open in the builder

The configuration is compressed into the URL fragment and stays in your browser.

Key options

formatstring
The format string for the module.
stylestring
The style for the module time
use_12hrboolean
Enables 12 hour formatting
time_formatstring
The jiff format string used to format the time.
disabledboolean
Disables the time module.
utc_time_offsetstring
Sets the UTC offset to use. Either an IANA time zone name or a range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets.
time_rangestring
Sets the time range during which the module will be shown. Times must be specified in 24-hours format

Format variables

$style
Mirrors the value of option style
$time
The current time.

Common adjustments

  • Edit format to reorder its variables or make surrounding text conditional.
  • Adjust its style options to fit the palette used by the rest of the prompt.