Skip to content
Henry Pi Harness
Esc
navigateopen⌘Jpreview
On this page

@henryqw/pi-herdr

Version v0.4.7
Monthly npm downloadsMIT license

Call the Herdr CLI from Node through one thin client. Extension authors share process handling without copying Herdr’s command catalog. Pi users normally install a Herdr companion extension instead.

Install

npm install @henryqw/pi-herdr

Install the Herdr CLI and make herdr available on the calling process’s PATH. Run herdr --version to verify it.

Use

Create a client and run a command. The client returns the parsed response.

import { createHerdrClient } from "@henryqw/pi-herdr";

const herdr = createHerdrClient(pi.exec.bind(pi));
const response = await herdr.json(["agent", "list"], { cwd: ctx.cwd });

For a ready-to-use Pi workflow, see @henryqw/pi-herdr-clone.

API

Surface Type Purpose
exec function Validates string argv and returns the raw process result.
run function Requires a successful exit and returns stdout.
json function Requires a successful exit and parses a JSON object.
hasHerdrErrorCode function Detects structured CLI errors in stdout or stderr.
startPiAgent function Validates and builds the shared agent start --kind pi --pane ... -- boundary. It retries structured agent_pane_busy responses allowed by the caller’s result-aware policy, with a five-attempt limit, and returns the raw final result.

Callers build Pi-specific arguments and validate responses. The client does not mirror the Herdr command catalog. Herdr remains the source of truth for supported commands and response shapes.