@bytesbrains/cruise 0.0.0-stage → 0.12.0

package/dist/tenant-4YDGI23Q.mjs

@@ -0,0 +1,122 @@
+#!/usr/bin/env node
+// Built by packages/cli/build.ts.
+import {
+  assertGateway,
+  listTenants,
+  prepaidOn,
+  prepaySignups,
+  provisionTenant,
+  unprepaidSignups
+} from "./chunk-GUZNI3NS.mjs";
+import "./chunk-N3YKWKOA.mjs";
+import "./chunk-2NVDAK5J.mjs";
+import "./chunk-FGLMW5IY.mjs";
+import "./chunk-4447IUTF.mjs";
+import "./chunk-XOH3XKM3.mjs";
+import "./chunk-42ERHAJD.mjs";
+import "./chunk-BNP63KB2.mjs";
+import "./chunk-ICJVJSTC.mjs";
+import "./chunk-UNXM6FSM.mjs";
+import "./chunk-SYTYOTO4.mjs";
+import "./chunk-O7TNRKSA.mjs";
+import "./chunk-T3ICD43U.mjs";
+import "./chunk-RT4R2W6H.mjs";
+import {
+  formatUsd,
+  usdToMicros
+} from "./chunk-THEXUHQC.mjs";
+import "./chunk-LALZUKEC.mjs";
+import "./chunk-5TVD3ZAI.mjs";
+import {
+  connect,
+  environmentOf,
+  optionalNumber,
+  parseArgs,
+  requireString,
+  run
+} from "./chunk-7NQHBXVZ.mjs";
+import "./chunk-JZPUTXM7.mjs";
+
+// scripts/tenant.ts
+function describe(tenant) {
+  console.log(`${tenant.id}  "${tenant.name}"  tier ${tenant.tier}  ${tenant.billable ? "billable" : "not billable"}`);
+  for (const project of tenant.projects) {
+    const soft = project.softMicros === null ? "\u2014" : `$${formatUsd(project.softMicros)}`;
+    const hard = project.hardMicros === null ? "UNCAPPED" : `$${formatUsd(project.hardMicros)}`;
+    console.log(`  project ${project.id}  ${project.gateway}  soft ${soft}  hard ${hard} per ${project.period ?? "\u2014"}`);
+    if (project.hardMicros === null) console.log(`  warning: ${project.id} has no hard cap and is serving uncapped.`);
+  }
+  for (const member of tenant.members) console.log(`  ${member.role.padEnd(6)} ${member.uid}`);
+  if (tenant.members.length === 0) console.log(`  warning: no members. Nobody can reach /admin for this tenant.`);
+}
+run(async () => {
+  const [command, ...rest] = process.argv.slice(2);
+  const args = parseArgs(rest);
+  const environment = environmentOf(args);
+  const db = connect(environment);
+  switch (command) {
+    case "provision": {
+      const hard = optionalNumber(args, "hard");
+      const soft = optionalNumber(args, "soft");
+      const { created, tenant, ownerConflict } = await provisionTenant(
+        db,
+        {
+          id: requireString(args, "id"),
+          name: requireString(args, "name"),
+          ownerUid: requireString(args, "uid"),
+          // Spread rather than `undefined`, because an absent flag must not be
+          // the same value as one that was given — `exactOptionalPropertyTypes`.
+          ...typeof args.gateway === "string" ? { gateway: assertGateway(args.gateway) } : {},
+          ...typeof args.tier === "string" ? { tier: args.tier } : {},
+          ...hard === null ? {} : { hardMicros: usdToMicros(hard) },
+          ...soft === null ? {} : { softMicros: usdToMicros(soft) }
+        },
+        requireString(args, "actor")
+      );
+      console.log(created ? `provisioned ${tenant.id}` : `${tenant.id} already exists \u2014 nothing changed`);
+      describe(tenant);
+      if (ownerConflict !== void 0) {
+        console.log(
+          `  note: ${ownerConflict.given} was granted nothing \u2014 ${tenant.id} is owned by ${ownerConflict.owners.join(", ") || "nobody"}. Grant it with: npm run member:grant`
+        );
+      }
+      if (created) {
+        console.log(`next: npm run key:issue -- --project ${tenant.projects[0]?.id} --name "<what uses it>"`);
+      }
+      break;
+    }
+    case "list": {
+      const tenants = await listTenants(db);
+      if (tenants.length === 0) {
+        console.log("no tenants.");
+        break;
+      }
+      for (const tenant of tenants) describe(tenant);
+      break;
+    }
+    case "prepay": {
+      const line = (t) => `  ${t.id}  no wallet \u2014 serving without credit  ${t.billable ? "billable" : "not billable"}`;
+      if (!prepaidOn(environment)) {
+        console.log(`signup on ${environment} is not prepaid, by design \u2014 nothing to do.`);
+        break;
+      }
+      if (args.apply !== true) {
+        const pending = await unprepaidSignups(db);
+        if (pending.length === 0) console.log("every signup tenant is prepaid \u2014 nothing to do.");
+        for (const tenant of pending) console.log(line(tenant));
+        if (pending.length > 0) console.log(`
+${pending.length} to change. Re-run with --apply --actor <you> to write them.`);
+        break;
+      }
+      const done = await prepaySignups(db, environment, requireString(args, "actor"));
+      for (const tenant of done) {
+        console.log(`  ${tenant.id}  wallet written at $0  ${tenant.billable ? "billable already" : "billable set"}`);
+      }
+      console.log(done.length === 0 ? "every signup tenant is prepaid \u2014 nothing to do." : `${done.length} prepaid.`);
+      break;
+    }
+    default:
+      console.error("usage: provision | list | prepay  (see scripts/tenant.ts)");
+      process.exitCode = 1;
+  }
+});

package/dist/tier-4L3SPLFP.mjs

@@ -0,0 +1,116 @@
+#!/usr/bin/env node
+// Built by packages/cli/build.ts.
+import {
+  connect,
+  environmentOf,
+  parseArgs,
+  requireString,
+  run
+} from "./chunk-7NQHBXVZ.mjs";
+import "./chunk-JZPUTXM7.mjs";
+
+// src/tiers.ts
+var TierRefused = class extends Error {
+  constructor(code, message, over = []) {
+    super(message);
+    this.code = code;
+    this.over = over;
+    this.name = "TierRefused";
+  }
+  code;
+  over;
+};
+async function usageOf(db, tenantId) {
+  const row = await db.prepare(
+    `SELECT (SELECT count(*) FROM projects WHERE tenant_id = ?1) AS projects,
+              (SELECT count(*) FROM lanes WHERE tenant_id = ?1 AND archived_at IS NULL) AS lanes,
+              COALESCE((SELECT max(n) FROM (
+                SELECT count(*) AS n FROM lane_members lm
+                  JOIN lanes l ON l.id = lm.lane_id
+                 WHERE l.tenant_id = ?1 AND l.archived_at IS NULL
+                 GROUP BY lm.lane_id)), 0) AS members`
+  ).bind(tenantId).first();
+  return row ?? { projects: 0, lanes: 0, members: 0 };
+}
+async function setTier(db, tenantId, tier, actor, via) {
+  const tenant = await db.prepare(`SELECT tier FROM tenants WHERE id = ?`).bind(tenantId).first();
+  if (tenant === null) throw new TierRefused("tenant_unknown", `No such tenant: ${tenantId}`);
+  const target = await db.prepare(`SELECT id, lanes, members_per_lane, projects FROM tiers WHERE id = ?`).bind(tier).first();
+  if (target === null) throw new TierRefused("tier_unknown", `No such tier: ${tier}`);
+  const usage = await usageOf(db, tenantId);
+  const over = [];
+  if (target.projects !== null && usage.projects > target.projects) {
+    over.push({ limit: "projects", used: usage.projects, allowed: target.projects });
+  }
+  if (target.lanes !== null && usage.lanes > target.lanes) {
+    over.push({ limit: "lanes", used: usage.lanes, allowed: target.lanes });
+  }
+  if (target.members_per_lane !== null && usage.members > target.members_per_lane) {
+    over.push({ limit: "members_per_lane", used: usage.members, allowed: target.members_per_lane });
+  }
+  if (over.length > 0) {
+    const said = over.map(
+      (o) => o.limit === "members_per_lane" ? `a lane with ${o.used} members against a limit of ${o.allowed}` : `${o.used} ${o.limit} against a limit of ${o.allowed}`
+    );
+    throw new TierRefused(
+      "tier_quota_exceeded",
+      `'${tenantId}' does not fit '${tier}': ${said.join("; ")}. Quotas are checked at the write, so this would leave the tenant in violation without failing anything.`,
+      over
+    );
+  }
+  await db.batch([
+    db.prepare(`UPDATE tenants SET tier = ?2 WHERE id = ?1`).bind(tenantId, tier),
+    db.prepare(
+      `INSERT INTO audit_events (id, actor, action, subject, detail, tenant_id)
+         VALUES (?1, ?2, 'tenant.tier', ?3, ?4, ?3)`
+    ).bind(
+      crypto.randomUUID(),
+      actor,
+      tenantId,
+      JSON.stringify({
+        from: tenant.tier,
+        to: tier,
+        usage_at_change: usage,
+        ...via === void 0 ? {} : { via }
+      })
+    )
+  ]);
+  return { from: tenant.tier, to: tier };
+}
+
+// scripts/tier.ts
+run(async () => {
+  const [command, ...rest] = process.argv.slice(2);
+  const args = parseArgs(rest);
+  const db = connect(environmentOf(args));
+  switch (command) {
+    case "set": {
+      const tenant = requireString(args, "tenant");
+      const tier = requireString(args, "tier");
+      const actor = requireString(args, "actor");
+      const { from, to } = await setTier(db, tenant, tier, actor);
+      console.log(from === to ? `${tenant} was already on '${to}'.` : `${tenant}: '${from}' \u2192 '${to}'.`);
+      return;
+    }
+    case "show":
+    default: {
+      const { results } = await db.prepare(
+        `SELECT n.id, n.tier,
+                  COALESCE(t.projects, -1) AS max_projects,
+                  COALESCE(t.lanes, -1)    AS max_lanes,
+                  (SELECT count(*) FROM projects p WHERE p.tenant_id = n.id) AS projects,
+                  (SELECT count(*) FROM lanes l WHERE l.tenant_id = n.id AND l.archived_at IS NULL) AS lanes
+             FROM tenants n LEFT JOIN tiers t ON t.id = n.tier
+            ORDER BY n.id`
+      ).all();
+      const cap = (n) => n < 0 ? "\u221E" : String(n);
+      console.log("tenant           tier         projects      lanes");
+      for (const r of results) {
+        console.log(
+          `${r.id.padEnd(16)} ${r.tier.padEnd(12)} ${`${r.projects}/${cap(r.max_projects)}`.padEnd(13)} ${r.lanes}/${cap(r.max_lanes)}`
+        );
+      }
+      return;
+    }
+  }
+});

package/package.json

@@ -1,6 +1,40 @@
 {
   "name": "@bytesbrains/cruise",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.12.0",
+  "description": "Run Cruise — one OpenAI-compatible endpoint in front of every model provider, with budgets that stop — in Docker or on your own Cloudflare account.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "bin": {
+    "cruise": "dist/cruise.mjs"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/bytesbrains-oss/cruise.git",
+    "directory": "packages/cli"
+  },
+  "homepage": "https://gitlab.com/bytesbrains-oss/cruise",
+  "keywords": [
+    "llm",
+    "openai",
+    "gateway",
+    "ai",
+    "budget",
+    "cloudflare",
+    "docker"
+  ],
+  "cruise": {
+    "wrangler": "4.135.0"
+  },
+  "dependencies": {
+    "@bytesbrains/cruise-worker": "0.12.0"
+  }
+}

package/templates/docker-compose.yml

@@ -0,0 +1,66 @@
+# Cruise, self-hosted. docs/self-hosting.md is the manual.
+#
+#   cp .env.example .env      # add at least one provider key
+#   docker compose up -d
+#   docker compose logs cruise | grep -A12 "Cruise is set up"   # your first key, shown once
+#
+# Then any OpenAI SDK, base_url http://localhost:8787/v1.
+#
+# With a domain and HTTPS for other machines: `docker compose --profile https up -d`
+# after setting CRUISE_DOMAIN in .env. Caddy gets a certificate and forwards to
+# Cruise, which is then told to trust the proxy's X-Forwarded-* headers.
+
+name: cruise
+
+services:
+  cruise:
+    image: ${CRUISE_IMAGE:-registry.gitlab.com/bytesbrains-oss/cruise:latest}
+    restart: unless-stopped
+    env_file:
+      - path: .env
+        required: false
+    environment:
+      CRUISE_TRUST_PROXY: ${CRUISE_TRUST_PROXY:-0}
+      # Inside the container the listener is always 8787: CRUISE_PORT in .env
+      # moves the published port below, and must not move this one with it.
+      CRUISE_PORT: "8787"
+      # What the first-boot banner prints in its base_url.
+      CRUISE_PUBLIC_PORT: ${CRUISE_PORT:-8787}
+    # **Loopback only by default.** Plain HTTP is accepted only for requests
+    # addressed to localhost (selfhost/front.ts), and publishing on 127.0.0.1
+    # means nothing off this machine can connect at all. For other machines, use
+    # the `https` profile below rather than widening this.
+    ports:
+      - "127.0.0.1:${CRUISE_PORT:-8787}:8787"
+    volumes:
+      - cruise-data:/data
+    # Long enough for the drain in selfhost/server.ts: a stream in flight during
+    # `docker compose down` finishes rather than being cut.
+    stop_grace_period: 40s
+    read_only: true
+    tmpfs:
+      - /tmp
+    security_opt:
+      - no-new-privileges:true
+    cap_drop:
+      - ALL
+
+  caddy:
+    profiles: ["https"]
+    image: caddy:2
+    restart: unless-stopped
+    depends_on:
+      cruise:
+        condition: service_healthy
+    # Interpolated even when this profile is off, so it cannot be `:?`-required:
+    # that would stop `docker compose up` for everyone without a domain.
+    command: caddy reverse-proxy --from ${CRUISE_DOMAIN:-localhost} --to cruise:8787
+    ports:
+      - "80:80"
+      - "443:443"
+    volumes:
+      - caddy-data:/data
+
+volumes:
+  cruise-data:
+  caddy-data:

package/templates/env.example

@@ -0,0 +1,44 @@
+# Self-hosted Cruise. Copy to .env, which git ignores, and fill in what you use.
+# docs/self-hosting.md explains each setting.
+
+# ── Providers ────────────────────────────────────────────────────────────────
+# One key per provider you want to route to. A provider with no key here is
+# simply not reachable; nothing else needs configuring.
+PROVIDER_KEY_OPENAI=
+PROVIDER_KEY_ANTHROPIC=
+PROVIDER_KEY_GOOGLE_AI_STUDIO=
+PROVIDER_KEY_DEEPSEEK=
+PROVIDER_KEY_MISTRAL=
+PROVIDER_KEY_GROQ=
+# xAI. The variable is named after the upstream's id, `grok`.
+PROVIDER_KEY_GROK=
+PROVIDER_KEY_OPENROUTER=
+PROVIDER_KEY_MOONSHOT=
+PROVIDER_KEY_PERPLEXITY=
+PROVIDER_KEY_ELEVENLABS=
+
+# ── First boot ───────────────────────────────────────────────────────────────
+# The tenant created when the database is empty, and its project's daily cap.
+# Ignored once a tenant exists.
+CRUISE_TENANT=local
+CRUISE_TENANT_NAME=Local
+CRUISE_DAILY_CAP_USD=5
+
+# ── Network ──────────────────────────────────────────────────────────────────
+# Published on 127.0.0.1 only (docker-compose.yml). For other machines, run the
+# `https` profile with a domain that points here, and trust the proxy:
+#   CRUISE_DOMAIN=cruise.example.com
+#   CRUISE_TRUST_PROXY=1
+CRUISE_PORT=8787
+CRUISE_DOMAIN=
+CRUISE_TRUST_PROXY=0
+
+# ── Operations ───────────────────────────────────────────────────────────────
+# Backups land in the data volume under backups/. 0 disables a job.
+CRUISE_BACKUP_INTERVAL_HOURS=24
+CRUISE_BACKUP_KEEP=7
+CRUISE_SWEEP_INTERVAL_HOURS=24
+CRUISE_SHUTDOWN_GRACE_SECONDS=30
+
+# Optional: error events to your own Sentry project.
+SENTRY_DSN=