Starship Prompt Builder

Local IP module

Shows the IPv4 address of the primary network interface

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
192.168.1.100

Starting configuration

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

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

Key options

ssh_onlyboolean
Only show IP address when connected to an SSH session.
formatstring
The format for the module.
stylestring
The style for the module.
disabledboolean
Disables the localip module.

Format variables

$localipv4
Contains the primary IPv4 address
$style
Mirrors the value of option style

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.