Skip to content
Shepherd

DocAgentDeps

Defined in: src/doc-agent.ts:103

Properties

Section titled “Properties”

buildPrompt?

Section titled “buildPrompt?”

optional buildPrompt?: (base) => string

Defined in: src/doc-agent.ts:131

Parameters

Section titled “Parameters”
base
Section titled “base”

string

Returns

Section titled “Returns”

string

dayKey?

Section titled “dayKey?”

optional dayKey?: (now) => string

Defined in: src/doc-agent.ts:120

Local YYYY-MM-DD for now — the nightly once/day key.

Parameters

Section titled “Parameters”
now
Section titled “now”

number

Returns

Section titled “Returns”

string

detectBackend?

Section titled “detectBackend?”

optional detectBackend?: () => SandboxBackend

Defined in: src/doc-agent.ts:122

Returns

Section titled “Returns”

SandboxBackend

fileExists?

Section titled “fileExists?”

optional fileExists?: (p) => boolean

Defined in: src/doc-agent.ts:129

Parameters

Section titled “Parameters”
p
Section titled “p”

string

Returns

Section titled “Returns”

boolean

git?

Section titled “git?”

optional git?: (cwd, args) => Promise<string>

Defined in: src/doc-agent.ts:121

Parameters

Section titled “Parameters”
cwd
Section titled “cwd”

string

args
Section titled “args”

string[]

Returns

Section titled “Returns”

Promise<string>

herdr

Section titled “herdr”

herdr: Pick<HerdrDriver, "start" | "stop" | "list" | "closeTab">

Defined in: src/doc-agent.ts:104

membraneEnv?

Section titled “membraneEnv?”

optional membraneEnv?: () => object

Defined in: src/doc-agent.ts:123

Returns

Section titled “Returns”

object

claudeDir
Section titled “claudeDir”

claudeDir: string

extraEnv?
Section titled “extraEnv?”

optional extraEnv?: Record<string, string>

home
Section titled “home”

home: string

nodeBinReal
Section titled “nodeBinReal”

nodeBinReal: string

model?

Section titled “model?”

optional model?: string | null

Defined in: src/doc-agent.ts:112

nightlyHour?

Section titled “nightlyHour?”

optional nightlyHour?: number

Defined in: src/doc-agent.ts:117

Local hour (0–23) at/after which the nightly sweep evaluates a repo.

now?

Section titled “now?”

optional now?: () => number

Defined in: src/doc-agent.ts:114

Returns

Section titled “Returns”

number

onChange?

Section titled “onChange?”

optional onChange?: (f) => void

Defined in: src/doc-agent.ts:113

Parameters

Section titled “Parameters”
f
Section titled “f”

DocAgentFinalize

Returns

Section titled “Returns”

void

readSentinel?

Section titled “readSentinel?”

optional readSentinel?: (worktreePath) => string | null

Defined in: src/doc-agent.ts:130

Parameters

Section titled “Parameters”
worktreePath
Section titled “worktreePath”

string

Returns

Section titled “Returns”

string | null

repos

Section titled “repos”

repos: () => string[]

Defined in: src/doc-agent.ts:109

Repos to enumerate in the boot orphan-sweep (herdr-independent worktree prune) and the nightly cadence sweep.

Returns

Section titled “Returns”

string[]

resolveForge

Section titled “resolveForge”

resolveForge: (repoPath) => GitForge | null

Defined in: src/doc-agent.ts:106

Parameters

Section titled “Parameters”
repoPath
Section titled “repoPath”

string

Returns

Section titled “Returns”

GitForge | null

store

Section titled “store”

store: Pick<SessionStore, "getSetting" | "setSetting">

Defined in: src/doc-agent.ts:111

Persisted per-repo cadence markers (last-sha / nightly-day / merged-seen).

timeoutMs?

Section titled “timeoutMs?”

optional timeoutMs?: number

Defined in: src/doc-agent.ts:115

worktree

Section titled “worktree”

worktree: Pick<WorktreeMgr, "create" | "remove" | "gitCommonDir" | "ensureBaseRef">

Defined in: src/doc-agent.ts:105