Pane detection

Pane detection lets tpane recognize panes by command, directory, output, or process tree.

Add kind rules yourself, or load the built-in pane detection plugin for a generic fallback label and pane border:

tpane.use("pane-detection")

The built-in plugin labels panes by their foreground command and enables pane border titles.

Kinds

This marks panes running psql as database panes:

tpane.kind { name = "database", match = "psql" }

Jump to the database pane later:

tpane.bind("D", function()
  local db = tpane.find { kind = "database" }
  if db then
    tpane.tmux.select(db.id)
  end
end)

Show the current pane label in the status bar:

local pane_label = tpane.widget(function(ctx)
  return ctx.pane and ctx.pane.label or ""
end)

Match

Use match for a command name:

tpane.kind { name = "editor", match = "nvim" }

Detect

Use detect when the rule needs Lua:

tpane.kind {
  name = "server",
  detect = function(pane)
    return pane:running("node") and pane.cwd:match("/server$") ~= nil
  end,
}

Labels

By default, the label is the kind name. Use label to change it:

tpane.kind {
  name = "editor",
  match = "nvim",
  label = function(pane)
    return "editor " .. pane.cwd_basename
  end,
}

States

A state is a short status attached to a pane.

tpane.kind {
  name = "worker",
  match = "worker",
  state = function(pane)
    local text = pane:capture()
    if text:match("blocked") then return "blocked" end
    if text:match("running") then return "working" end
    return "idle"
  end,
}

Show it in the status bar:

local state = tpane.widget(function(ctx)
  return ctx.pane and ctx.pane.state or ""
end)

Built-in states:

State	Meaning
approval	Waiting for approval.
blocked	Blocked or needs attention.
working	Work is in progress.
done_unseen	Finished, but the pane has not been focused yet.
idle_seen	Finished/idle and already seen.

Add your own state style:

tpane.state("waiting", { color = "yellow", glyph = "…" })

Pane helpers

pane:running("psql")

Checks whether the pane process tree contains psql.

local text = pane:capture()

Reads the visible text in the pane.

tpane.kind {
  name = "test watcher",
  detect = function(pane)
    return pane:proc_tree():any(function(proc)
      return proc.argv:match("--watch") ~= nil
    end)
  end,
}

Checks the pane process tree.