Skip to content

treeman ​

treeman worktree health across all registered repos, in a dropdown.

Add it to your layout with treeman:

yaml
bar:
  layout:
    - monitor: "*"
      right: [treeman]

General ​

FieldTypeDefaultDescription
formatstring"{{ total }}"Format string for the label.
icon-namestring"ld-layers-symbolic"Module icon (shown when every worktree is resting-ready).
icon-preparingstring"ld-loader-circle-symbolic"Icon shown while any worktree is being prepared.
icon-tearing-downstring"ld-trash-2-symbolic"Icon shown while any worktree is being torn down.
icon-failedstring"ld-alert-triangle-symbolic"Icon shown when any worktree's last finalize errored.
hide-if-emptyboolfalseCollapse the module entirely when there are no active worktrees.
border-showboolfalseDisplay border around button.
icon-showbooltrueDisplay module icon.
label-showbooltrueDisplay count label.
label-max-lengthu320Max label characters before truncation with ellipsis. Set to 0 to disable.
More about format

Placeholders ​

  • {{ total }} - Total active worktrees
  • {{ stable }} - Worktrees in the ready bucket
  • {{ up }} - Worktrees preparing
  • {{ down }} - Worktrees tearing down
  • {{ failed }} - Worktrees whose last finalize errored

Examples ​

  • "{{ total }}" - "7"
  • "{{ total }} ({{ failed }}!)" - "7 (1!)"

Colors ​

FieldTypeDefaultDescription
border-colorColorValue"border-accent"Border color token.
icon-colorColorValue"auto"Icon foreground color. Auto selects based on variant for contrast.
icon-bg-colorColorValue"accent"Icon container background color token.
label-colorColorValue"fg-default"Label text color token.
button-bg-colorColorValue"bg-surface-elevated"Button background color token.

Click actions ​

FieldTypeDefaultDescription
left-clickClickAction"dropdown:treeman"Action on left click.
right-clickClickAction""Action on right click.
middle-clickClickAction""Action on middle click.
scroll-upClickAction""Action on scroll up.
scroll-downClickAction""Action on scroll down.

Default configuration ​

yaml
modules:
  treeman:
    format: '{{ total }}'
    icon-name: ld-layers-symbolic
    icon-preparing: ld-loader-circle-symbolic
    icon-tearing-down: ld-trash-2-symbolic
    icon-failed: ld-alert-triangle-symbolic
    hide-if-empty: false
    border-show: false
    border-color: border-accent
    icon-show: true
    icon-color: auto
    icon-bg-color: accent
    label-show: true
    label-color: fg-default
    label-max-length: 0
    button-bg-color: bg-surface-elevated
    left-click: dropdown:treeman
    right-click: ""
    middle-click: ""
    scroll-up: ""
    scroll-down: ""

Released under the MIT License.