WezTerm Status

https://github.com/yriveiro/wezterm-status
Admin
WezTerm Status is a configurable status bar plugin for WezTerm terminal emulator that displays mode...
Tokens:4,509
Snippets:37
Trust Score:8.4
License:MIT
Update:7 months ago
Show doc for...
Tokens:
Raw
### Install WezTerm Status Plugin

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Installs the wezterm-status plugin using wezterm.plugin.require. This is the initial step to integrate the status bar functionality into your WezTerm configuration.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config)
```

--------------------------------

### Install WezTerm Status Plugin

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Demonstrates the basic installation of the WezTerm Status plugin using the native plugin system. This requires the plugin from the GitHub repository and applies it to the current WezTerm configuration.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

-- Basic installation with default settings
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config)

return config
```

--------------------------------

### Setup WezTerm Status Plugin with Customizations

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Configures the wezterm-status plugin by passing a configuration table to the apply_to_config method. This allows for disabling specific cells like battery or customizing formats, such as the date display.

```lua
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    cells = {
      battery = { enabled = false },
      date = { format = '%H:%M' }
    }
  })
```

--------------------------------

### Configure WezTerm Status Plugin with Lua

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

This Lua code snippet demonstrates how to apply the wezterm-status plugin to your WezTerm configuration. It shows how to set up UI elements like separators and themes, and enable/configure various status cells such as mode, battery, hostname, current working directory, workspace, Kubernetes context, and date.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    ui = {
      separators = {
        arrow_solid_left = ' \u{e0b0}',
        arrow_solid_right = ' \u{e0b2}',
        arrow_thin_left = ' \u{e0b1}',
        arrow_thin_right = ' \u{e0b3}',
      },
      theme = {
        bg_color = '#1e1e2e',  -- Catppuccin base
        fg_color = '#cdd6f4',  -- Catppuccin text
        intensity = 'Normal',
        underline = 'None',
        italic = false,
        strikethrough = false,
      },
    },
    cells = {
      mode = {
        enabled = true,
        modes = {
          normal = ' ' .. wezterm.nerdfonts.cod_home,
          copy_mode = ' ' .. wezterm.nerdfonts.cod_copy,
          search_mode = ' ' .. wezterm.nerdfonts.cod_search,
        },
      },
      battery = {
        enabled = true,
      },
      hostname = {
        enabled = true,
      },
      cwd = {
        enabled = true,
        tilde_prefix = true,
        path_aliases = {
          { pattern = '/home/dev/projects', replacement = '' },
          { pattern = '/home/dev/.config', replacement = '' },
        },
      },
      workspace = {
        enabled = true,
        icon = wezterm.nerdfonts.md_television_guide,
      },
      k8s_context = {
        enabled = true,
        kubectl_path = '/usr/local/bin/kubectl',
      },
      date = {
        enabled = true,
        icon = wezterm.nerdfonts.md_clock_time_three_outline,
        format = '%a %H:%M',
      },
    },
  })

return config

```

--------------------------------

### Configure Current Working Directory

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Configures the CWD cell to display the current path with support for home directory tilde expansion and custom path aliasing. Aliases allow for replacing long paths with shorter, descriptive icons.

```lua
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    cells = {
      cwd = {
        enabled = true,
        -- Replace $HOME with ~
        tilde_prefix = true,
        -- Define path aliases for shortening common paths
        path_aliases = {
          { pattern = '/home/user/development', replacement = '🛠️' },
          { pattern = '/home/user/repos', replacement = '' },
          { pattern = '/home/user/docker', replacement = '🐳' },
          { pattern = '/home/user/.kube', replacement = '☸️' },
        },
      },
    },
  })
```

--------------------------------

### Configure Status Bar UI and Cells

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Shows how to customize the status bar appearance, including separators and theme colors, and toggle specific status cells. This configuration allows for granular control over the UI elements and enabled modules.

```lua
local wezterm = require 'wezterm'
local config = wezterm.config_builder()

wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    ui = {
      separators = {
        arrow_solid_left = ' \u{e0b0}',
        arrow_solid_right = ' \u{e0b2}',
        arrow_thin_left = ' \u{e0b1}',
        arrow_thin_right = ' \u{e0b3}',
      },
      theme = {
        bg_color = '#88C0D0',
        fg_color = '#2E3440',
        intensity = 'Normal',
        underline = 'None',
        italic = false,
        strikethrough = false,
      },
    },
    cells = {
      mode = { enabled = true },
      battery = { enabled = true },
      hostname = { enabled = true },
      cwd = { enabled = true, tilde_prefix = true },
      date = { enabled = true, format = '%H:%M:%S' },
      workspace = { enabled = false },
      k8s_context = { enabled = false },
    },
  })

return config
```

--------------------------------

### Configure Kubernetes Context Display in WezTerm Status

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Enables the display of the current kubectl context. Allows for automatic discovery of the binary or manual specification of a custom path.

```lua
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    cells = {
      k8s_context = {
        enabled = true,
        kubectl_path = '/usr/local/bin/kubectl',
      },
    },
  })
```

--------------------------------

### Configure Status Bar Theme

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Customizes the appearance of the status bar using plugin-specific theme settings or native WezTerm tab bar colors.

```lua
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    ui = {
      theme = {
        bg_color = '#88C0D0',
        fg_color = '#2E3440',
        intensity = 'Normal',
        underline = 'None',
        italic = false,
        strikethrough = false,
      },
    },
  })
```

--------------------------------

### Configure Kubernetes Context for WezTerm Status

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Enables the display of the current Kubernetes context in the WezTerm status bar. It includes an option to specify the path to the kubectl binary if auto-discovery fails.

```lua
cells.k8s_context = {
  enabled = true,
  -- If the current autodiscovery logic doesn't work add kubectl_path
  kubectl_path = '/usr/local/bin/kubectl'
}
```

--------------------------------

### Configure Date and Time Display in WezTerm Status

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Enables and formats the date/time display in the status bar. Supports custom strftime patterns and configurable icons.

```lua
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    cells = {
      date = {
        enabled = true,
        icon = wezterm.nerdfonts.md_clock_time_three_outline,
        format = '%H:%M:%S',
      },
    },
  })
```

--------------------------------

### Configure Battery Status

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Enables the battery status cell, which automatically displays dynamic icons based on the current charge percentage. It supports various states from empty to full.

```lua
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    cells = {
      battery = {
        enabled = true,
      },
    },
  })
```

--------------------------------

### Configure Workspace Display in WezTerm Status

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Enables the display of the current WezTerm workspace name. Useful for organizing and identifying different active projects.

```lua
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    cells = {
      workspace = {
        enabled = true,
        icon = wezterm.nerdfonts.md_television_guide,
      },
    },
  })
```

--------------------------------

### Configure Date/Time Display for WezTerm Status

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Enables and customizes the date and time display in the WezTerm status bar. Users can specify a format string (strftime) and an optional icon.

```lua
cells.date = {
  -- Enable timestamp
  enabled = true,
  -- Clock icon
  icon = wezterm.nerdfonts.md_clock_time_three_outline,
  -- Time format (strftime)
  format = '%H:%M:%S'
}
```

--------------------------------

### Configure Hostname Display for WezTerm Status

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Enables the display of the current machine's hostname in the WezTerm status bar. This provides quick identification of the connected host.

```lua
cells.hostname = {
  -- Enable hostname
  enabled = true
}
```

--------------------------------

### Configure Wezterm Workspace for Status Bar

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Enables the display of the WezTerm workspace in the status bar, optionally including an icon. This helps in managing and identifying different workspace contexts.

```lua
cells.workspace = {
  -- Enable Wezterm Workspace
  enabled = true,
  -- Clock icon
  icon = wezterm.nerdfonts.md_television_guide,
}
```

--------------------------------

### Apply Custom Cell Text Attributes

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Utilizes the internal Cells API to programmatically push and format text with specific attributes like bold, italic, and various underline styles.

```lua
local Cells = require 'cells'
local cells = Cells:new()

cells:push('#88C0D0', '#2E3440', ' Bold Text', { 'Bold' })
cells:push('#88C0D0', '#2E3440', ' Italic Text', { 'Italic' })
cells:push('#88C0D0', '#2E3440', ' Bold Italic', { 'Bold', 'Italic' })
cells:push('#88C0D0', '#2E3440', ' Underlined', { 'Single' })

local format_items = cells:draw()
cells:clear()
```

--------------------------------

### Configure Hostname Display in WezTerm Status

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Enables the display of the current machine's hostname in the status bar. This is useful for identifying the host during SSH sessions or multi-machine workflows.

```lua
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    cells = {
      hostname = {
        enabled = true,
      },
    },
  })
```

--------------------------------

### Configure UI Theme for WezTerm Status

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Sets the visual theme for the WezTerm status bar, including background color, foreground color, and text intensity. It prioritizes WezTerm's built-in tab bar colors if defined, otherwise uses the plugin's configuration.

```lua
ui.theme = {
  bg_color = '#88C0D0',
  fg_color = '#2E3440',
  intensity = 'Normal',
  underline = 'None',
  italic = false,
  strikethrough = false,
}
```

--------------------------------

### Configure Current Working Directory (CWD) for WezTerm Status

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Enables the display of the current working directory in the WezTerm status bar. It supports replacing the home directory prefix with '~' and defining custom path aliases for frequently used directories.

```lua
cells.cwd = {
  -- Enable CWD display
  enabled = true,
  -- Replace $HOME with ~
  tilde_prefix = true,
  -- Path aliases for shortening
  path_aliases = {
    -- Replace long development path with an icon
    { pattern = "/home/user/development", replacement = "🛠️" },
    -- Use git icon for repositories
    { pattern = "/home/user/repos", replacement = "" },
    -- Docker projects
    { pattern = "/home/user/docker", replacement = "🐳" },
    -- Kubernetes configuration
    { pattern = "/home/user/.kube", replacement = "☸️" }
  }
}
```

--------------------------------

### Configure Mode Indicator

Source: https://context7.com/yriveiro/wezterm-status/llms.txt

Configures the mode indicator cell to display custom icons for different WezTerm key table modes. This helps users visually identify whether they are in normal, copy, or search mode.

```lua
wezterm.plugin
  .require('https://github.com/yriveiro/wezterm-status')
  .apply_to_config(config, {
    cells = {
      mode = {
        enabled = true,
        modes = {
          normal = ' ' .. wezterm.nerdfonts.cod_home,
          copy_mode = ' ' .. wezterm.nerdfonts.cod_copy,
          search_mode = ' ' .. wezterm.nerdfonts.cod_search,
        },
      },
    },
  })
```

--------------------------------

### Configure Mode Indicator for WezTerm Status

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Enables and customizes the mode indicator in the WezTerm status bar. It allows mapping different WezTerm modes (normal, copy, search) to specific icons, often from Nerd Fonts.

```lua
cells.mode = {
  -- Enable mode display
  enabled = true,
  -- Map modes to icons
  modes = {
    normal = ' ' .. wezterm.nerdfonts.cod_home,
    copy_mode = ' ' .. wezterm.nerdfonts.cod_copy,
    search_mode = ' ' .. wezterm.nerdfonts.cod_search,
  }
}
```

--------------------------------

### Configure Battery Indicator for WezTerm Status

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Enables the battery status indicator in the WezTerm status bar. The indicator dynamically displays icons based on the current battery charge level.

```lua
cells.battery = {
  -- Enable battery status
  enabled = true
}
```

--------------------------------

### Configure UI Separators for WezTerm Status

Source: https://github.com/yriveiro/wezterm-status/blob/main/README.md

Defines custom separators for the WezTerm status bar, utilizing Powerline-style arrows. These characters enhance the visual separation between different status elements.

```lua
ui.separators = {
  -- Powerline-style arrows
  arrow_solid_left = '\u{e0b0}',
  arrow_solid_right = '\u{e0b2}',
  arrow_thin_left = '\u{e0b1}',
  arrow_thin_right = '\u{e0b3}',
}
```
Tokens:
Raw