agent-cli / Exports / IQueryOptions
Interface: IQueryOptions
query() — single entry point for running an AI agent conversation. Automatically loads config, context, and project info.
Table of contents
Properties
Properties
cwd
• Optional cwd: string
Defined in
agent-sdk/dist/node/index.d.ts:326
permissionMode
• Optional permissionMode: TPermissionMode
Defined in
agent-sdk/dist/node/index.d.ts:327
maxTurns
• Optional maxTurns: number
Defined in
agent-sdk/dist/node/index.d.ts:328
provider
• Optional provider: IAIProvider
Defined in
agent-sdk/dist/node/index.d.ts:329
permissionHandler
• Optional permissionHandler: (toolName: string, toolArgs: TToolArgs) => Promise<boolean>
Type declaration
▸ (toolName, toolArgs): Promise<boolean>
Parameters
| Name | Type |
|---|---|
toolName | string |
toolArgs | TToolArgs |
Returns
Promise<boolean>
Defined in
agent-sdk/dist/node/index.d.ts:330
onTextDelta
• Optional onTextDelta: (delta: string) => void
Type declaration
▸ (delta): void
Parameters
| Name | Type |
|---|---|
delta | string |
Returns
void
Defined in
agent-sdk/dist/node/index.d.ts:331
onCompact
• Optional onCompact: (summary: string) => void
Callback when context is compacted
Type declaration
▸ (summary): void
Parameters
| Name | Type |
|---|---|
summary | string |
Returns
void
Defined in
agent-sdk/dist/node/index.d.ts:333