LocalForge
Defined in: src/forge/local.ts:292
Local-only forge (#807, lightweight repo mode): drives a repo with local git
only — no remote, no gh. Completion squash-merges the branch into its base
locally. Deliberately implements only the GitForge methods that make sense
without a host; every optional method is OMITTED so forge-only features
(drain claims, epics, standalone critic, fork UI, deploy) self-disable.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LocalForge(
repoPath,store,versionProbe?):LocalForge
Defined in: src/forge/local.ts:299
Parameters
Section titled “Parameters”repoPath
Section titled “repoPath”string
Pick<SessionStore, "ensureLocalPr" | "getLocalPr" | "getLocalPrByNumber" | "markLocalPrMerged">
versionProbe?
Section titled “versionProbe?”GitVersionProbe = defaultVersionProbe
Returns
Section titled “Returns”LocalForge
Properties
Section titled “Properties”deployWorkflow
Section titled “deployWorkflow”
readonlydeployWorkflow:null=null
Defined in: src/forge/local.ts:296
Configured deploy workflow filename, or null if redeploy is unavailable.
Implementation of
Section titled “Implementation of”
readonlykind:"local"
Defined in: src/forge/local.ts:293
Implementation of
Section titled “Implementation of”mergeMethod
Section titled “mergeMethod”
readonlymergeMethod:MergeMethod="squash"
Defined in: src/forge/local.ts:295
Default merge method for this host (from config; “squash” if unset).
Implementation of
Section titled “Implementation of”repoPath
Section titled “repoPath”
readonlyrepoPath:string
Defined in: src/forge/local.ts:300
readonlyslug:null=null
Defined in: src/forge/local.ts:294
Implementation of
Section titled “Implementation of”webUrl
Section titled “webUrl”
readonlywebUrl:null=null
Defined in: src/forge/local.ts:297
Repo’s web home page (e.g. https://github.com/owner/repo); null when unbuildable; absent → null.
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”defaultBranch()
Section titled “defaultBranch()”defaultBranch():
Promise<string>
Defined in: src/forge/local.ts:316
The repo’s default branch name (the promote PR’s base).
Returns
Section titled “Returns”Promise<string>
Implementation of
Section titled “Implementation of”listIssues()
Section titled “listIssues()”listIssues():
Promise<Issue[]>
Defined in: src/forge/local.ts:308
Returns
Section titled “Returns”Promise<Issue[]>
Implementation of
Section titled “Implementation of”listPullRequests()
Section titled “listPullRequests()”listPullRequests():
Promise<PullRequest[]>
Defined in: src/forge/local.ts:312
Open PRs for the backlog PRs tab (newest first), capped server-side.
Returns
Section titled “Returns”Promise<PullRequest[]>
Implementation of
Section titled “Implementation of”merge()
Section titled “merge()”merge(
prNumber):Promise<void>
Defined in: src/forge/local.ts:393
Parameters
Section titled “Parameters”prNumber
Section titled “prNumber”number
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”openPr()
Section titled “openPr()”openPr(
o):Promise<PrStatus>
Defined in: src/forge/local.ts:372
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<PrStatus>
Implementation of
Section titled “Implementation of”postReview()
Section titled “postReview()”postReview():
Promise<{url?:string; }>
Defined in: src/forge/local.ts:400
Post a critic review (request-changes / comment) on a PR. Returns the review’s URL when the host provides one.
Returns
Section titled “Returns”Promise<{ url?: string; }>
Implementation of
Section titled “Implementation of”prStatus()
Section titled “prStatus()”prStatus(
headBranch):Promise<PrStatus>
Defined in: src/forge/local.ts:349
Parameters
Section titled “Parameters”headBranch
Section titled “headBranch”string
Returns
Section titled “Returns”Promise<PrStatus>
Implementation of
Section titled “Implementation of”redeploy()
Section titled “redeploy()”redeploy():
Promise<void>
Defined in: src/forge/local.ts:406
Returns
Section titled “Returns”Promise<void>