Interface CliAdapter

OptionaleffortReplacesModelSuffix

id

name

execute

• execute(
      prompt: string,
      options?: ExecutionOptions,
  ): Promise<TerminalExecutionResult>

  Executes a prompt in a read-only sandboxed CLI process. options.model is the model the controller selected; an adapter refuses a turn without one rather than let the CLI choose.

  Parameters

  • prompt: string
  • Optionaloptions: ExecutionOptions

  Returns Promise<TerminalExecutionResult>

OptionalinheritedTools

• inheritedTools?(
      context?: BackendReadContext,
  ): Promise<InheritedTools | undefined>

  Reads, without a model call, the MCP servers and plugins of the user's CLI configuration that its turns offer the model and the adapter cannot disable (CUR-002). Called only by doctor; undefined when the CLI cannot say.

  Parameters

  • Optionalcontext: BackendReadContext

  Returns Promise<InheritedTools | undefined>

OptionalinspectQuota

• inspectQuota?(
      probe?: AdapterProbeResult,
      context?: BackendReadContext,
  ): Promise<
      | {
          buckets?: {
              id: string;
              name: string;
              remainingFraction: number;
              resetTime: string;
              window: string;
          }[];
          headroomPercent?: number
          | null;
          measured: boolean;
          resetsAt?: string | null;
          usedPercent?: number | null;
          window?: string;
      }
      | undefined,
  >

  Reads measured native quota without a model call, for adapters whose probe does not include it. Called by native quota diagnostics; ordinary routing reuses cached measurements. Never called by execute.

  Parameters

  • Optionalprobe: AdapterProbeResult
  • Optionalcontext: BackendReadContext

  Returns Promise<
      | {
          buckets?: {
              id: string;
              name: string;
              remainingFraction: number;
              resetTime: string;
              window: string;
          }[];
          headroomPercent?: number
          | null;
          measured: boolean;
          resetsAt?: string | null;
          usedPercent?: number | null;
          window?: string;
      }
      | undefined,
  >

OptionallistModels

• listModels?(
      probe?: AdapterProbeResult,
      context?: BackendReadContext,
  ): Promise<ModelCatalog | undefined>

  Reads the models the installed CLI offers, without a model call. Called when a turn selects or checks a model, and by doctor; undefined when the CLI cannot say.

  Parameters

  • Optionalprobe: AdapterProbeResult

    The current probe, for the version and executable it found.

  • Optionalcontext: BackendReadContext

  Returns Promise<ModelCatalog | undefined>

OptionalobserveModel

• observeModel?(
      requested?: string,
      probe?: AdapterProbeResult,
      context?: BackendReadContext,
  ): Promise<string | undefined>

  Asks the CLI, without a model turn, which concrete model it runs for a requested name, or without one, for CLIs that resolve names themselves (Claude Code aliases, its account default). The controller passes the answer to execute, so consent and the turn name the same model. Undefined when the CLI cannot say.

  Parameters

  • Optionalrequested: string
  • Optionalprobe: AdapterProbeResult
  • Optionalcontext: BackendReadContext

  Returns Promise<string | undefined>

probe

• probe(context?: BackendReadContext): Promise<AdapterProbeResult>

  Probes the environment to verify CLI presence, version, and auth status.

  Parameters

  • Optionalcontext: BackendReadContext

  Returns Promise<AdapterProbeResult>