@rivetkit/engine-cli 0.0.0-main.d6a0ba8

package/README.md

@@ -0,0 +1,27 @@
+# @rivetkit/engine-cli
+
+Platform-specific rivet-engine binary distribution. Shipped as a set of
+`@rivetkit/engine-cli-<platform>` packages. The meta package at
+`@rivetkit/engine-cli` exposes `getEnginePath()` which returns the absolute
+path to the binary for the current host.
+
+## Supported platforms
+
+- `linux-x64-musl` — Linux x86_64 (static, runs on any distro)
+- `linux-arm64-musl` — Linux aarch64 (static)
+- `darwin-x64` — macOS Intel
+- `darwin-arm64` — macOS Apple Silicon
+- `win32-x64` — Windows x64 on release versions only
+
+Preview tags do not publish the Windows platform package. On preview builds,
+use the PowerShell installer from `https://releases.rivet.dev` or point
+`RIVET_ENGINE_BINARY` at a local `rivet-engine.exe`.
+
+## Usage
+
+```js
+const { getEnginePath } = require("@rivetkit/engine-cli");
+const { spawn } = require("node:child_process");
+
+const child = spawn(getEnginePath(), ["start"]);
+```

package/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Returns the absolute path to the rivet-engine binary for the current host.
+ *
+ * Resolution order:
+ *   1. `RIVET_ENGINE_BINARY` env var (absolute path override)
+ *   2. Local `rivet-engine` binary next to this package (dev builds)
+ *   3. The platform-specific `@rivetkit/engine-cli-<platform>` npm package
+ *
+ * Throws if none of the above yields a binary.
+ */
+export function getEnginePath(): string;
+
+/** Returns the expected name of the platform-specific npm package for the current host, or null if unsupported. */
+export function getPlatformPackageName(): string | null;

package/index.js

@@ -0,0 +1,106 @@
+/**
+ * @rivetkit/engine-cli
+ *
+ * Platform-specific rivet-engine binary resolver. The binary itself is shipped
+ * in one of several `@rivetkit/engine-cli-<platform>` packages as an
+ * optionalDependency — npm only installs the one matching the current
+ * `os`/`cpu`/`libc` at install time.
+ *
+ * Priority at resolve time:
+ *   1. `RIVET_ENGINE_BINARY` env var (absolute path override for debugging)
+ *   2. Local `rivet-engine` binary next to this package (dev builds)
+ *   3. The platform-specific `@rivetkit/engine-cli-<platform>` npm package
+ */
+const { existsSync } = require("node:fs");
+const { dirname, join } = require("node:path");
+
+/** Returns the name of the platform-specific npm package for the current host. */
+function getPlatformPackageName() {
+	const { platform, arch } = process;
+	switch (platform) {
+		case "linux":
+			// Engine is statically linked against musl, so the single musl
+			// build runs on both Alpine/musl and glibc hosts. We only publish
+			// the musl variant and every linux host maps to it.
+			if (arch === "x64") return "@rivetkit/engine-cli-linux-x64-musl";
+			if (arch === "arm64") return "@rivetkit/engine-cli-linux-arm64-musl";
+			break;
+		case "darwin":
+			if (arch === "x64") return "@rivetkit/engine-cli-darwin-x64";
+			if (arch === "arm64") return "@rivetkit/engine-cli-darwin-arm64";
+			break;
+		case "win32":
+			if (arch === "x64") return "@rivetkit/engine-cli-win32-x64";
+			break;
+	}
+	return null;
+}
+
+/** The binary filename inside each platform package. */
+const BINARY_NAME =
+	process.platform === "win32" ? "rivet-engine.exe" : "rivet-engine";
+
+/**
+ * Returns the absolute path to the rivet-engine binary for the current host.
+ * @returns {string}
+ */
+function getEnginePath() {
+	// 1) Env var override.
+	if (process.env.RIVET_ENGINE_BINARY) {
+		if (!existsSync(process.env.RIVET_ENGINE_BINARY)) {
+			throw new Error(
+				`RIVET_ENGINE_BINARY is set to ${process.env.RIVET_ENGINE_BINARY} but the file does not exist`,
+			);
+		}
+		return process.env.RIVET_ENGINE_BINARY;
+	}
+
+	// 2) Local binary next to this package (dev flow: copy from cargo target).
+	const localBinary = join(__dirname, BINARY_NAME);
+	if (existsSync(localBinary)) {
+		return localBinary;
+	}
+
+	// 3) Platform-specific npm package.
+	const platformPkg = getPlatformPackageName();
+	if (!platformPkg) {
+		if (process.platform === "win32" && process.arch === "x64") {
+			throw new Error(
+				"@rivetkit/engine-cli: Windows x64 is not yet supported via npm platform packages.\n" +
+					"Use the PowerShell installer from releases.rivet.dev or set RIVET_ENGINE_BINARY\n" +
+					"to a local rivet-engine.exe binary.",
+			);
+		}
+		throw new Error(
+			`@rivetkit/engine-cli: unsupported platform ${process.platform}/${process.arch}`,
+		);
+	}
+	let pkgJsonPath;
+	try {
+		pkgJsonPath = require.resolve(`${platformPkg}/package.json`);
+	} catch {
+		if (process.platform === "win32" && process.arch === "x64") {
+			const version = require("./package.json").version;
+			if (
+				typeof version === "string" &&
+				(version.includes("-pr.") || version.includes("-main."))
+			) {
+				throw new Error(
+					"@rivetkit/engine-cli: Windows x64 binaries are only published for release versions.\n" +
+						`The current package version (${version}) is a preview build, so @rivetkit/engine-cli-win32-x64 was intentionally not published.\n` +
+						"Use a proper release, the PowerShell installer from releases.rivet.dev, or set RIVET_ENGINE_BINARY to a local rivet-engine.exe binary.",
+				);
+			}
+		}
+		throw new Error(
+			`@rivetkit/engine-cli: platform package ${platformPkg} is not installed.\n` +
+				`This usually means the platform is not supported or optionalDependencies\n` +
+				`were skipped during install. Try: npm install --include=optional ${platformPkg}\n` +
+				`Or set RIVET_ENGINE_BINARY to a local rivet-engine binary.`,
+		);
+	}
+	return join(dirname(pkgJsonPath), BINARY_NAME);
+}
+
+module.exports.getEnginePath = getEnginePath;
+module.exports.getPlatformPackageName = getPlatformPackageName;

package/package.json

@@ -0,0 +1,23 @@
+{
+	"name": "@rivetkit/engine-cli",
+	"version": "0.0.0-main.d6a0ba8",
+	"description": "Rivet Engine binary distributed as platform-specific npm packages",
+	"license": "Apache-2.0",
+	"main": "index.js",
+	"types": "index.d.ts",
+	"engines": {
+		"node": ">= 20.0.0"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts",
+		"package.json",
+		"README.md"
+	],
+	"optionalDependencies": {
+		"@rivetkit/engine-cli-darwin-arm64": "0.0.0-main.d6a0ba8",
+		"@rivetkit/engine-cli-darwin-x64": "0.0.0-main.d6a0ba8",
+		"@rivetkit/engine-cli-linux-arm64-musl": "0.0.0-main.d6a0ba8",
+		"@rivetkit/engine-cli-linux-x64-musl": "0.0.0-main.d6a0ba8"
+	}
+}