GitHubClient

Defined in: packages/agentic-control/src/github/client.ts:58

Constructors

Constructor

new GitHubClient(config?): GitHubClient

Defined in: packages/agentic-control/src/github/client.ts:70

Create a new GitHubClient.

Can be used in two modes:

1. With explicit config: new GitHubClient({ token, owner, repo })
2. Token-aware mode: new GitHubClient() - uses token based on repo

Parameters

config?

GitHubClientConfig = {}

Returns

GitHubClient

Methods

collectFeedback()

collectFeedback(prNumber): Promise<infer<any>[]>

Defined in: packages/agentic-control/src/github/client.ts:598

Collect all feedback on a PR

Parameters

prNumber

number

Returns

Promise<infer<any>[]>

---

getCIStatus()

getCIStatus(prNumber): Promise<infer<any>>

Defined in: packages/agentic-control/src/github/client.ts:549

Get CI status for a PR

Parameters

prNumber

number

Returns

Promise<infer<any>>

---

getIssueComments()

getIssueComments(prNumber): Promise<any>

Defined in: packages/agentic-control/src/github/client.ts:399

Get issue comments on a PR

Parameters

prNumber

number

Returns

Promise<any>

---

getPR()

getPR(prNumber): Promise<any>

Defined in: packages/agentic-control/src/github/client.ts:241

Get pull request (instance version with full data)

Parameters

prNumber

number

Returns

Promise<any>

---

getPRFiles()

getPRFiles(prNumber): Promise<any>

Defined in: packages/agentic-control/src/github/client.ts:255

Get files changed in a PR

Parameters

prNumber

number

Returns

Promise<any>

---

getReviewComments()

getReviewComments(prNumber): Promise<any>

Defined in: packages/agentic-control/src/github/client.ts:385

Get review comments on a PR

Parameters

prNumber

number

Returns

Promise<any>

---

getReviews()

getReviews(prNumber): Promise<any>

Defined in: packages/agentic-control/src/github/client.ts:371

Get reviews on a PR

Parameters

prNumber

number

Returns

Promise<any>

---

mergePR()

mergePR(prNumber, method?): Promise<any>

Defined in: packages/agentic-control/src/github/client.ts:352

Merge a pull request (instance version)

Parameters

prNumber

number

method?

"merge" | "squash" | "rebase"

Returns

Promise<any>

---

postComment()

postComment(prNumber, body): Promise<any>

Defined in: packages/agentic-control/src/github/client.ts:486

Post a comment (instance version)

Parameters

prNumber

number

body

string

Returns

Promise<any>

---

replyToComment()

replyToComment(prNumber, commentId, body): Promise<any>

Defined in: packages/agentic-control/src/github/client.ts:501

Reply to a review comment

Parameters

prNumber

number

commentId

number

body

string

Returns

Promise<any>

---

createPR()

static createPR(owner, repo, options): Promise<Result<PullRequest>>

Defined in: packages/agentic-control/src/github/client.ts:269

Create a pull request

Parameters

owner

string

repo

string

options

base

string

body?

string

draft?

boolean

head

string

title

string

Returns

Promise<Result<PullRequest>>

---

forPRReview()

static forPRReview(): any

Defined in: packages/agentic-control/src/github/client.ts:97

Get an Octokit instance for PR review operations. Always uses the consistent PR review identity.

Returns

any

---

forRepo()

static forRepo(repoUrl): any

Defined in: packages/agentic-control/src/github/client.ts:84

Get an Octokit instance for a repository. Automatically selects the correct token based on org.

Parameters

repoUrl

string

Returns

any

---

getPRStatic()

static getPRStatic(owner, repo, prNumber): Promise<Result<PullRequest>>

Defined in: packages/agentic-control/src/github/client.ts:207

Get pull request information (static version)

Parameters

owner

string

repo

string

prNumber

number

Returns

Promise<Result<PullRequest>>

---

getRepo()

static getRepo(owner, repo): Promise<Result<Repository>>

Defined in: packages/agentic-control/src/github/client.ts:138

Get repository information

Parameters

owner

string

repo

string

Returns

Promise<Result<Repository>>

---

listOrgRepos()

static listOrgRepos(org, options?): Promise<Result<Repository[]>>

Defined in: packages/agentic-control/src/github/client.ts:165

List repositories for an organization

Parameters

org

string

options?

perPage?

number

type?

"all" | "public" | "private" | "forks" | "sources" | "member"

Returns

Promise<Result<Repository[]>>

---

listPRComments()

static listPRComments(owner, repo, prNumber): Promise<Result<PRComment[]>>

Defined in: packages/agentic-control/src/github/client.ts:413

List PR comments (static version)

Parameters

owner

string

repo

string

prNumber

number

Returns

Promise<Result<PRComment[]>>

---

mergePRStatic()

static mergePRStatic(owner, repo, prNumber, options?): Promise<Result<void>>

Defined in: packages/agentic-control/src/github/client.ts:318

Merge a pull request

Parameters

owner

string

repo

string

prNumber

number

options?

commitMessage?

string

commitTitle?

string

mergeMethod?

"merge" | "squash" | "rebase"

Returns

Promise<Result<void>>

---

postPRComment()

static postPRComment(owner, repo, prNumber, body): Promise<Result<PRComment>>

Defined in: packages/agentic-control/src/github/client.ts:449

Post a PR comment (ALWAYS uses PR review identity)

Parameters

owner

string

repo

string

prNumber

number

body

string

Returns

Promise<Result<PRComment>>

---

requestReview()

static requestReview(owner, repo, prNumber, reviewers): Promise<Result<void>>

Defined in: packages/agentic-control/src/github/client.ts:517

Request a review on a PR (ALWAYS uses PR review identity)

Parameters

owner

string

repo

string

prNumber

number

reviewers

string[]

Returns

Promise<Result<void>>