free-coding-models 0.1.83 → 0.1.84

package/src/openclaw.js

@@ -0,0 +1,131 @@
+/**
+ * @file openclaw.js
+ * @description OpenClaw config helpers for setting NVIDIA NIM defaults.
+ *
+ * @details
+ *   This module owns the OpenClaw integration logic:
+ *   - Read/write ~/.openclaw/openclaw.json
+ *   - Ensure the NVIDIA provider block exists under models.providers
+ *   - Patch the OpenClaw allowlist for NVIDIA models when needed
+ *   - Set the selected model as the default primary model
+ *
+ *   → Functions:
+ *   - `loadOpenClawConfig` — read OpenClaw config as JSON
+ *   - `saveOpenClawConfig` — persist OpenClaw config safely
+ *   - `startOpenClaw` — set NVIDIA model as OpenClaw default
+ *
+ * @exports { loadOpenClawConfig, saveOpenClawConfig, startOpenClaw }
+ * @see ../patch-openclaw-models.js
+ */
+
+import chalk from 'chalk'
+import { copyFileSync, existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs'
+import { homedir } from 'os'
+import { join } from 'path'
+import { patchOpenClawModelsJson } from '../patch-openclaw-models.js'
+
+// 📖 OpenClaw config: ~/.openclaw/openclaw.json (JSON format, may be JSON5 in newer versions)
+const OPENCLAW_CONFIG = join(homedir(), '.openclaw', 'openclaw.json')
+
+export function loadOpenClawConfig() {
+  if (!existsSync(OPENCLAW_CONFIG)) return {}
+  try {
+    // 📖 JSON.parse works for standard JSON; OpenClaw may use JSON5 but base config is valid JSON
+    return JSON.parse(readFileSync(OPENCLAW_CONFIG, 'utf8'))
+  } catch {
+    return {}
+  }
+}
+
+export function saveOpenClawConfig(config) {
+  const dir = join(homedir(), '.openclaw')
+  if (!existsSync(dir)) {
+    mkdirSync(dir, { recursive: true })
+  }
+  writeFileSync(OPENCLAW_CONFIG, JSON.stringify(config, null, 2))
+}
+
+// 📖 startOpenClaw: sets the selected NVIDIA NIM model as default in OpenClaw config.
+// 📖 Also ensures the nvidia provider block is present with the NIM base URL.
+// 📖 Does NOT launch OpenClaw — OpenClaw runs as a daemon, so config changes are picked up on restart.
+export async function startOpenClaw(model, apiKey) {
+  console.log(chalk.rgb(255, 100, 50)(`  🦞 Setting ${chalk.bold(model.label)} as OpenClaw default…`))
+  console.log(chalk.dim(`  Model: nvidia/${model.modelId}`))
+  console.log()
+
+  const config = loadOpenClawConfig()
+
+  // 📖 Backup existing config before touching it
+  if (existsSync(OPENCLAW_CONFIG)) {
+    const backupPath = `${OPENCLAW_CONFIG}.backup-${Date.now()}`
+    copyFileSync(OPENCLAW_CONFIG, backupPath)
+    console.log(chalk.dim(`  💾 Backup: ${backupPath}`))
+  }
+
+  // 📖 Patch models.json to add all NVIDIA models (fixes "not allowed" errors)
+  const patchResult = patchOpenClawModelsJson()
+  if (patchResult.wasPatched) {
+    console.log(chalk.dim(`  ✨ Added ${patchResult.added} NVIDIA models to allowlist (${patchResult.total} total)`))
+    if (patchResult.backup) {
+      console.log(chalk.dim(`  💾 models.json backup: ${patchResult.backup}`))
+    }
+  }
+
+  // 📖 Ensure models.providers section exists with nvidia NIM block.
+  // 📖 Per OpenClaw docs (docs.openclaw.ai/providers/nvidia), providers MUST be nested under
+  // 📖 "models.providers", NOT at the config root. Root-level "providers" is ignored by OpenClaw.
+  // 📖 API key is NOT stored in the provider block — it's read from env var NVIDIA_API_KEY.
+  // 📖 If needed, it can be stored under the root "env" key: { env: { NVIDIA_API_KEY: "nvapi-..." } }
+  if (!config.models) config.models = {}
+  if (!config.models.providers) config.models.providers = {}
+  if (!config.models.providers.nvidia) {
+    config.models.providers.nvidia = {
+      baseUrl: 'https://integrate.api.nvidia.com/v1',
+      api: 'openai-completions',
+      models: [],
+    }
+    console.log(chalk.dim('  ➕ Added nvidia provider block to OpenClaw config (models.providers.nvidia)'))
+  }
+  // 📖 Ensure models array exists even if the provider block was created by an older version
+  if (!Array.isArray(config.models.providers.nvidia.models)) {
+    config.models.providers.nvidia.models = []
+  }
+
+  // 📖 Store API key in the root "env" section so OpenClaw can read it as NVIDIA_API_KEY env var.
+  // 📖 Only writes if not already set to avoid overwriting an existing key.
+  const resolvedKey = apiKey || process.env.NVIDIA_API_KEY
+  if (resolvedKey) {
+    if (!config.env) config.env = {}
+    if (!config.env.NVIDIA_API_KEY) {
+      config.env.NVIDIA_API_KEY = resolvedKey
+      console.log(chalk.dim('  🔑 Stored NVIDIA_API_KEY in config env section'))
+    }
+  }
+
+  // 📖 Set as the default primary model for all agents.
+  // 📖 Format: "provider/model-id" — e.g. "nvidia/deepseek-ai/deepseek-v3.2"
+  if (!config.agents) config.agents = {}
+  if (!config.agents.defaults) config.agents.defaults = {}
+  if (!config.agents.defaults.model) config.agents.defaults.model = {}
+  config.agents.defaults.model.primary = `nvidia/${model.modelId}`
+
+  // 📖 REQUIRED: OpenClaw requires the model to be explicitly listed in agents.defaults.models
+  // 📖 (the allowlist). Without this entry, OpenClaw rejects the model with "not allowed".
+  // 📖 See: https://docs.openclaw.ai/gateway/configuration-reference
+  if (!config.agents.defaults.models) config.agents.defaults.models = {}
+  config.agents.defaults.models[`nvidia/${model.modelId}`] = {}
+
+  saveOpenClawConfig(config)
+
+  console.log(chalk.rgb(255, 140, 0)(`  ✓ Default model set to: nvidia/${model.modelId}`))
+  console.log()
+  console.log(chalk.dim('  📄 Config updated: ' + OPENCLAW_CONFIG))
+  console.log()
+  // 📖 "openclaw restart" does NOT exist. The gateway auto-reloads on config file changes.
+  // 📖 To apply manually: use "openclaw models set" or "openclaw configure"
+  // 📖 See: https://docs.openclaw.ai/gateway/configuration
+  console.log(chalk.dim('  💡 OpenClaw will reload config automatically (gateway.reload.mode).'))
+  console.log(chalk.dim('     To apply manually: openclaw models set nvidia/' + model.modelId))
+  console.log(chalk.dim('     Or run the setup wizard: openclaw configure'))
+  console.log()
+}