Skip to content

Never stop coding. Free MIT AI gateway: one endpoint, 375 providers (150+ free), 1,400+ models Kimi, Claude, GPT, Gemini, GLM, DeepSeek, MiniMax. Works with Claude Code, Codex, Cursor, OpenCode, Cline & Copilot. Quota-aware auto-fallback, RTK+Caveman compression saves 15-95% tokens, MCP/A2A, Desktop/PWA. Built by 900+ contributors

6.1 KB
Raw Blame
/**
 * omniroute setup-crush — configure Crush (charmbracelet/crush) for OmniRoute.
 *
 * Crush is a terminal AI agent with a file-based config: ~/.config/crush/crush.json
 * (or ./crush.json). It supports a custom `openai-compat` provider. base_url must
 * include /v1; the api_key may reference an env var (`$OMNIROUTE_API_KEY`) so the
 * secret stays out of the file. Remote-aware; curated catalog models.
 */

import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
import { join } from "node:path";
import os from "node:os";
import { printHeading, printInfo, printSuccess, printError } from "../io.mjs";
import { resolveActiveContext } from "../contexts.mjs";
import { categoriseModel } from "./setup-codex.mjs";
import { guardHostConfigTarget } from "../utils/config-home-guard.mjs";

const API_KEY_REF = "$OMNIROUTE_API_KEY";

function ensureV1(url) {
  const s = String(url || "").replace(/\/+$/, "");
  return s.endsWith("/v1") ? s : `${s}/v1`;
}

/** Resolve base_url (WITH /v1) + apiKey from flags → active context → localhost. */
export function resolveCrushTarget(opts = {}) {
  let root;
  if (opts.remote) root = String(opts.remote).replace(/\/+$/, "");
  else {
    try {
      root = resolveActiveContext(opts.context ?? process.env.OMNIROUTE_CONTEXT)?.baseUrl;
    } catch {
      /* none */
    }
    if (!root) root = `http://localhost:${Number(opts.port ?? process.env.PORT ?? 20128) || 20128}`;
  }
  let apiKey = opts.apiKey ?? opts["api-key"];
  if (!apiKey) {
    try {
      const c = resolveActiveContext(opts.context ?? process.env.OMNIROUTE_CONTEXT);
      apiKey = c?.accessToken || c?.apiKey;
    } catch {
      /* none */
    }
  }
  if (!apiKey) apiKey = process.env.OMNIROUTE_API_KEY || "";
  return { baseUrl: ensureV1(root), apiKey };
}

/** Build the Crush `openai-compat` provider block from curated catalog ids. */
export function buildCrushProvider(modelIds, baseUrl) {
  const models = [];
  for (const id of modelIds) {
    const cfg = categoriseModel(id);
    if (!cfg) continue;
    models.push({ id, name: `OmniRoute: ${id}`, context_window: cfg.ctx });
  }
  return {
    type: "openai-compat",
    base_url: baseUrl,
    api_key: API_KEY_REF,
    models,
  };
}

/** Merge the OmniRoute provider into an existing crush.json (preserve the rest). */
export function mergeCrushConfig(existing, provider) {
  const cfg = existing && typeof existing === "object" ? { ...existing } : {};
  cfg.providers = { ...(cfg.providers || {}), omniroute: provider };
  return cfg;
}

function readJson(path) {
  try {
    if (existsSync(path)) return JSON.parse(readFileSync(path, "utf8"));
  } catch {
    /* corrupt/missing */
  }
  return {};
}

async function fetchModelIds(baseUrl, apiKey) {
  const headers = { "Content-Type": "application/json" };
  if (apiKey) headers["Authorization"] = `Bearer ${apiKey}`;
  const res = await fetch(`${baseUrl.replace(/\/v1$/, "")}/v1/models`, {
    headers,
    signal: AbortSignal.timeout(10000),
  });
  if (!res.ok) throw new Error(`HTTP ${res.status}`);
  const body = await res.json();
  const list = Array.isArray(body) ? body : (body.data ?? body.models ?? []);
  return list.map((m) => (typeof m === "string" ? m : m?.id)).filter(Boolean);
}

export async function runSetupCrushCommand(opts = {}) {
  const { baseUrl, apiKey } = resolveCrushTarget(opts);
  const dryRun = Boolean(opts.dryRun ?? opts["dry-run"]);
  const only = opts.only
    ? opts.only
        .split(",")
        .map((s) => s.trim())
        .filter(Boolean)
    : null;
  const configPath =
    opts.configPath ?? opts["config-path"] ?? join(os.homedir(), ".config", "crush", "crush.json");

  const guard = await guardHostConfigTarget(configPath, {
    toolLabel: "Crush",
    hostCommand: "omniroute setup-crush",
    allowContainerWrite: Boolean(opts.allowContainerWrite ?? opts["allow-container-write"]),
    dryRun,
  });
  if (guard !== 0) return guard;

  printHeading("OmniRoute → Crush (openai-compat)");
  printInfo(`base_url: ${baseUrl}`);

  let ids;
  try {
    ids = await fetchModelIds(baseUrl, apiKey);
  } catch (e) {
    printError(`Could not fetch models: ${e.message}`);
    printInfo("Make sure OmniRoute is running and --remote/--api-key are correct.");
    return 1;
  }
  if (only) ids = ids.filter((id) => only.some((f) => id.includes(f)));

  const provider = buildCrushProvider(ids, baseUrl);
  if (!provider.models.length) {
    printError("No matching curated models (try --only or check the server).");
    return 1;
  }
  const merged = mergeCrushConfig(readJson(configPath), provider);
  const out = JSON.stringify(merged, null, 2) + "\n";

  if (dryRun) {
    console.log("\n" + (out.length > 3500 ? out.slice(0, 3500) + "\n… (truncated)" : out));
    printInfo(
      `[dry-run] ${provider.models.length} model(s) under providers.omniroute → ${configPath}`
    );
    return 0;
  }
  mkdirSync(join(configPath, ".."), { recursive: true });
  writeFileSync(configPath, out, "utf8");
  printSuccess(`Wrote ${configPath} (${provider.models.length} models under providers.omniroute)`);
  printInfo(
    "Provide the key (config references $OMNIROUTE_API_KEY):  export OMNIROUTE_API_KEY=..."
  );
  printInfo("Then run:  crush");
  return 0;
}

export function registerSetupCrush(program) {
  program
    .command("setup-crush")
    .description("Generate the OmniRoute openai-compat provider in ~/.config/crush/crush.json")
    .option("--port <port>", "Local OmniRoute port (ignored when --remote is set)", "20128")
    .option("--remote <url>", "Remote OmniRoute URL, e.g. http://192.168.0.15:20128")
    .option("--api-key <key>", "OmniRoute API key (defaults to OMNIROUTE_API_KEY env var)")
    .option("--only <patterns>", "Comma-separated substrings — keep only matching model IDs")
    .option("--config-path <path>", "crush.json path (default: ~/.config/crush/crush.json)")
    .option("--dry-run", "Print what would be written without touching the filesystem")
    .option(
      "--allow-container-write",
      "Write even when the target is inside a container and not mounted from the host"
    )
    .action(async (opts) => {
      const code = await runSetupCrushCommand(opts);
      if (code !== 0) process.exit(code);
    });
}