Client
Defined in: src/index.ts:138
Constructors
Constructor
new Client(
config?,logger?):Client
Defined in: src/index.ts:151
Create a new Client.
Parameters
config?
ForgeConfig = {}
Library configuration (defaults to openrouter with claude-sonnet-4.6)
logger?
Logger = consoleLogger
Logger instance (defaults to consoleLogger)
Returns
Client
Properties
config
readonlyconfig:ResolvedConfig
Defined in: src/index.ts:140
The configuration used by this client (with defaults applied)
Methods
connect()
connect(
repoUrl,options?,onProgress?):Promise<Session>
Defined in: src/index.ts:176
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:248
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