Interface ICliAdapter

Readonlyname

Readonlytransport

Readonlycapabilities

execute

• execute(
      task: CliTask,
      options?: CliExecutionOptions,
  ): Promise<Result<CliResponse, CliError>>

  Executes a task on the CLI.

  Parameters

  • task: CliTask

    Task to execute

  • Optionaloptions: CliExecutionOptions

    Execution options

  Returns Promise<Result<CliResponse, CliError>>

  Result with response or error

healthCheck

• healthCheck(): Promise<HealthStatus>

  Performs a health check on the CLI.

  Returns Promise<HealthStatus>

  Health status including version compatibility

getCapacity

• getCapacity(): Promise<CapacityStatus>

  Gets current capacity/rate limit status.

  Returns Promise<CapacityStatus>

  Capacity status

getVersion

• getVersion(): Promise<string>

  Gets CLI version.

  Returns Promise<string>

  Version string

getModelInfo

• getModelInfo(): CliModelInfo

  Gets model information.

  Returns CliModelInfo

  Model info

initialize

• initialize(): Promise<void>

  Initializes the adapter (e.g., MCP connection). Called before first use.

  Returns Promise<void>

dispose

• dispose(): Promise<void>

  Cleans up resources (e.g., subprocess, MCP connection). Called on shutdown.

  Returns Promise<void>

OptionallistModels

• listModels?(): Promise<readonly CliModelInfo[]>

  (#2540) Optional: list models the underlying CLI installation/runtime has available. Implementations should cache for ~5 min and throw on failure so the caller can fall back. Adapters whose CLIs have no native list surface (claude, codex, gemini) leave this undefined.

  Returns Promise<readonly CliModelInfo[]>