Documentation menu

Documentation

Documentation

herdr-plus is a free, open-source herdr plugin that adds Quick Actions and Projects to your terminal multiplexer.

herdr-plus is an add-on for herdr, built as a first-class herdr plugin. It is free and open source, built by Cloudmanic Labs.

The mental model

You install herdr-plus once with herdr plugin install. herdr clones the repo, builds it, and registers the plugin’s actions with herdr. From then on you run those actions — from herdr’s action menu, or from a key you bind to them — and they spring to life inside herdr.

Two actions ship today:

Action idWhat it does
cloudmanic.herdr-plus.projectsOpens a full-screen fuzzy browser of your Projects — declarative templates that spin up a whole herdr workspace.
cloudmanic.herdr-plus.quick-actionsOpens the Quick Actions launcher — a fuzzy finder that runs a one-off action in the directory you launched from.

Everything herdr-plus does is driven by plain TOML files you own, kept in herdr’s managed plugin config directory. We expect the list of features to grow.

Where to start

  • Quick Start — the fastest path from zero to a working keybinding.
  • Installation — installing the plugin, the optional standalone binary, and how upgrades work.
  • Projects — declarative workspace templates that spin up a whole herdr workspace of tabs and panes.
  • Quick Actions — the fuzzy launcher and per-project actions.
  • Worktree Auto-Layout — auto-open a tab layout whenever herdr creates a matching git worktree, with a per-layout on/off switch.

If you just want the reference, jump to Keybindings, the Actions Reference, Template Variables, Configuration, the Examples & Cookbook, or Troubleshooting.

All pages

10

Quick Start

Go from zero to a working herdr-plus plugin in four steps: install herdr, install the plugin, run an action, and optionally bind a key.

Read
20

Installation

Install herdr-plus as a herdr plugin with herdr plugin install — plus the optional standalone binary, supported platforms, and how upgrades work.

Read
30

Keybindings

Bind herdr keys to herdr-plus's plugin actions with [[keys.command]] entries (type = plugin_action), or just run them from herdr's action menu.

Read
50

Projects

Projects are declarative herdr workspace templates — pick one from a full-screen fuzzy browser and herdr-plus spins up a whole workspace of tabs and panes.

Read
60

Quick Actions

The fuzzy launcher: pick an action and run it in the directory you launched from. Covers global actions and per-project actions shipped in a repo's .herdr-plus directory.

Read
65

Worktree Auto-Layout

Automatically lay a project-style tab layout into a git worktree the moment herdr creates or opens it, driven by the plugin's worktree.created and worktree.opened events.

Read
70

Actions Reference

The complete action file format: the command, command/select/form types, separators and headings, and how the value is passed.

Read
80

Template Variables

Every context field an action's command can use, both as a Go template field and as a HERDR_PLUS_* environment variable.

Read
90

Configuration

The herdr-plus config directory: herdr's managed plugin dir, the projects/, quick-actions/, and worktrees/ subdirs, the file-per-entry model, and per-repo overrides.

Read
100

Examples & Cookbook

A copy-pasteable gallery of complete quick actions and project templates — commands, selects, forms, splits, and context variables.

Read
110

Troubleshooting & FAQ

Concrete fixes for common herdr-plus issues: the plugin not registering, dead keybindings, config not loading, per-project actions, and template errors.

Read