Skip to content
Shepherd
Search
Ctrl
K
Cancel
shepherd.run
↗
GitHub
Select theme
Dark
Light
Auto
shepherd.run
Guides
Getting started
Operating Shepherd
Reference
Configuration
Concepts & glossary
External Task API
Security
Project house rules
CLI reference
Overview
herdr status
herdr update
herdr channel
herdr server
herdr session
API reference
src/activity
Interfaces
ActivityEntry
Variables
MAX_TAIL_BYTES
Functions
latestRecordTs
parseActivity
readTranscriptTail
sessionActivity
src/activity-signal
Interfaces
SessionActivity
Variables
STRIP_WINDOW_MS
Functions
latestMeaningfulSummary
readActivitySignal
readTranscriptSignals
signalFrom
signalFromText
src/auth-config-dir
Variables
CONFIG_FILE
CREDENTIAL_FILE
Functions
apiKeyConfigDir
ensureApiKeyConfigDir
provisionApiKeyConfigDir
src/auth-mode
Type Aliases
AuthMode
Variables
API_KEY_HELPER_FILE
AUTH_MODES
Functions
clearApiKeyHelper
isAuthMode
normalizeAuthModeSetting
readApiKeyHelperPath
spawnAuthSettings
writeApiKeyHelper
src/automerge
Classes
AutoMergeService
Interfaces
AutoMergeDeps
AutoMergeStatus
src/automerge-core
Interfaces
MergeHoldReason
MergeRepoState
MergeSessionView
Type Aliases
MergeDecision
Functions
computeMerge
src/autopilot
Classes
AutopilotService
Interfaces
AutopilotDeps
Variables
CI_CAP_MESSAGE
CI_FIX_STEER
PROCEED_STEER
RESEARCH_PROCEED_STEER
Functions
epicBaseDirective
openPrSteer
src/autopilot-llm
Interfaces
ClassifierDeps
Variables
VERDICT_FILE
Functions
classifierPrompt
classifyStop
preClassify
src/backlog
Classes
CountsService
Interfaces
RepoCounts
Type Aliases
CiStatus
CountsRunner
Functions
countDefinedWorkflows
src/backlog-poller
Classes
BacklogPoller
src/blocked
Interfaces
BlockOption
BlockReason
Type Aliases
BlockShape
Functions
classifyBlocked
hasActiveSpinner
quotaBlockReason
tailLines
src/branch-pruner
Classes
BranchPruner
src/branches
Interfaces
BranchList
Functions
listBranches
src/build-queue-reminder
Classes
BuildQueueReminderService
Variables
RECONCILE_STEER
Functions
isQueueDrifted
src/commands
Interfaces
SlashCommand
Type Aliases
SlashCommandScope
Functions
listCommands
src/completed-epic
Interfaces
CompletedEpic
CompletedEpicChild
Type Aliases
EpicLandingState
Functions
buildRollup
src/config
Interfaces
PreviewPortRangeParams
Variables
BUN_MIN_VERSION
config
DIAGNOSTICS_PROBE_TIMEOUT_MS
DIAGNOSTICS_TTL_MS
DONE_LENS_WINDOW_MS
HERDR_MIN_VERSION
NODE_MIN_VERSION
PLAN_REVIEW_CYCLES_MAX
PLAN_REVIEW_CYCLES_MIN
PR_REVIEW_CYCLES_MAX
PR_REVIEW_CYCLES_MIN
REMEDIATION_TIMEOUT_MS
REVIEWER_SPAWN_RETENTION_MS
SESSION_RETENTION_DAYS
SESSION_RETENTION_KEEP
SESSION_RETENTION_MS
Functions
clampCap
findServedPort
parseHour
parseSandboxProfile
parseServedPort
parseTrimAutoContext
validatePreviewPortRange
src/critic-core
Interfaces
RawVerdict
Variables
CRITIC_THINKING_TOKENS
Functions
buildVerdictCore
captureUsage
defaultComputePatchId
defaultReadVerdict
normalizeDecision
normalizeFindings
prReviewPrompt
reapRun
reviewPrompt
scopeBackstop
scopeFindings
shouldSkipForPatchId
src/default-model
Functions
drainSpawnModel
normalizeDefaultModelSetting
normalizeFableAvailable
normalizeRepoDefaultModelSetting
resolveDefaultModelSetting
spawnModelForAvailability
src/diagnostics
Classes
DiagnosticsService
Interfaces
DiagnosticsDeps
Functions
defaultRunRemediation
src/diff
Functions
computeDiff
parseUnifiedDiff
src/dirs
Interfaces
DirEntry
DirListing
Functions
collapseHome
listDirs
validateRoot
src/distiller
Classes
DistillerService
Interfaces
DistillerDeps
Variables
defaultScratch
DISTILL_LABEL
Functions
normalizeRule
src/doc-agent
Classes
DocAgentService
Interfaces
DocAgentDeps
DocAgentFinalize
DocAgentResult
Type Aliases
DocAgentStatus
Variables
DOC_AGENT_LABEL
Functions
isDocRelevantMerge
src/doc-agent-argv
Functions
docAgentArgv
src/draft-reconcile
Classes
DraftReconcileService
Interfaces
DraftReconcileDeps
DraftReconcileStatus
src/drain
Classes
DrainService
Interfaces
DrainDeps
DrainStatus
QueuedItem
src/drain-core
Interfaces
AutoSessionView
DrainRepoState
HoldReason
Type Aliases
DrainDecision
Variables
ACTIVE_LABEL
PRIORITY_LABEL
Functions
computeNext
selectCandidates
src/effective-autopilot
Functions
effectiveAutopilot
src/egress
Interfaces
EgressBackendProbeDeps
EgressConfig
EgressOverrideDeps
Type Aliases
EgressBackend
Variables
ANTHROPIC_EGRESS_HOSTS
GITHUB_EGRESS_HOSTS
SLIRP_HOST_GATEWAY
Functions
buildEgressAllowlist
buildEgressConfig
detectEgressBackend
detectEgressHostLoopback
egressMembraneOverrideFlags
egressRunnerPath
egressTmpDir
hostMatchesAllowlist
normalizeHost
removeEgressTmp
resetEgressBackendCache
resetEgressHostLoopbackCache
sweepEgressTmp
wrapEgress
writeEgressConfigFiles
src/egress-watch
Classes
EgressWatcher
Interfaces
EgressWatcherDeps
Variables
EGRESS_DROP_CAP
src/epic-branch
Functions
branchReferencesEpic
epicIntegrationBranch
isEpicIntegrationBranch
src/epic-core
Interfaces
Epic
EpicChild
EpicRun
Type Aliases
EpicChildState
EpicMode
EpicRunStatus
EpicSource
Functions
deriveChildState
selectEpicCandidates
src/epic-import
Interfaces
ImportResult
Functions
importEpicLinks
src/epic-landing
Functions
buildLandingPrBody
buildLandingPrTitle
src/epic-migrations
Variables
MIGRATION_GLOBS
Functions
detectMigrationPaths
src/epic-model
Interfaces
AssembleInput
AssembleSession
Functions
assembleEpic
src/epic-parse
Interfaces
EpicEdge
ParsedEpic
Functions
parseEpicBody
src/events
Classes
EventHub
src/forge
Functions
buildIssueUrl
detectForge
forgeFor
src/forge/checks
Functions
jobsFromRollup
mapCheckState
mapGiteaActionStatus
mapStatusState
rollupChecks
src/forge/gitea
Classes
GiteaForge
src/forge/github
Classes
GithubForge
Type Aliases
GhRunner
src/forge/load-config
Functions
loadForgeMap
src/forge/local
Classes
BaseCheckoutBusyError
LocalForge
MergeConflictError
Interfaces
GitVersion
Type Aliases
GitVersionProbe
Variables
MIN_GIT_MAJOR
MIN_GIT_MINOR
Functions
gitVersionAtLeast
mergeTreeWriteTree
parseGitVersion
squashMergeLocal
src/forge/pr-kind
Type Aliases
PrKind
Functions
classifyPr
src/forge/remote
Interfaces
ParsedRemote
Functions
parseRemote
src/forge/resolve
Interfaces
ForgeResolverDeps
Type Aliases
ForgeResolverStore
Functions
makeForgeResolver
makeProductionForgeResolver
src/forge/types
Classes
EmptyDiffError
Interfaces
ForgeConfig
GitForge
GitState
Issue
MergeInput
OpenPrInput
PostReviewInput
PrComment
PrReview
PrReviewMeta
PrStatus
PullRequest
RedeployInput
RollupEntry
SubIssueRef
WorkflowJob
WorkflowRun
Type Aliases
ChecksState
ForgeKind
ForgeMap
MergeMethod
MergeStateStatus
ReviewEvent
Variables
AUTHOR_RESPONSE_MARKER
CRITIC_REVIEW_MARKER
DEPENDABOT_REBASE_COMMAND
src/full-auto
Functions
isFullAuto
src/gitignore-adopt
Classes
GitignoreAdopter
Interfaces
GitignoreAdopterDeps
Type Aliases
AdoptResult
src/held-release
Interfaces
HeldReleaseDeps
Functions
releaseHeldTasks
src/herd-digest
Classes
HerdDigestService
Interfaces
HerdDigestServiceDeps
HerdSnapshots
MergeTrainState
Type Aliases
GenerateResult
Functions
dayKeyFor
src/herdr
Classes
HerdrDriver
HerdrUnavailableError
Interfaces
HerdrAgent
HerdrPane
HerdrTab
Type Aliases
AsyncRunner
Runner
Functions
isNameTakenError
makeHerdrAsyncRunner
makeHerdrRunner
mapState
matchAgent
matchAgents
src/herdr-update
Classes
HerdrUpdateService
Interfaces
HerdrUpdateDeps
HerdrUpdateResult
Variables
UPDATE_LOG_PREFIX
Functions
buildUpdateScript
compareSemver
References
HerdrUpdateStatus
src/hooks-ingest
Classes
HookIngest
Type Aliases
HookEvent
RawHookEvent
SubagentEntry
Functions
validateHookEvent
src/house-rules
Interfaces
HouseRulesPlan
Variables
DAY_MS
HOUSE_RULES_OVERHEAD
HOUSE_RULES_TAG
Functions
envNum
extractTargetPaths
learningMatchesScope
normalizeExtractedPath
normalizeGlob
planHouseRulesInjection
prioritize
renderHouseRulesBlock
sanitizeScopeGlobs
src/instrument
Variables
execFileSync
Functions
logRemainingOnLoopBlockers
markPtyEvent
startLoopLagSampler
timed
timedAsync
src/issue-log
Interfaces
IssueLogDeps
IssueLogEntry
Functions
createIssueLogger
issueLogEntries
src/json-tolerant
Type Aliases
TolerantParse
VerdictAction
VerdictRead
Functions
decideVerdictAction
isSpawnWorking
tolerantParseJson
src/jsonl
Functions
eachJsonlObject
src/learnings-lifecycle
Interfaces
AutoRetireDeps
RetiredRecord
Variables
AUTO_RETIRE_REASON
BASE_RATE_MIN_N
DEFAULT_BASE_RATE
MAX_RETIRE_PER_SWEEP
RETIRE_N_MIN
WILSON_Z
Functions
isGoodOutcome
repoBaseRate
runAutoRetire
shouldRetire
wilsonLowerBound
src/maintenance
Variables
maintenance
src/map-bounded
Functions
mapBounded
src/merge-suggest
Classes
MergeSuggestionService
Interfaces
MergeSuggestionDeps
Variables
defaultMergeScratch
MERGE_LABEL
Functions
crossRepoShortlist
pickSurvivor
src/merge-teardown
Interfaces
MergeTeardownDeps
Functions
settleMergedSession
src/namer
Functions
generateName
isHeuristicNameStrong
normalize
selectWords
slugifyManual
src/namer-llm
Interfaces
LlmNamerDeps
Variables
NAME_FILE
Functions
llmName
namingPrompt
src/node-bin
Interfaces
ResolveNodeOpts
Functions
resolveNodeBin
src/optimizer
Classes
OptimizerService
Interfaces
OptimizerDeps
OptimizerTarget
RawOptimized
Variables
defaultOptimizerScratch
OPTIMIZE_LABEL
src/plan-gate
Classes
PlanGateService
Interfaces
PlanGateServiceDeps
RawAnswer
RawPlanVerdict
ResolvedAnswer
Type Aliases
PlanReviewTrigger
Variables
PLAN_VERDICT_FILE
Functions
planAnswerSteerText
planReviewPrompt
resolvePlanAnswers
reviewerArgv
src/poller
Classes
StatusPoller
Interfaces
LivenessWiring
PreviewWiring
src/pr-poller
Classes
PrPoller
Interfaces
PrCache
Functions
guardStaleTerminal
trustsTerminal
src/presence
Classes
Presence
src/preview
Classes
PreviewService
Interfaces
FsAccessors
PreviewServiceOptions
Functions
detectDevCommand
makeRelayHandlers
pickPrimaryPort
resolveDevPort
rewriteLoopbackLocation
sanitizeCloseCode
src/pricing
Functions
cacheWriteUnits
weightedUnits
src/process-reaper
Classes
ProcessReaper
Interfaces
Leftover
ReaperProbes
Type Aliases
LeftoverKind
Functions
leftoverKey
scanClaudeAliveByWorktree
scanListeningPortsByWorktree
src/project-icons
Functions
loadIcons
setIcon
src/promote
Classes
Promoter
Interfaces
PromoterDeps
Type Aliases
PromoteResult
Variables
LEARNINGS_END
LEARNINGS_START
Functions
extractLearningsBlockRules
upsertLearningsBlock
src/pty-bridge
Classes
PtyBridge
Interfaces
PtySocket
src/pull
Type Aliases
PullResult
Functions
fastForwardDefaultBranch
resolveDefaultBranch
src/push
Classes
PushService
Interfaces
NotifyInput
PushPayload
Type Aliases
SendFn
SendResult
Variables
USAGE_WARN_PCT
Functions
attachCreditsPush
attachGitPush
attachMergePush
attachPush
attachReviewPush
attachUsagePush
blockSummary
buildPayload
src/readiness
Interfaces
GuardrailCheck
ReadinessReport
Type Aliases
GuardrailId
PackageManager
Variables
GUARDRAILS
INSTALL_STEPS
PM_VERBS
Functions
analyzeReadiness
pickPackageManager
src/ready-notify
Classes
ReadyNotifier
Interfaces
ReadyNotifierDeps
Variables
READY_DWELL_MS
READY_WARMUP_MS
src/ready-stage
Functions
isReadyForNotify
src/recap
Classes
RecapService
Interfaces
RecapServiceDeps
Functions
defaultReadVerdict
src/recap-core
Variables
RECAP_DIGEST_MAX_CHARS
RECAP_HEADLINE_MAX
RECAP_VERDICTS
Functions
buildRecapPrompt
buildTranscriptDigest
isSettledIdle
needsRecap
parseRecapVerdict
src/reconcile
Functions
reconcile
src/remediations
Variables
GUIDANCE_ONLY
REMEDIATIONS
Functions
autoFixCommandFor
remediationsFor
src/repo-roles
Interfaces
RepoRoles
Type Aliases
HandoffRole
Functions
annotateHandoff
computeHandoff
normalizeLogin
parseRoles
readRepoRoles
writeRepoRoles
src/repos
Interfaces
RepoEntry
Type Aliases
GhOutRunner
GhRunner
GithubOwners
GithubRepo
Functions
classifyCloneError
classifyForkError
classifyProjectError
cloneRepo
createProject
forkRepo
listGithubOwners
listGithubRepos
listRepos
listReposPathForReal
readTodo
writeTodo
src/review
Classes
ReviewService
Interfaces
ReviewServiceDeps
Type Aliases
ReviewOutcome
References
CRITIC_THINKING_TOKENS
defaultComputePatchId
reviewPrompt
scopeFindings
src/review-status
Type Aliases
AddressStallStatus
Functions
addressStallStatus
src/reviewer-argv
Functions
readonlyReviewerArgv
src/rundown-core
Interfaces
AssembledHerdState
AssembledSession
AssembleInput
ClassifyCaches
Type Aliases
AttentionTier
SignalCode
Variables
MERGE_MARK_BACKSTOP_MS
RUNDOWN_DECISIONS_CAP
RUNDOWN_DEFAULT_TOPN
RUNDOWN_FOCUSNEXT_CAP
RUNDOWN_LABEL_MAX
RUNDOWN_VERDICT_FILE
Functions
assembleHerdState
attentionFingerprint
buildRundownPrompt
classifyAttention
fingerprintDiffCount
isMerging
parseRundownVerdict
src/sandbox
Classes
SandboxAutoRefused
Interfaces
BackendProbeDeps
MembraneInputs
PathProbeDeps
Type Aliases
SandboxBackend
SandboxProfile
Variables
EGRESS_UNAVAILABLE_REASON
SANDBOX_PROFILES
Functions
autoHoldReason
buildMembraneFlags
collectPassthroughEnv
defaultRun
detectBackend
egressApplies
isDegraded
isEgressDegraded
isSandboxProfile
resetBackendCache
resolveProfile
safeRealpath
willEgressConfine
wrapArgv
src/server
Interfaces
AppDeps
BacklogPayload
BacklogPayloadInputs
BacklogProject
Variables
PTY_GONE_CODE
Functions
branchStatusCached
buildBacklogPayload
claimLinkedIssue
clearBranchStatusCacheForTests
isAgentIngressRoute
makeAgentIngressApp
makeApp
serve
serveAgentIngress
src/service
Classes
SessionService
Interfaces
ServiceDeps
Variables
DRAFT_PR_NOTE
MERGE_STALE_MS
PLAN_GATE_DIRECTIVE_AUTO
PLAN_GATE_DIRECTIVE_INTERACTIVE
TRAIN_TRACKER_MAX_MS
Functions
buildHooksFragment
buildQueueDirective
composeSystemPrompt
installedPluginIds
planBlockInstructions
planGoSteer
PREVIEW_START_STEER
readInstalledPluginIds
resetPluginIdsCacheForTests
spawnSettingsOverlay
src/shepherd-exclude
Variables
SHEPHERD_EXCLUDE_END
SHEPHERD_EXCLUDE_START
SHEPHERD_IGNORE_GLOB
Functions
ensureShepherdExclude
excludePath
upsertShepherdIgnoreBlock
src/signals
Functions
attachSignalCapture
src/signoff
Interfaces
SignoffView
Type Aliases
SignoffAuthority
Functions
signedOff
src/spawn-auth
Functions
apiKeyMembraneFields
apiKeyPassthroughEnv
apiKeySettingsFragment
isApiKeyConfigured
isApiKeyMode
__setApiKeyConfigDirProvisionForTest
src/stall
Interfaces
ActivitySnapshot
StallConfig
Variables
DEFAULT_STALL
Functions
isStalled
readSnapshot
snapshotFrom
snapshotFromText
src/standalone-critic
Classes
StandalonePrCriticService
Interfaces
StandalonePrCriticDeps
src/star-prompt
Classes
StarPromptService
Interfaces
StarPromptDeps
StarPromptState
StarPromptStatus
Variables
STAR_ELIGIBLE_AFTER_MS
STAR_SETTING_KEY
STAR_SNOOZE_MS
Functions
computeShouldPrompt
src/steers
Variables
DEFAULT_STEERS
Functions
loadSteers
saveSteers
src/store
Classes
SessionStore
Interfaces
LocalPr
PushPrefs
PushSubInput
RepoConfig
StoredPushSub
src/tab-reaper
Interfaces
ReapResult
ReapWorktreesDeps
ReapWorktreesResult
Type Aliases
ReapableHerdr
Functions
isShepherdHelperLabel
reapOrphanTabs
reapStaleReviewWorktrees
src/tailscale
Classes
TailscaleServeService
Interfaces
TailscaleServeOpts
Type Aliases
ServeState
TailscaleRunner
TailscaleRunnerSync
Functions
resolveNodeHost
src/tmp-sweep
Interfaces
PruneResult
ReapFallowResult
SweepResult
Variables
FALLOW_CACHE_PREFIX
Functions
compileCacheDir
pruneRepoWorktrees
reapFallowCaches
removeWorktreeScratch
sweepClaudeTmp
worktreeScratchDir
src/types
Interfaces
AutopilotVerdict
BuildQueue
BuildStep
BuildStepInput
CreateSessionInput
DiagnosticCheck
DiagnosticsSnapshot
DiffFile
DiffHunk
DiffLine
DiffResult
EvidenceItem
HeldTask
HerdDigest
HerdrUpdateStatus
IssueRef
Learning
MergeSuggestion
MergeSuggestionMember
PlanGate
PrReview
Recap
RelaunchOverrides
ReviewerSpawnRow
ReviewVerdict
RundownItem
RundownVerdict
Session
SessionPreviewEvent
SessionPreviewServeEvent
SessionPreviewState
Signal
Steer
Type Aliases
AutopilotKind
BuildStepStatus
DiagnosticState
DiffFileStatus
DiffLineKind
HerdDigestState
HerdrState
LearningStatus
MergeSuggestionKind
MergeSuggestionStatus
PlanDecision
RecapState
RecapVerdict
ReviewDecision
SessionStatus
SignalKind
Variables
MODELS
src/update
Classes
UpdateService
Interfaces
DeployState
UpdateCommit
UpdateDeps
UpdateStatus
Type Aliases
DeployPhase
GitRunner
src/uploads
Interfaces
UploadDeps
Variables
MAX_UPLOAD_BYTES
STAGING_TTL_MS
Functions
extForMime
handleUpload
moveStagedIntoWorktree
stagingDir
sweepStaging
uploadFilename
worktreeUploadsDir
src/upstream-status
Interfaces
UpstreamStatus
Functions
upstreamStatus
src/usage
Classes
AccountUsageIndex
Interfaces
ParsedRecord
SessionUsage
Functions
accumulate
dashify
dominantModel
jsonlPathFor
parseLine
readSessionUsage
sessionTokens
src/usage-halt
Functions
assistantSideText
classifyHalt
matchesUsageLimit
src/usage-hold
Interfaces
HoldDecisionInput
Functions
shouldHold
src/usage-limits
Classes
UsageLimitsService
Interfaces
CapRow
CapStore
CreditSnapshot
CreditStore
CreditWindow
LimitWindow
ScrapedCredit
ScrapedUsage
ScrapedWindow
UsageLimits
UsageProbe
Type Aliases
WindowKey
Variables
CALIBRATE_INTERVAL_MS
CREDIT_WATCH_INTERVAL_MS
Functions
calibrateDelay
parseCredits
parseMonthlyReset
parseResetLabel
parseUsageFrame
src/usage-probe
Classes
HerdrUsageProbe
Variables
PROBE_NAME
src/validate
Type Aliases
NewProjectInput
Variables
BUILD_STEP_STATUSES
MAX_IMAGES
STEER_MAX
Functions
expandHome
isAuthorized
isValidTerminalId
originAllowed
parseTermDims
safeRepoDir
validateBroadcast
validateBuildSteps
validateBuildStepStatus
validateCloneUrl
validateCreate
validateEgressExtraHosts
validateEpicRunPatch
validateForkTarget
validateIconPatch
validateNewProject
validateRelaunchOverrides
validateRetry
validateSteers
src/verify-key
Interfaces
VerifyKeyDeps
VerifyKeyResult
Variables
AUTH_ERROR_SIGNATURES
SENTINEL
VERIFY_FILE
Functions
matchAuthError
verifyApiKey
src/visual-blocks
Interfaces
DiffAnnotation
FileTreeEntry
PlanQuestion
Type Aliases
CalloutTone
FileTreeChange
QuestionKind
VisualBlock
Variables
CALLOUT_TONES
DIFF_BLOCK_MAX_LINES
FILE_TREE_CHANGES
MERMAID_SOURCE_MAX_CHARS
QUESTION_KINDS
WIREFRAME_HTML_MAX_CHARS
WIREFRAME_SURFACES
Functions
capDiffBlock
groundBlocks
groundPlanBlocks
joinCodeBlocks
joinDiffBlocks
markInferred
parseVisualBlocks
reconcileFileTree
src/worktree
Classes
WorktreeMgr
Interfaces
ResolvedBase
WorktreeResult
shepherd.run
↗
GitHub
Select theme
Dark
Light
Auto
AuthMode
AuthMode
=
"subscription"
|
"api-key"
Defined in:
src/auth-mode.ts:19