Kilo Gateway 提供者整合設計

概覽

本文檔概述了將「Kilo Gateway」作為一級提供者整合到 OpenClaw 中的設計，該設計參考了現有的 OpenRouter 實現。Kilo Gateway 使用與 OpenAI 相容的補全 API，但具有不同的基礎 URL。

設計決策

1. 提供者命名

建議：kilocode

理由：

符合提供的使用者設定範例（kilocode 提供者金鑰）
與現有的提供者命名模式一致（例如 openrouter、opencode、moonshot）
簡短且易於記憶
避免與通用的「kilo」或「gateway」術語混淆

考慮過的替代方案：kilo-gateway - 已拒絕，因為程式庫中較少使用連字號命名，且 kilocode 更簡潔。

2. 預設模型參照

建議：kilocode/anthropic/claude-opus-4.6

理由：

基於使用者設定範例
Claude Opus 4.5 是一個功能強大的預設模型
明確的模型選擇避免了對自動路由的依賴

3. 基礎 URL 配置

建議：硬編碼預設值並透過設定覆寫

預設基礎 URL： https://api.kilo.ai/api/gateway/
可配置： 是，透過 models.providers.kilocode.baseUrl

這與 Moonshot、Venice 和 Synthetic 等其他提供者使用的模式相符。

4. 模型掃描

建議：初期不使用專用的模型掃描端點

理由：

Kilo Gateway 代理到 OpenRouter，因此模型是動態的
使用者可以在其設定中手動配置模型
如果 Kilo Gateway 未來公開 /models 端點，可以新增掃描功能

5. 特殊處理

建議：繼承 Anthropic 模型的 OpenRouter 行為

由於 Kilo Gateway 代理到 OpenRouter，應套用相同的特殊處理：

anthropic/* 模型的快取 TTL 資格
anthropic/* 模型的額外參數 (cacheControlTtl)
逐字稿政策遵循 OpenRouter 模式

需要修改的檔案

核心憑證管理

1. `src/commands/onboard-auth.credentials.ts`

新增：

export const KILOCODE_DEFAULT_MODEL_REF = "kilocode/anthropic/claude-opus-4.6";

export async function setKilocodeApiKey(key: string, agentDir?: string) {
  upsertAuthProfile({
    profileId: "kilocode:default",
    credential: {
      type: "api_key",
      provider: "kilocode",
      key,
    },
    agentDir: resolveAuthAgentDir(agentDir),
  });
}

2. `src/agents/model-auth.ts`

新增至 resolveEnvApiKey() 中的 envMap：

const envMap: Record<string, string> = {
  // ... existing entries
  kilocode: "KILOCODE_API_KEY",
};

3. `src/config/io.ts`

新增至 SHELL_ENV_EXPECTED_KEYS：

const SHELL_ENV_EXPECTED_KEYS = [
  // ... existing entries
  "KILOCODE_API_KEY",
];

配置應用

4. `src/commands/onboard-auth.config-core.ts`

新增函式：

export const KILOCODE_BASE_URL = "https://api.kilo.ai/api/gateway/";

export function applyKilocodeProviderConfig(cfg: OpenClawConfig): OpenClawConfig {
  const models = { ...cfg.agents?.defaults?.models };
  models[KILOCODE_DEFAULT_MODEL_REF] = {
    ...models[KILOCODE_DEFAULT_MODEL_REF],
    alias: models[KILOCODE_DEFAULT_MODEL_REF]?.alias ?? "Kilo Gateway",
  };

  const providers = { ...cfg.models?.providers };
  const existingProvider = providers.kilocode;
  const { apiKey: existingApiKey, ...existingProviderRest } = (existingProvider ?? {}) as Record<string, unknown> as { apiKey?: string };
  const resolvedApiKey = typeof existingApiKey === "string" ? existingApiKey : undefined;
  const normalizedApiKey = resolvedApiKey?.trim();

  providers.kilocode = {
    ...existingProviderRest,
    baseUrl: KILOCODE_BASE_URL,
    api: "openai-completions",
    ...(normalizedApiKey ? { apiKey: normalizedApiKey } : {}),
  };

  return {
    ...cfg,
    agents: {
      ...cfg.agents,
      defaults: {
        ...cfg.agents?.defaults,
        models,
      },
    },
    models: {
      mode: cfg.models?.mode ?? "merge",
      providers,
    },
  };
}

export function applyKilocodeConfig(cfg: OpenClawConfig): OpenClawConfig {
  const next = applyKilocodeProviderConfig(cfg);
  const existingModel = next.agents?.defaults?.model;
  return {
    ...next,
    agents: {
      ...next.agents,
      defaults: {
        ...next.agents?.defaults,
        model: {
          ...(existingModel && "fallbacks" in (existingModel as Record<string, unknown>)
            ? {
                fallbacks: (existingModel as { fallbacks?: string[] }).fallbacks,
              }
            : undefined),
          primary: KILOCODE_DEFAULT_MODEL_REF,
        },
      },
    },
  };
}

認證選擇系統

5. `src/commands/onboard-types.ts`

新增至 AuthChoice 類型：

export type AuthChoice =
  // ... existing choices
  "kilocode-api-key";
// ...

新增至 OnboardOptions：

export type OnboardOptions = {
  // ... existing options
  kilocodeApiKey?: string;
  // ...
};

6. `src/commands/auth-choice-options.ts`

新增至 AuthChoiceGroupId：

export type AuthChoiceGroupId =
  // ... existing groups
  "kilocode";
// ...

新增至 AUTH_CHOICE_GROUP_DEFS：

{
  value: "kilocode",
  label: "Kilo Gateway",
  hint: "API key (OpenRouter-compatible)",
  choices: ["kilocode-api-key"],
},

新增至 buildAuthChoiceOptions()：

options.push({
  value: "kilocode-api-key",
  label: "Kilo Gateway API key",
  hint: "OpenRouter-compatible gateway",
});

7. `src/commands/auth-choice.preferred-provider.ts`

新增映射：

const PREFERRED_PROVIDER_BY_AUTH_CHOICE: Partial<Record<AuthChoice, string>> = {
  // ... existing mappings
  "kilocode-api-key": "kilocode",
};

認證選擇應用

8. `src/commands/auth-choice.apply.api-providers.ts`

新增匯入：

import {
  // ... existing imports
  applyKilocodeConfig,
  applyKilocodeProviderConfig,
  KILOCODE_DEFAULT_MODEL_REF,
  setKilocodeApiKey,
} from "./onboard-auth.js";

新增 kilocode-api-key 的處理：

if (authChoice === "kilocode-api-key") {
  const store = ensureAuthProfileStore(params.agentDir, {
    allowKeychainPrompt: false,
  });
  const profileOrder = resolveAuthProfileOrder({
    cfg: nextConfig,
    store,
    provider: "kilocode",
  });
  const existingProfileId = profileOrder.find((profileId) => Boolean(store.profiles[profileId]));
  const existingCred = existingProfileId ? store.profiles[existingProfileId] : undefined;
  let profileId = "kilocode:default";
  let mode: "api_key" | "oauth" | "token" = "api_key";
  let hasCredential = false;

  if (existingProfileId && existingCred?.type) {
    profileId = existingProfileId;
    mode = existingCred.type === "oauth" ? "oauth" : existingCred.type === "token" ? "token" : "api_key";
    hasCredential = true;
  }

  if (!hasCredential && params.opts?.token && params.opts?.tokenProvider === "kilocode") {
    await setKilocodeApiKey(normalizeApiKeyInput(params.opts.token), params.agentDir);
    hasCredential = true;
  }

  if (!hasCredential) {
    const envKey = resolveEnvApiKey("kilocode");
    if (envKey) {
      const useExisting = await params.prompter.confirm({
        message: `Use existing KILOCODE_API_KEY (${envKey.source}, ${formatApiKeyPreview(envKey.apiKey)})?`,
        initialValue: true,
      });
      if (useExisting) {
        await setKilocodeApiKey(envKey.apiKey, params.agentDir);
        hasCredential = true;
      }
    }
  }

  if (!hasCredential) {
    const key = await params.prompter.text({
      message: "Enter Kilo Gateway API key",
      validate: validateApiKeyInput,
    });
    await setKilocodeApiKey(normalizeApiKeyInput(String(key)), params.agentDir);
    hasCredential = true;
  }

  if (hasCredential) {
    nextConfig = applyAuthProfileConfig(nextConfig, {
      profileId,
      provider: "kilocode",
      mode,
    });
  }
  {
    const applied = await applyDefaultModelChoice({
      config: nextConfig,
      setDefaultModel: params.setDefaultModel,
      defaultModel: KILOCODE_DEFAULT_MODEL_REF,
      applyDefaultConfig: applyKilocodeConfig,
      applyProviderConfig: applyKilocodeProviderConfig,
      noteDefault: KILOCODE_DEFAULT_MODEL_REF,
      noteAgentModel,
      prompter: params.prompter,
    });
    nextConfig = applied.config;
    agentModelOverride = applied.agentModelOverride ?? agentModelOverride;
  }
  return { config: nextConfig, agentModelOverride };
}

同時在函式頂部新增 tokenProvider 映射：

if (params.opts.tokenProvider === "kilocode") {
  authChoice = "kilocode-api-key";
}

CLI 註冊

9. `src/cli/program/register.onboard.ts`

新增 CLI 選項：

.option("--kilocode-api-key <key>", "Kilo Gateway API key")

新增至動作處理器：

kilocodeApiKey: opts.kilocodeApiKey as string | undefined,

更新 auth-choice 說明文字：

.option(
  "--auth-choice <choice>",
  "Auth: setup-token|token|chutes|openai-codex|openai-api-key|openrouter-api-key|kilocode-api-key|ai-gateway-api-key|...",
)

非互動式入門

10. `src/commands/onboard-non-interactive/local/auth-choice.ts`

新增 kilocode-api-key 的處理：

if (authChoice === "kilocode-api-key") {
  const resolved = await resolveNonInteractiveApiKey({
    provider: "kilocode",
    cfg: baseConfig,
    flagValue: opts.kilocodeApiKey,
    flagName: "--kilocode-api-key",
    envVar: "KILOCODE_API_KEY",
  });
  await setKilocodeApiKey(resolved.apiKey, agentDir);
  nextConfig = applyAuthProfileConfig(nextConfig, {
    profileId: "kilocode:default",
    provider: "kilocode",
    mode: "api_key",
  });
  // ... apply default model
}

匯出更新

11. `src/commands/onboard-auth.ts`

新增匯出：

export {
  // ... existing exports
  applyKilocodeConfig,
  applyKilocodeProviderConfig,
  KILOCODE_BASE_URL,
} from "./onboard-auth.config-core.js";

export {
  // ... existing exports
  KILOCODE_DEFAULT_MODEL_REF,
  setKilocodeApiKey,
} from "./onboard-auth.credentials.js";

特殊處理（可選）

12. `src/agents/pi-embedded-runner/cache-ttl.ts`

新增 Kilo Gateway 對 Anthropic 模型的支援：

export function isCacheTtlEligibleProvider(provider: string, modelId: string): boolean {
  const normalizedProvider = provider.toLowerCase();
  const normalizedModelId = modelId.toLowerCase();
  if (normalizedProvider === "anthropic") return true;
  if (normalizedProvider === "openrouter" && normalizedModelId.startsWith("anthropic/")) return true;
  if (normalizedProvider === "kilocode" && normalizedModelId.startsWith("anthropic/")) return true;
  return false;
}

13. `src/agents/transcript-policy.ts`

新增 Kilo Gateway 處理（類似於 OpenRouter）：

const isKilocodeGemini = provider === "kilocode" && modelId.toLowerCase().includes("gemini");

// Include in needsNonImageSanitize check
const needsNonImageSanitize = isGoogle || isAnthropic || isMistral || isOpenRouterGemini || isKilocodeGemini;

配置結構

用戶配置範例

{
  "models": {
    "mode": "merge",
    "providers": {
      "kilocode": {
        "baseUrl": "https://api.kilo.ai/api/gateway/",
        "apiKey": "xxxxx",
        "api": "openai-completions",
        "models": [
          {
            "id": "anthropic/claude-opus-4.6",
            "name": "Anthropic: Claude Opus 4.6"
          },
          { "id": "minimax/minimax-m2.5:free", "name": "Minimax: Minimax M2.5" }
        ]
      }
    }
  }
}

認證配置檔結構

{
  "profiles": {
    "kilocode:default": {
      "type": "api_key",
      "provider": "kilocode",
      "key": "xxxxx"
    }
  }
}

測試考量

單元測試：
- 測試 setKilocodeApiKey() 寫入正確的配置檔
- 測試 applyKilocodeConfig() 設置正確的預設值
- 測試 resolveEnvApiKey("kilocode") 返回正確的環境變數
整合測試：
- 測試使用 --auth-choice kilocode-api-key 的設置流程
- 測試使用 --kilocode-api-key 的非互動式設置
- 測試帶有 kilocode/ 前綴的模型選擇
端對端測試：
- 測試透過 Kilo Gateway 的實際 API 呼叫（即時測試）

遷移說明

現有用戶無需遷移
新用戶可以立即使用 kilocode-api-key 認證選項
現有手動配置 kilocode 供應商的將繼續有效

未來考量

模型目錄： 如果 Kilo Gateway 暴露了 /models 端點，請新增類似於 scanOpenRouterModels() 的掃描支援
OAuth 支援： 如果 Kilo Gateway 新增了 OAuth，請相應地擴展認證系統
速率限制： 如果需要，請考慮新增專屬於 Kilo Gateway 的速率限制處理
文件： 在 docs/providers/kilocode.md 新增說明設置和用法的文件

變更摘要

檔案	變更類型	描述
`src/commands/onboard-auth.credentials.ts`	新增	`KILOCODE_DEFAULT_MODEL_REF`, `setKilocodeApiKey()`
`src/agents/model-auth.ts`	修改	將 `kilocode` 新增至 `envMap`
`src/config/io.ts`	修改	將 `KILOCODE_API_KEY` 新增至 shell 環境變數鍵
`src/commands/onboard-auth.config-core.ts`	新增	`applyKilocodeProviderConfig()`, `applyKilocodeConfig()`
`src/commands/onboard-types.ts`	修改	將 `kilocode-api-key` 新增至 `AuthChoice`，並將 `kilocodeApiKey` 新增至選項
`src/commands/auth-choice-options.ts`	修改	新增 `kilocode` 群組和選項
`src/commands/auth-choice.preferred-provider.ts`	修改	新增 `kilocode-api-key` 對應
`src/commands/auth-choice.apply.api-providers.ts`	修改	新增 `kilocode-api-key` 處理
`src/cli/program/register.onboard.ts`	修改	新增 `--kilocode-api-key` 選項
`src/commands/onboard-non-interactive/local/auth-choice.ts`	修改	新增非互動式處理
`src/commands/onboard-auth.ts`	修改	匯出新函式
`src/agents/pi-embedded-runner/cache-ttl.ts`	修改	新增 kilocode 支援
`src/agents/transcript-policy.ts`	修改	新增 kilocode Gemini 處理

Kilo Gateway 提供者整合設計

Kilo Gateway 提供者整合設計

概覽

設計決策

1. 提供者命名

2. 預設模型參照

3. 基礎 URL 配置

4. 模型掃描

5. 特殊處理

需要修改的檔案

核心憑證管理

1. src/commands/onboard-auth.credentials.ts

2. src/agents/model-auth.ts

3. src/config/io.ts

配置應用

4. src/commands/onboard-auth.config-core.ts

認證選擇系統

5. src/commands/onboard-types.ts

6. src/commands/auth-choice-options.ts

7. src/commands/auth-choice.preferred-provider.ts

認證選擇應用

8. src/commands/auth-choice.apply.api-providers.ts

CLI 註冊

9. src/cli/program/register.onboard.ts

非互動式入門

10. src/commands/onboard-non-interactive/local/auth-choice.ts

匯出更新

11. src/commands/onboard-auth.ts

特殊處理（可選）

12. src/agents/pi-embedded-runner/cache-ttl.ts

13. src/agents/transcript-policy.ts

配置結構

用戶配置範例

認證配置檔結構

測試考量

遷移說明

未來考量

變更摘要

1. `src/commands/onboard-auth.credentials.ts`

2. `src/agents/model-auth.ts`

3. `src/config/io.ts`

4. `src/commands/onboard-auth.config-core.ts`

5. `src/commands/onboard-types.ts`

6. `src/commands/auth-choice-options.ts`

7. `src/commands/auth-choice.preferred-provider.ts`

8. `src/commands/auth-choice.apply.api-providers.ts`

9. `src/cli/program/register.onboard.ts`

10. `src/commands/onboard-non-interactive/local/auth-choice.ts`

11. `src/commands/onboard-auth.ts`

12. `src/agents/pi-embedded-runner/cache-ttl.ts`

13. `src/agents/transcript-policy.ts`