TriageProvider
Defined in: providers/types.ts:166
Triage Provider Interface
All issue tracking backends must implement this interface. This allows commands to work with any provider transparently.
Properties
Section titled “Properties”displayName
Section titled “displayName”
readonlydisplayName:string
Defined in: providers/types.ts:171
Provider display name
readonlyname:string
Defined in: providers/types.ts:168
Provider name (e.g., ‘github’, ‘beads’, ‘jira’, ‘linear’)
Methods
Section titled “Methods”addLabels()
Section titled “addLabels()”addLabels(
id,labels):Promise<void>
Defined in: providers/types.ts:241
Add labels to an issue
Parameters
Section titled “Parameters”string
labels
Section titled “labels”string[]
Returns
Section titled “Returns”Promise<void>
closeIssue()
Section titled “closeIssue()”closeIssue(
id,reason?):Promise<TriageIssue>
Defined in: providers/types.ts:198
Close an issue
Parameters
Section titled “Parameters”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<TriageIssue>
createIssue()
Section titled “createIssue()”createIssue(
options):Promise<TriageIssue>
Defined in: providers/types.ts:183
Create a new issue
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<TriageIssue>
deleteIssue()?
Section titled “deleteIssue()?”
optionaldeleteIssue(id):Promise<void>
Defined in: providers/types.ts:208
Delete an issue (if supported)
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
getAvailableLabels()?
Section titled “getAvailableLabels()?”
optionalgetAvailableLabels():Promise<string[]>
Defined in: providers/types.ts:251
Get all available labels
Returns
Section titled “Returns”Promise<string[]>
getBlockedIssues()
Section titled “getBlockedIssues()”getBlockedIssues():
Promise<TriageIssue[]>
Defined in: providers/types.ts:227
Get blocked issues
Returns
Section titled “Returns”Promise<TriageIssue[]>
getIssue()
Section titled “getIssue()”getIssue(
id):Promise<TriageIssue|null>
Defined in: providers/types.ts:188
Get an issue by ID
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<TriageIssue | null>
getReadyWork()
Section titled “getReadyWork()”getReadyWork(
options?):Promise<ReadyWork[]>
Defined in: providers/types.ts:222
Get issues ready to work on (no blockers)
Parameters
Section titled “Parameters”options?
Section titled “options?”limit?
Section titled “limit?”number
priority?
Section titled “priority?”Returns
Section titled “Returns”Promise<ReadyWork[]>
getStats()
Section titled “getStats()”getStats():
Promise<ProviderStats>
Defined in: providers/types.ts:260
Get provider statistics
Returns
Section titled “Returns”Promise<ProviderStats>
init()?
Section titled “init()?”
optionalinit(directory?):Promise<void>
Defined in: providers/types.ts:270
Initialize the provider in a directory (for local providers like Beads)
Parameters
Section titled “Parameters”directory?
Section titled “directory?”string
Returns
Section titled “Returns”Promise<void>
isReady()
Section titled “isReady()”isReady():
Promise<boolean>
Defined in: providers/types.ts:174
Whether the provider is initialized and ready
Returns
Section titled “Returns”Promise<boolean>
listIssues()
Section titled “listIssues()”listIssues(
options?):Promise<TriageIssue[]>
Defined in: providers/types.ts:217
List issues with optional filters
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<TriageIssue[]>
removeLabels()
Section titled “removeLabels()”removeLabels(
id,labels):Promise<void>
Defined in: providers/types.ts:246
Remove labels from an issue
Parameters
Section titled “Parameters”string
labels
Section titled “labels”string[]
Returns
Section titled “Returns”Promise<void>
reopenIssue()
Section titled “reopenIssue()”reopenIssue(
id,reason?):Promise<TriageIssue>
Defined in: providers/types.ts:203
Reopen an issue
Parameters
Section titled “Parameters”string
reason?
Section titled “reason?”string
Returns
Section titled “Returns”Promise<TriageIssue>
searchIssues()
Section titled “searchIssues()”searchIssues(
query,options?):Promise<TriageIssue[]>
Defined in: providers/types.ts:232
Search issues by text
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<TriageIssue[]>
sync()?
Section titled “sync()?”
optionalsync():Promise<void>
Defined in: providers/types.ts:265
Sync with remote (for providers that support it)
Returns
Section titled “Returns”Promise<void>
updateIssue()
Section titled “updateIssue()”updateIssue(
id,options):Promise<TriageIssue>
Defined in: providers/types.ts:193
Update an existing issue
Parameters
Section titled “Parameters”string
options
Section titled “options”Returns
Section titled “Returns”Promise<TriageIssue>