Skip to content

CLI Herdr Command

github-actions[bot] edited this page Aug 19, 2026 · 1 revision

ed herdr command

Prints the command that attaches to one Herdr pane.

ed herdr command <pane> [--machine <name>] [--session <name>] [--json]

Arguments

Name Type / values Default What it does
<pane> pane id, for example w3:p1N required The pane to attach to

Options

Name Type / values Default What it does
--machine <name> machine name, alias, UUID, unique prefix, or local all hosts Disambiguate when the same pane id exists on more than one machine
--session <name> Herdr session name all sessions Disambiguate when the same pane id exists in more than one session
--json flag off Emit JSON on stdout

--help is generated by the parser, prints the usage summary on stdout and exits 0.

The human form is one line, and nothing else:

ssh -tt tuf-wired -- herdr --session default agent attach w3:p1N

On this Mac the ssh -tt prefix is omitted:

herdr --session default agent attach w3:p1N

--json shape

{
  "command": "ssh -tt tuf-wired -- herdr --session default agent attach w3:p1N"
}

A pane that is not live, or a pane that matches more than once without --machine or --session, exits 3 with empty stdout. --machine that matches no configured machine also exits 3.

This only prints the line. It does not attach. The Herdr page in Edith opens a PTY with the same command.

Where to go next

CLI reference

Getting Started
Config
App
Extensions
Permissions
Usage
System
Music
Calendar
Clipboard
Color
Download
Apps
Tools
Shelf
Cleaner
Machines
Machines Remote
Machines Docker
Machines Files
Machines Power
Machines Workspace
Companion
Herdr
Lid Awake
Machines Thermal

Guides

Clone this wiki locally