@elmohq/cli 0.2.13 → 0.2.15

package/README.md

@@ -60,6 +60,7 @@ For the full self-hosting walkthrough, see the [Elmo docs](https://www.elmohq.co
 | `elmo init` | Interactive wizard to set up a local Elmo instance |
 | `elmo compose <args...>` | Run any `docker compose` command against your Elmo project (e.g. `elmo compose up -d`, `elmo compose down`, `elmo compose logs -f`, `elmo compose build`, `elmo compose ps`) |
 | `elmo edit <env\|compose>` | Change API keys, scrape targets, or the Docker Compose YAML |
+| `elmo upgrade` | Move your deployment to this CLI's version — runs migrations, re-pins image tags, and restarts the stack |
 
 Run `elmo --help` or `elmo <command> --help` for the full list of flags.
 

package/dist/index.js

@@ -49,6 +49,51 @@ function formatScrapeTarget(config) {
 	return parts.join(":");
 }
 //#endregion
+//#region src/compose-pin.ts
+function renderedByHeader(version) {
+	return [`# Rendered by elmo ${version} on ${(/* @__PURE__ */ new Date()).toISOString()}`, "# Run `elmo upgrade` after upgrading the CLI to refresh this file."].join("\n");
+}
+function parseRenderedVersion(contents) {
+	const match = contents.match(/^# Rendered by elmo (\S+) on /m);
+	return match ? match[1] : null;
+}
+function refreshHeaderVersion(contents, version) {
+	if (!/^# Rendered by elmo \S+ on /m.test(contents)) return `${renderedByHeader(version)}\n${contents}`;
+	return contents.replace(/^# Rendered by elmo \S+ on .*$/m, `# Rendered by elmo ${version} on ${(/* @__PURE__ */ new Date()).toISOString()}`);
+}
+function repinImages(contents, version) {
+	return contents.replace(/(image:\s*elmohq\/elmo-[a-z-]+):\S+/g, `$1:${version}`);
+}
+//#endregion
+//#region src/migrations/planner.ts
+function planMigrations(from, to, all) {
+	if (!semver.valid(from)) throw new Error(`Invalid from version: ${from}`);
+	if (!semver.valid(to)) throw new Error(`Invalid to version: ${to}`);
+	if (semver.gt(from, to)) throw new Error(`Downgrade not supported: ${from} -> ${to}`);
+	if (semver.eq(from, to)) return [];
+	for (const m of all) {
+		if (!semver.valid(m.from)) throw new Error(`Migration has invalid from: ${m.from}`);
+		if (!semver.valid(m.to)) throw new Error(`Migration has invalid to: ${m.to}`);
+		if (!semver.gt(m.to, m.from)) throw new Error(`Migration ${m.from} -> ${m.to}: 'to' must be greater than 'from'`);
+	}
+	const applicable = all.filter((m) => semver.gte(m.from, from) && semver.lt(m.from, to)).slice().sort((a, b) => semver.compare(a.from, b.from));
+	const seen = /* @__PURE__ */ new Set();
+	for (const m of applicable) {
+		if (seen.has(m.from)) throw new Error(`Multiple migrations registered with from=${m.from}`);
+		seen.add(m.from);
+	}
+	return applicable;
+}
+async function runMigrations(plan, ctx) {
+	for (const migration of plan) {
+		ctx.log.step(`Migrating ${migration.from} → ${migration.to}: ${migration.description}`);
+		await migration.run(ctx);
+	}
+}
+//#endregion
+//#region src/migrations/index.ts
+const MIGRATIONS = [];
+//#endregion
 //#region src/telemetry.ts
 const POSTHOG_PUBLIC_KEY = "phc_Jhx9LnI9cTDFHpQmpOzJSDTW127qD9pFU65KRnYym6z";
 const POSTHOG_HOST = "https://us.i.posthog.com";
@@ -156,6 +201,9 @@ async function main() {
 	program.command("edit").description("change API keys, scrape targets, or the Docker Compose YAML").argument("<env|compose>", "which config file to edit").action(async (target, _opts, cmd) => {
 		await runEdit(target, cmd.optsWithGlobals());
 	});
+	program.command("upgrade").description("upgrade your Elmo deployment to this CLI's version").option("--yes", "skip confirmation prompts").action(async (_opts, cmd) => {
+		await runUpgrade(cmd.optsWithGlobals(), version);
+	});
 	await program.parseAsync(process.argv);
 }
 async function withVersionCheck(version, fn) {
@@ -320,7 +368,7 @@ async function runInit(options, version) {
 		postgres_mode: postgresMode,
 		dev_mode: Boolean(options.dev),
 		setup_mode: setupMode,
-		has_scraper: Boolean(env.BRIGHTDATA_API_TOKEN || env.OLOSTEP_API_KEY),
+		has_scraper: Boolean(env.BRIGHTDATA_API_TOKEN || env.OLOSTEP_API_KEY || env.OXYLABS_USERNAME),
 		has_direct_api: hasDirectApiConfigured(env)
 	});
 	if (email) await submitNewsletterSignup(configDir, email);
@@ -329,6 +377,7 @@ async function runInit(options, version) {
 }
 const BRIGHTDATA_AFFILIATE = "https://get.brightdata.com/67h1b7h0shcn";
 const OLOSTEP_AFFILIATE = "https://olostep.com/?ref=elmo";
+const OXYLABS_AFFILIATE = "https://oxylabs.go2cloud.org/aff_c?offer_id=7&aff_id=2263&url_id=32";
 const PROVIDERS_DOC_URL = "https://docs.elmohq.com/docs/user-guide/providers";
 const BRIGHTDATA_MODELS = [
 	"chatgpt",
@@ -347,9 +396,20 @@ const OLOSTEP_MODELS = [
 	"gemini",
 	"grok"
 ];
+const OXYLABS_MODELS = [
+	"chatgpt",
+	"google-ai-mode",
+	"perplexity"
+];
 const DEFAULT_SCRAPER_MODELS = ["chatgpt", "google-ai-mode"];
+const DATAFORSEO_MODELS = [
+	"google-ai-mode",
+	"chatgpt",
+	"perplexity",
+	"gemini"
+];
 const DEFAULT_OPENAI_MODEL = "gpt-5-mini";
-const DEFAULT_ANTHROPIC_MODEL = "claude-sonnet-4-20250514";
+const DEFAULT_ANTHROPIC_MODEL = "claude-sonnet-4-6";
 const DEFAULT_OPENROUTER_MODEL = "anthropic/claude-sonnet-4.6";
 const DEFAULT_MISTRAL_MODEL = "mistral-medium-latest";
 async function configureProvidersInteractive(env) {
@@ -358,6 +418,7 @@ async function configureProvidersInteractive(env) {
 		"",
 		pc.bold("1. A scraper") + " — to track ChatGPT and Google AI Mode (no public APIs):",
 		`     • ${pc.cyan("BrightData")} — cheap solid option, ~$0.45/mo per prompt`,
+		`     • ${pc.cyan("Oxylabs")}    — sync realtime API, pay-as-you-go`,
 		`     • ${pc.cyan("Olostep")}    — premium option, powers Peec/AirOps, ~$2.25/mo per prompt`,
 		"",
 		pc.bold("2. A direct LLM API") + " — for low-latency tasks (onboarding analysis, sentiment scoring,",
@@ -387,13 +448,20 @@ async function configureProvidersRecommended(env) {
 	const targets = [];
 	const scraper = await p.select({
 		message: "Scraper (tracks ChatGPT + Google AI Mode)",
-		options: [{
-			value: "brightdata",
-			label: "BrightData — ~$0.45/mo per prompt (cheaper)"
-		}, {
-			value: "olostep",
-			label: "Olostep — ~$2.25/mo per prompt (premium)"
-		}],
+		options: [
+			{
+				value: "brightdata",
+				label: "BrightData — ~$0.45/mo per prompt (cheaper)"
+			},
+			{
+				value: "oxylabs",
+				label: "Oxylabs — sync realtime API, pay-as-you-go"
+			},
+			{
+				value: "olostep",
+				label: "Olostep — ~$2.25/mo per prompt (premium)"
+			}
+		],
 		initialValue: "brightdata"
 	});
 	assertNotCancelled(scraper);
@@ -441,6 +509,7 @@ async function configureProvidersCustom(env) {
 	}
 	p.log.step(pc.bold("Step 2 of 2 — Scrapers (optional, but needed to track ChatGPT / Google AI Mode)"));
 	await collectBrightData(env, targets);
+	await collectOxylabs(env, targets);
 	await collectOlostep(env, targets);
 	await collectDataForSEO(env, targets);
 	await finalizeScrapeTargets(env, targets);
@@ -457,6 +526,20 @@ async function collectScraperKey(scraper, env) {
 		});
 		assertNotCancelled(key);
 		env.BRIGHTDATA_API_TOKEN = key;
+	} else if (scraper === "oxylabs") {
+		p.log.info(`Sign up: ${link(pc.cyan(OXYLABS_AFFILIATE), OXYLABS_AFFILIATE)}`);
+		const username = await p.text({
+			message: "Oxylabs username",
+			validate: (v) => !v ? "Required" : void 0
+		});
+		assertNotCancelled(username);
+		env.OXYLABS_USERNAME = username;
+		const password = await p.password({
+			message: "Oxylabs password",
+			validate: (v) => !v ? "Required" : void 0
+		});
+		assertNotCancelled(password);
+		env.OXYLABS_PASSWORD = password;
 	} else {
 		p.log.info(`Sign up: ${link(pc.cyan(OLOSTEP_AFFILIATE), OLOSTEP_AFFILIATE)}`);
 		const key = await p.password({
@@ -540,6 +623,33 @@ async function collectOlostep(env, targets) {
 		targets
 	});
 }
+async function collectOxylabs(env, targets) {
+	const enable = await p.confirm({
+		message: `Configure ${pc.bold("Oxylabs")}? (sync realtime API, pay-as-you-go)`,
+		initialValue: false
+	});
+	assertNotCancelled(enable);
+	if (!enable) return;
+	p.log.info(`Sign up and create Web Scraper API credentials: ${link(pc.cyan(OXYLABS_AFFILIATE), OXYLABS_AFFILIATE)}`);
+	const username = await p.text({
+		message: "Oxylabs username",
+		validate: (v) => !v ? "Required" : void 0
+	});
+	assertNotCancelled(username);
+	env.OXYLABS_USERNAME = username;
+	const password = await p.password({
+		message: "Oxylabs password",
+		validate: (v) => !v ? "Required" : void 0
+	});
+	assertNotCancelled(password);
+	env.OXYLABS_PASSWORD = password;
+	await pickScraperTargets({
+		providerLabel: "Oxylabs",
+		providerId: "oxylabs",
+		allModels: OXYLABS_MODELS,
+		targets
+	});
+}
 async function pickScraperTargets(args) {
 	const selected = await p.multiselect({
 		message: `LLM Providers to track via ${args.providerLabel}`,
@@ -687,7 +797,7 @@ async function collectOpenRouter(env, targets) {
 }
 async function collectDataForSEO(env, targets) {
 	const enable = await p.confirm({
-		message: `Configure ${pc.bold("DataForSEO")}? (Google AI Mode scraping)`,
+		message: `Configure ${pc.bold("DataForSEO")}? (Google AI Mode + LLM Responses)`,
 		initialValue: false
 	});
 	assertNotCancelled(enable);
@@ -704,13 +814,18 @@ async function collectDataForSEO(env, targets) {
 	});
 	assertNotCancelled(pwd);
 	env.DATAFORSEO_PASSWORD = pwd;
-	const addTarget = await p.confirm({
-		message: "Also scrape Google AI Mode via DataForSEO? (google-ai-mode:dataforseo:online)",
-		initialValue: false
+	const selected = await p.multiselect({
+		message: "LLM Providers to track via DataForSEO",
+		options: DATAFORSEO_MODELS.map((model) => ({
+			value: model,
+			label: model
+		})),
+		required: false,
+		initialValues: ["google-ai-mode"]
 	});
-	assertNotCancelled(addTarget);
-	if (addTarget) targets.push(formatScrapeTarget({
-		model: "google-ai-mode",
+	assertNotCancelled(selected);
+	for (const model of selected) targets.push(formatScrapeTarget({
+		model,
 		provider: "dataforseo",
 		webSearch: true
 	}));
@@ -817,6 +932,170 @@ async function runEdit(target, options) {
 	});
 	log.info("Restart the stack with `elmo compose up -d` to apply changes.");
 }
+async function runUpgrade(options, cliVersion) {
+	printBanner();
+	p.intro(pc.bold("Upgrading Elmo"));
+	const latestCli = await fetchLatestCliVersion();
+	if (latestCli && semver.valid(cliVersion) && semver.lt(cliVersion, latestCli)) {
+		log.warn(`Your CLI (${cliVersion}) is behind the latest published version (${latestCli}).`);
+		log.info("Recommended: upgrade the CLI first, then rerun this command:");
+		console.log(`  ${pc.bold("npm install -g @elmohq/cli@latest")}`);
+		const proceed = options.yes ? true : await p.confirm({
+			message: `Continue upgrading the stack with CLI ${cliVersion} anyway?`,
+			initialValue: false
+		});
+		assertNotCancelled(proceed);
+		if (!proceed) {
+			p.cancel("Upgrade cancelled. Upgrade the CLI and rerun `elmo upgrade`.");
+			process.exit(0);
+		}
+	}
+	const configDir = await resolveConfigDir(options.dir);
+	const composePath = path.join(configDir, "elmo.yaml");
+	const detectedVersion = await readRenderedVersion(composePath);
+	const fromVersion = detectedVersion ?? cliVersion;
+	if (!semver.valid(fromVersion)) throw new Error(`Could not determine the installed version from ${composePath}.`);
+	if (semver.gt(fromVersion, cliVersion)) {
+		log.warn(`Your deployment (${fromVersion}) is newer than this CLI (${cliVersion}).`);
+		log.info("Upgrade the CLI to match, then rerun:");
+		console.log(`  ${pc.bold("npm install -g @elmohq/cli@latest")}`);
+		process.exit(1);
+	}
+	if (detectedVersion !== null && semver.eq(detectedVersion, cliVersion)) {
+		log.success(`Already at ${cliVersion}.`);
+		const pull = options.yes ? true : await p.confirm({
+			message: "Pull images for this version anyway?",
+			initialValue: false
+		});
+		assertNotCancelled(pull);
+		if (pull) {
+			assertDockerRunning();
+			const wasRunning = await stackHasRunningServices(configDir);
+			log.step("Pulling images...");
+			await runDockerCompose(configDir, ["pull"]);
+			if (wasRunning) {
+				log.step("Restarting services...");
+				await runDockerCompose(configDir, ["up", "-d"]);
+			}
+		}
+		p.outro(pc.green("Nothing to upgrade."));
+		return;
+	}
+	const plan = detectedVersion === null ? [] : planMigrations(fromVersion, cliVersion, MIGRATIONS);
+	if (detectedVersion === null) log.warn(`Couldn't detect the deployment's version — re-pinning images to ${pc.cyan(cliVersion)}.`);
+	else log.info(`Upgrading from ${pc.cyan(fromVersion)} → ${pc.cyan(cliVersion)}`);
+	if (plan.length === 0) log.step("No migrations to run (docker images will be re-pinned and pulled).");
+	else {
+		log.step(`Migrations to apply: ${plan.length}`);
+		for (const m of plan) console.log(`  • ${pc.bold(`${m.from} → ${m.to}`)} ${m.description}`);
+	}
+	const confirm = options.yes ? true : await p.confirm({
+		message: "Proceed with upgrade?",
+		initialValue: true
+	});
+	assertNotCancelled(confirm);
+	if (!confirm) {
+		p.cancel("Upgrade cancelled.");
+		process.exit(0);
+	}
+	assertDockerRunning();
+	const wasRunning = await stackHasRunningServices(configDir);
+	if (wasRunning) {
+		log.step("Stopping services...");
+		await runDockerCompose(configDir, ["down"]);
+	}
+	const ctx = buildMigrationContext(configDir, cliVersion);
+	try {
+		await runMigrations(plan, ctx);
+	} catch (error) {
+		const msg = error instanceof Error ? error.message : String(error);
+		log.error(`Migration failed: ${msg}`);
+		log.info("Your config version was left unchanged. Fix the issue and rerun `elmo upgrade`.");
+		if (wasRunning) log.info("The stack was stopped for the upgrade. Restart with `elmo compose up -d` after fixing.");
+		process.exit(1);
+	}
+	const isDev = await composeUsesBuild(composePath);
+	await repinComposeImages(composePath, cliVersion);
+	await refreshRenderedVersion(path.join(configDir, ".env"), cliVersion);
+	log.success(`Pinned config to ${cliVersion}.`);
+	if (isDev) log.info("Dev mode detected — rebuild with `elmo compose build` to apply the new version.");
+	else {
+		log.step("Pulling images...");
+		await runDockerCompose(configDir, ["pull"]);
+	}
+	if (wasRunning) {
+		log.step("Starting services...");
+		await runDockerCompose(configDir, ["up", "-d"]);
+		const s = p.spinner();
+		s.start("Waiting for services to become healthy...");
+		if (await waitForHealthy(configDir, 18e4)) s.stop("All services healthy!");
+		else {
+			s.stop("Health check timed out.");
+			log.warn("Some services did not report healthy status.");
+		}
+	} else log.info("Stack was stopped before upgrade — leaving it stopped. Start with `elmo compose up -d`.");
+	await trackCliEvent(configDir, "cli_upgrade", {
+		from_version: fromVersion,
+		to_version: cliVersion,
+		migrations_run: plan.length,
+		was_running: wasRunning,
+		dev_mode: isDev
+	});
+	p.outro(pc.green(`Upgraded to ${cliVersion}.`));
+}
+async function stackHasRunningServices(configDir) {
+	try {
+		return (await getComposeServices(configDir)).some((s) => s.State?.startsWith("running") ?? false);
+	} catch {
+		return false;
+	}
+}
+async function readRenderedVersion(filePath) {
+	try {
+		return parseRenderedVersion(await fs.readFile(filePath, "utf8"));
+	} catch {
+		return null;
+	}
+}
+async function composeUsesBuild(composePath) {
+	try {
+		const contents = await fs.readFile(composePath, "utf8");
+		return /^\s*build:/m.test(contents);
+	} catch {
+		return false;
+	}
+}
+async function repinComposeImages(composePath, version) {
+	const contents = await fs.readFile(composePath, "utf8");
+	await fs.writeFile(composePath, refreshHeaderVersion(repinImages(contents, version), version), "utf8");
+}
+async function refreshRenderedVersion(filePath, version) {
+	try {
+		const contents = await fs.readFile(filePath, "utf8");
+		await fs.writeFile(filePath, refreshHeaderVersion(contents, version), "utf8");
+	} catch {}
+}
+function buildMigrationContext(configDir, version) {
+	const envPath = path.join(configDir, ".env");
+	return {
+		configDir,
+		log: {
+			info: (msg) => log.info(msg),
+			warn: (msg) => log.warn(msg),
+			step: (msg) => log.step(msg)
+		},
+		readEnv: async () => {
+			try {
+				return parse(await fs.readFile(envPath, "utf8"));
+			} catch {
+				return {};
+			}
+		},
+		writeEnv: async (env) => {
+			await fs.writeFile(envPath, buildEnvFile(env, version), "utf8");
+		}
+	};
+}
 function buildComposeYaml(options) {
 	const services = [];
 	const volumes = /* @__PURE__ */ new Set();
@@ -1037,9 +1316,6 @@ async function writeConfigFiles(configDir, initConfig) {
 	await fs.writeFile(envPath, buildEnvFile(initConfig.env, initConfig.version), "utf8");
 	await fs.writeFile(composePath, initConfig.composeYaml, "utf8");
 }
-function renderedByHeader(version) {
-	return [`# Rendered by elmo ${version} on ${(/* @__PURE__ */ new Date()).toISOString()}`, "# Re-run `elmo init` after upgrading the CLI to refresh this file."].join("\n");
-}
 function buildEnvFile(env, version) {
 	const lines = [
 		renderedByHeader(version),
@@ -1074,14 +1350,19 @@ async function getPackageVersion() {
 	const contents = await fs.readFile(packagePath, "utf8");
 	return JSON.parse(contents).version;
 }
-async function maybeNotifyNewVersion(currentVersion) {
+async function fetchLatestCliVersion() {
 	try {
 		const response = await fetch("https://registry.npmjs.org/@elmohq/cli/latest");
-		if (!response.ok) return;
-		const data = await response.json();
-		if (!data.version) return;
-		if (semver.valid(currentVersion) && semver.lt(currentVersion, data.version)) log.warn(`New CLI version available (${data.version}). Run: npm install -g @elmohq/cli@latest`);
-	} catch {}
+		if (!response.ok) return null;
+		return (await response.json()).version ?? null;
+	} catch {
+		return null;
+	}
+}
+async function maybeNotifyNewVersion(currentVersion) {
+	const latest = await fetchLatestCliVersion();
+	if (!latest) return;
+	if (semver.valid(currentVersion) && semver.lt(currentVersion, latest)) log.warn(`New CLI version available (${latest}). Run: npm install -g @elmohq/cli@latest`);
 }
 main().catch((error) => {
 	const msg = error instanceof Error ? error.message : String(error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elmohq/cli",
-  "version": "0.2.13",
+  "version": "0.2.15",
   "license": "MIT",
   "keywords": [
     "marketing",
@@ -28,22 +28,24 @@
   ],
   "type": "module",
   "dependencies": {
-    "@clack/prompts": "^1.5.1",
+    "@clack/prompts": "^1.6.0",
     "commander": "^15.0.0",
     "dotenv": "17.4.2",
     "picocolors": "^1.1.1",
-    "posthog-node": "^5.36.4",
-    "semver": "^7.8.2"
+    "posthog-node": "^5.39.2",
+    "semver": "^7.8.5"
   },
   "devDependencies": {
-    "@types/node": "^25.9.2",
+    "@types/node": "^26.1.0",
     "@types/semver": "^7.7.1",
-    "rolldown": "^1.1.0",
+    "rolldown": "^1.1.4",
     "typescript": "^6.0.3",
-    "@workspace/config": "0.2.13"
+    "vitest": "^4.1.9",
+    "@workspace/config": "0.2.15"
   },
   "scripts": {
     "build": "node scripts/build.mjs",
-    "check-types": "tsc -p tsconfig.json"
+    "check-types": "tsc -p tsconfig.json",
+    "test": "vitest run"
   }
 }