Skip to content

CLI Herdr Ls

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

ed herdr ls

Lists live Herdr panes on this Mac and on every configured SSH machine.

ed herdr ls [--machine <name>] [--json]

Options

Name Type / values Default What it does
--machine <name> machine name, alias, UUID, unique prefix, or local all hosts Only this Mac, or only one SSH machine
--json flag off Emit JSON on stdout

--help is generated by the parser, prints the usage summary on stdout and exits 0. list is an alias for ls.

--json shape

A top-level object with hosts and agents. Host keys are error, herdr, id, local and name. Agent keys are command, cwd, id, kind, local, machine, machineName, pane, session, status, title and workspace. Object keys are sorted. error is null when the host answered.

{
  "agents": [
    {
      "command": "ssh -tt tuf-wired -- herdr --session default agent attach w3:p1N",
      "cwd": "/srv/app",
      "id": "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE|default|w3:p1N",
      "kind": "OpenCode",
      "local": false,
      "machine": "AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
      "machineName": "Asus TUF 7",
      "pane": "w3:p1N",
      "session": "default",
      "status": "working",
      "title": "Build the board",
      "workspace": "edith"
    }
  ],
  "hosts": [
    {
      "error": "herdr is not on PATH",
      "herdr": false,
      "id": "local",
      "local": true,
      "name": "This Mac"
    }
  ]
}

status is one of blocked, working, unknown, done, idle. kind is the label the Herdr page uses: Claude Code, Codex, OpenCode, Cursor Agent, Copilot CLI, or the raw Herdr name if it is none of those.

The human form is a five column table, MACHINE, KIND, STATUS, PANE, TITLE. An empty list prints a note on stderr and nothing on stdout, and still exits 0.

--machine that matches no configured machine exits 3 with empty stdout.

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