Documentation menu

Documentation

Documentation

herdr-plus is a free, open-source extension platform for herdr — add Quick Actions and Projects to your terminal multiplexer.

herdr-plus is an add-on platform for herdr — a place to build extensions and plugins on top of herdr’s terminal panes. It is free and open source, built by Cloudmanic Labs.

The mental model

herdr-plus ships as a single binary. The same binary can run in different modes, and each mode decides what to do when it talks to herdr. You bind a mode to a herdr keybinding, press your prefix plus that key, and the mode springs to life inside herdr.

We’re in explore mode: the list of modes will grow over time. Today there are two.

Modes

Pick a mode with --mode=<slug>. With no flag, the default mode (control) runs.

ModeSlugDefault keyWhat it does
Controlcontrol (default)prefix+upherdr-plus’s home base — a full-screen workspace for driving herdr. First feature: Projects.
Quick Actionsquick-actionsprefix+downA fuzzy launcher: pick an action and run it in a split pane.

Each mode has its own default key, so the two can be installed side by side.

Where to start

  • Quick Start — the fastest path from zero to a working keybinding.
  • Installation — every install method (Homebrew, install script, from source) and how upgrades work.
  • Control Mode & Projects — declarative workspace templates that spin up a whole herdr workspace of tabs and panes.
  • Quick Actions — the fuzzy launcher and per-project actions.

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

All pages

10

Quick Start

Go from zero to a working herdr-plus keybinding in four steps: install herdr, install herdr-plus, bind a key, press it.

Read
20

Installation

Install herdr-plus via Homebrew, the install.sh one-liner, or from source — with supported platforms, install locations, and upgrades.

Read
30

Keybindings

How herdr-plus install binds a herdr key to a mode: per-mode defaults, overriding the key, idempotency, and how to trigger an action.

Read
40

Modes

One herdr-plus binary, multiple modes. How --mode works, the available modes, and how to invoke each.

Read
50

Control Mode & Projects

Control mode opens a full-screen Herdr Plus workspace with the Projects browser — declarative templates that spin up a whole herdr workspace.

Read
60

Quick Actions Mode

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

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 layout: projects/, quick-actions/, the file-per-entry model, per-repo overrides, and XDG_CONFIG_HOME.

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 the common herdr-plus issues: dead keybindings, command not found, key conflicts, config not loading, and template errors.

Read