Skip to content

Configuration

Copy page

The dashboard can be customized in your .workmux.yaml:

dashboard:
commit: "Commit staged changes with a descriptive message"
merge: "!workmux merge"
preview_size: 60
agent_columns: [number, project, worktree, git, pr, status, time, title]
close_on_jump: true

The commit and merge values are text sent to the agent’s pane. Use the ! prefix to run shell commands (supported by Claude, Gemini, and other agents).

Option Default value Description
commit Commit staged changes with a descriptive message Natural language prompt
merge !workmux merge Shell command via agent
preview_size 60 Preview pane height as percentage (10-90)
agent_columns [number, project, worktree, git, pr, status, time, title] Agents table columns, in display order
close_on_jump true Close the dashboard after a jump

Jumping to an agent or worktree closes the dashboard. This includes Enter, 1-9, Bksp, command-palette jumps, and double-clicking a row. Set close_on_jump: false to keep the dashboard open while moving between agents and worktrees:

dashboard:
close_on_jump: false

The jump still updates the pane history used by Bksp. The p peek action always keeps the dashboard open and does not update pane history. Multiplexers such as Zellij that keep the dashboard open after jumps retain that behavior regardless of this setting.

agent_columns sets which columns the agents table shows and in what order. For example, to read the title first and keep the elapsed time out of the way:

dashboard:
agent_columns: [number, status, title, project, worktree, git, pr, time]
Column Content
number Jump key of the row, shown under the # header
project Project name
worktree Worktree name, with a pane number when it splits
git Branch state, staged and unstaged changes
pr Pull request number and check status
status Agent status icons
time Time since the last status change
title Agent session title

A column left out of the list is not rendered, so agent_columns: [worktree, status, title] gives a table of just those three. Repeating a column has no effect, and an empty list falls back to the default order.

Dropping number hides the jump key, and 1-9 still jump to the first nine rows. The pr column appears only while at least one agent has a pull request or checks to report, wherever it is placed in the list. A trailing title takes the width left over by the other columns; anywhere else it sizes to its content, and the leftover width sits at the right edge of the table.

The preview_size option controls the height of the preview pane as a percentage of the terminal height. A higher value means more space for the preview and less for the table.

You can also adjust the preview size interactively with +/- keys. These adjustments persist across dashboard sessions via tmux variables.

The CLI flag --preview-size (-P) overrides both the config and saved preference for that session.

# Use Claude skill for merge (see skills guide)
dashboard:
merge: "/merge"
# Custom shell commands
dashboard:
merge: "!workmux merge --rebase --notification"
# Natural language prompts
dashboard:
commit: "Create a commit with a conventional commit message"
merge: "Rebase onto main and run workmux merge"

For complex workflows, skills are more powerful than simple prompts or shell commands. A skill can encode detailed, multi-step instructions that the agent follows intelligently.

dashboard:
merge: "/merge"

See the skills guide for the /merge skill you can copy.