Skip to content

net_ip

The host's own IPv4 / IPv6 addresses. Text (default) shows one address for the primary (default-route) interface — kind picks v4 / v6 / first-available; TextBlock / MarkdownTextBlock / Entries list every interface that has an address; Badge flags dual-stack / IPv4 / IPv6-only / no-address.

Kind	Safety	Shapes
cached	Safe	`text`, `text_block`, `markdown_text_block`, `entries`, `badge`

Options

Option	Type	Required	Default	Description
`kind`	"primary" \| "v4" \| "v6"	no	"primary"	Which address the `Text` shape shows for the primary interface. Ignored by `TextBlock` / `MarkdownTextBlock` / `Entries` (which always list every interface) and `Badge`.

Compatible renderers

Shape	Renderers
`text`	`animated_boot`, `animated_figlet_morph`, `animated_postfx`, `animated_scanlines`, `animated_splitflap`, `animated_typewriter`, `animated_wave`, `text_ascii`, `text_plain`
`text_block`	`animated_boot`, `animated_postfx`, `animated_scanlines`, `animated_splitflap`, `animated_wave`, `list_plain`
`markdown_text_block`	`text_markdown`
`entries`	`animated_boot`, `animated_postfx`, `animated_scanlines`, `animated_splitflap`, `animated_wave`, `grid_table`
`badge`	`animated_boot`, `animated_postfx`, `animated_scanlines`, `animated_splitflap`, `animated_wave`, `status_badge`

Preview

`text` via `text_ascii`

▗█  ▟▀▙ ▟▀▙     ▗█  ▗▛▘ ▟▀▙     ▗█      ▟▀▙  ▟█                                 
 █  ▜▄█  ▄▛      █  █▄▖ ▜▄▛      █       ▄▛ ▟▘█                                 
 █   ▗▛ ▟▘▄  ▄   █  █ █ █ █  ▄   █   ▄  ▟▘▄ ▀▀█▘                                
▀▀▀ ▝▀  ▀▀▀  ▀  ▀▀▀ ▝▀▘ ▝▀▘  ▀  ▀▀▀  ▀  ▀▀▀  ▝▀▘

[[widget]]
id = "net_ip"
fetcher = "net_ip"
render = "text_ascii"

`text` via `text_plain`

192.168.1.24

[[widget]]
id = "net_ip"
fetcher = "net_ip"
render = "text_plain"

`text_block` via `list_plain`

lo  127.0.0.1                           
eth0  192.168.1.24, fe80::1ab2

[[widget]]
id = "net_ip"
fetcher = "net_ip"
render = "list_plain"

`markdown_text_block` via `text_markdown`

- lo 127.0.0.1                          
- eth0 192.168.1.24 · fe80::1ab2

[[widget]]
id = "net_ip"
fetcher = "net_ip"
render = "text_markdown"

`entries` via `grid_table`

lo                             127.0.0.1
eth0            192.168.1.24, fe80::1ab2

[[widget]]
id = "net_ip"
fetcher = "net_ip"
render = "grid_table"

`badge` via `status_badge`

● dual-stack

[[widget]]
id = "net_ip"
fetcher = "net_ip"
render = "status_badge"