Skip to content

AskForgeClient

Defined in: src/index.ts:118

Constructors

Constructor

new AskForgeClient(config?, logger?): AskForgeClient

Defined in: src/index.ts:131

Create a new AskForgeClient.

Parameters

config?

ForgeConfig = {}

Library configuration (defaults to openrouter with claude-sonnet-4.6)

logger?

Logger = consoleLogger

Logger instance (defaults to consoleLogger)

Returns

AskForgeClient

Properties

config

readonly config: ResolvedConfig

Defined in: src/index.ts:120

The configuration used by this client (with defaults applied)

Methods

connect()

connect(repoUrl, options?, onProgress?): Promise<Session>

Defined in: src/index.ts:156

Connect to a repository and create a session.

Parameters

repoUrl

string

The URL of the repository to connect to

options?

ConnectOptions = {}

Git connection options (token, forge, commitish)

onProgress?

(message) => void

Optional callback for clone progress messages (useful for long clones)

Returns

Promise<Session>

A Session for asking questions about the repository


resetSandbox()

resetSandbox(): Promise<void>

Defined in: src/index.ts:228

Reset the sandbox, deleting all cloned repositories. Only available when sandbox mode is enabled.

Returns

Promise<void>

Throws

Error if sandbox mode is not enabled