craft-hub / CraftHubRuntime

Class: CraftHubRuntime

Defined in: packages/craft-hub/src/runtime.ts:30

Constructors

Constructor

new CraftHubRuntime(options?): CraftHubRuntime

Defined in: packages/craft-hub/src/runtime.ts:52

Parameters

options?

string | CraftHubOptions

Returns

CraftHubRuntime

Properties

agentActions

readonly agentActions: AgentActionService

Defined in: packages/craft-hub/src/runtime.ts:41

---

agentTasks

readonly agentTasks: AgentTaskManager

Defined in: packages/craft-hub/src/runtime.ts:40

---

distribution

readonly distribution: DistributionConfig

Defined in: packages/craft-hub/src/runtime.ts:45

---

gitIntegration

readonly gitIntegration: GitIntegration

Defined in: packages/craft-hub/src/runtime.ts:44

---

ownerScopes

readonly ownerScopes: OwnerScopeService

Defined in: packages/craft-hub/src/runtime.ts:37

---

personalGitSync

readonly personalGitSync: PersonalGitSyncService

Defined in: packages/craft-hub/src/runtime.ts:36

---

pluginManager

readonly pluginManager: PluginManager

Defined in: packages/craft-hub/src/runtime.ts:42

---

projects

readonly projects: ProjectRegistry

Defined in: packages/craft-hub/src/runtime.ts:32

---

releasePlanner

readonly releasePlanner: ReleasePlanner

Defined in: packages/craft-hub/src/runtime.ts:43

---

settings

readonly settings: CraftHubSettingsService

Defined in: packages/craft-hub/src/runtime.ts:33

---

store

readonly store: CraftHubStore

Defined in: packages/craft-hub/src/runtime.ts:31

---

teamGitSync

readonly teamGitSync: TeamGitSyncService

Defined in: packages/craft-hub/src/runtime.ts:38

---

teams

readonly teams: TeamManager

Defined in: packages/craft-hub/src/runtime.ts:39

---

workspaceImports

readonly workspaceImports: WorkspaceImportService

Defined in: packages/craft-hub/src/runtime.ts:35

---

workspaces

readonly workspaces: WorkspaceService

Defined in: packages/craft-hub/src/runtime.ts:34

Methods

addProject()

addProject(path): Promise<ProjectRecord>

Defined in: packages/craft-hub/src/runtime.ts:78

Register a local project path without granting trust.

Parameters

path

string

Returns

Promise<ProjectRecord>

---

applyGitIntegration()

applyGitIntegration(projectId, request): Promise<GitIntegrationResult>

Defined in: packages/craft-hub/src/runtime.ts:120

Recheck and apply a reviewed local Git integration Plan.

Parameters

projectId

string

request

ApplyGitIntegrationRequest

Returns

Promise<GitIntegrationResult>

---

cancelAllRuns()

cancelAllRuns(): Promise<void>

Defined in: packages/craft-hub/src/runtime.ts:311

Stop every active run during application shutdown.

Returns

Promise<void>

---

cancelRun()

cancelRun(runId): Promise<RunRecord>

Defined in: packages/craft-hub/src/runtime.ts:304

Stop an active run and wait for its final record.

Parameters

runId

string

Returns

Promise<RunRecord>

---

capabilities()

capabilities(projectId): Promise<Capability[]>

Defined in: packages/craft-hub/src/runtime.ts:125

Discover the current capabilities for one registered project.

Parameters

projectId

string

Returns

Promise<Capability[]>

---

capabilityDiscovery()

capabilityDiscovery(projectId, requestedLocale?): Promise<CapabilityDiscoveryResult>

Defined in: packages/craft-hub/src/runtime.ts:130

Discover capabilities and non-fatal diagnostics for one registered project.

Parameters

projectId

string

requestedLocale?

"en" | "zh-CN"

Returns

Promise<CapabilityDiscoveryResult>

---

capabilityPins()

capabilityPins(projectId): Promise<CapabilityPins>

Defined in: packages/craft-hub/src/runtime.ts:177

Return the current capability ids represented by this project's machine-local pin order.

Parameters

projectId

string

Returns

Promise<CapabilityPins>

---

cleanupRuns()

cleanupRuns(options): Promise<RunCleanupResult>

Defined in: packages/craft-hub/src/runtime.ts:281

Delete unpinned persisted runs matching the requested retention policy.

Parameters

options

RunCleanupOptions

Returns

Promise<RunCleanupResult>

---

close()

close(): Promise<void>

Defined in: packages/craft-hub/src/runtime.ts:319

Cancel active agent tasks and commands during host shutdown.

Returns

Promise<void>

---

getPluginDiagnostics()

getPluginDiagnostics(): readonly PluginDiagnostic[]

Defined in: packages/craft-hub/src/runtime.ts:207

Diagnostics from the most recent plugin discovery pass.

Returns

readonly PluginDiagnostic[]

---

initializeProjectConfig()

initializeProjectConfig(projectId, mode, expectedRevision?): Promise<ProjectConfigInitializationResult>

Defined in: packages/craft-hub/src/runtime.ts:88

Preview or create one registered project's optional repository-owned configuration.

Parameters

projectId

string

mode

ProjectConfigInitializationMode

expectedRevision?

string

Returns

Promise<ProjectConfigInitializationResult>

---

onRunsChanged()

onRunsChanged(listener): () => void

Defined in: packages/craft-hub/src/runtime.ts:286

Subscribe to execution summary changes.

Parameters

listener

(summary) => void

Returns

() => void

---

pinRun()

pinRun(runId, pinned): Promise<RunRecord>

Defined in: packages/craft-hub/src/runtime.ts:276

Set whether a persisted run is exempt from automatic retention.

Parameters

runId

string

pinned

boolean

Returns

Promise<RunRecord>

---

planGitIntegration()

planGitIntegration(projectId, request?): Promise<GitIntegrationPlan>

Defined in: packages/craft-hub/src/runtime.ts:115

Compute a fresh, side-effect-free Plan for integrating the current local Git branch.

Parameters

projectId

string

request?

GitIntegrationRequest = {}

Returns

Promise<GitIntegrationPlan>

---

previewCommand()

previewCommand(projectId, capabilityId, inputs?): Promise<CommandInvocation>

Defined in: packages/craft-hub/src/runtime.ts:212

Resolve and validate one command invocation without executing it.

Parameters

projectId

string

capabilityId

string

inputs?

CommandInputValues = {}

Returns

Promise<CommandInvocation>

---

projectRunSummaries()

projectRunSummaries(): ProjectRunSummary[]

Defined in: packages/craft-hub/src/runtime.ts:262

Current per-project execution summaries for UI and API consumers.

Returns

ProjectRunSummary[]

---

releasePlan()

releasePlan(projectId, capabilityId, inputs?): Promise<ReleasePlan>

Defined in: packages/craft-hub/src/runtime.ts:224

Compute a fresh release preflight without mutating the repository.

Parameters

projectId

string

capabilityId

string

inputs?

CommandInputValues = {}

Returns

Promise<ReleasePlan>

---

resizeRun()

resizeRun(runId, columns, rows): void

Defined in: packages/craft-hub/src/runtime.ts:297

Resize the pseudo-terminal attached to an active run.

Parameters

runId

string

columns

number

rows

number

Returns

void

---

run()

run(projectId, capabilityId, onOutput?, inputs?): Promise<RunHandle>

Defined in: packages/craft-hub/src/runtime.ts:233

Execute a discovered command capability after rechecking project trust and resolving inputs.

Parameters

projectId

string

capabilityId

string

onOutput?

(event) => void

inputs?

CommandInputValues = {}

Returns

Promise<RunHandle>

---

runs()

runs(): Promise<RunRecord[]>

Defined in: packages/craft-hub/src/runtime.ts:271

List persisted run records.

Returns

Promise<RunRecord[]>

---

unregisterProject()

unregisterProject(projectId): Promise<ProjectRecord>

Defined in: packages/craft-hub/src/runtime.ts:83

Remove a project registration without deleting its directory.

Parameters

projectId

string

Returns

Promise<ProjectRecord>

---

updateCapabilityPins()

updateCapabilityPins(projectId, capabilityIds): Promise<CapabilityPins>

Defined in: packages/craft-hub/src/runtime.ts:192

Replace one project's machine-local pin order after validating every capability id.

Parameters

projectId

string

capabilityIds

string[]

Returns

Promise<CapabilityPins>

---

writeRun()

writeRun(runId, data): void

Defined in: packages/craft-hub/src/runtime.ts:292

Send terminal input to an active run.

Parameters

runId

string

data

string

Returns

void