relayburn 1.10.0 → 2.1.0

package/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to `relayburn`.
 
 ## [Unreleased]
 
+## [2.0.0] - 2026-05-07
+
+### Changed
+
+- `relayburn` now prefers the prebuilt Rust `burn` binary from per-platform `@relayburn/cli-<platform>` packages, with `@relayburn/cli` kept as a fallback for unsupported or missing native packages.
+
 ## [1.6.2] - 2026-05-02
 
 ### Changed

package/README.md

@@ -6,7 +6,12 @@ Install the [`burn`](https://github.com/AgentWorkforce/burn) CLI globally:
 npm i -g relayburn
 ```
 
-This is a thin wrapper that depends on [`@relayburn/cli`](https://www.npmjs.com/package/@relayburn/cli) and exposes the `burn` command. Both names produce the same binary; pick whichever you find easier to type.
+This package is a thin install wrapper. It declares the per-platform
+`@relayburn/cli-<platform>` packages as `optionalDependencies`; npm's
+`os` / `cpu` filters install only the one matching your machine, and the
+`burn` shim resolves and execs the prebuilt Rust binary it ships. If a
+native package is not available, the shim falls back to the generic
+TypeScript `@relayburn/cli` package.
 
 ```sh
 burn --help
@@ -14,4 +19,10 @@ burn summary --since 7d
 burn hotspots --since 7d
 ```
 
-See the project [README](https://github.com/AgentWorkforce/burn#readme) for full documentation.
+Prebuilt platforms: `darwin-arm64`, `darwin-x64`, `linux-arm64-gnu`
+(glibc), `linux-x64-gnu` (glibc). Other hosts use the TypeScript CLI
+fallback. Windows native binary support is tracked in
+[#359](https://github.com/AgentWorkforce/burn/issues/359).
+
+See the project [README](https://github.com/AgentWorkforce/burn#readme)
+for full documentation.

package/bin/burn.js

@@ -1,2 +1,139 @@
 #!/usr/bin/env node
-import '@relayburn/cli/dist/cli.js';
+// Platform-resolving spawner for the `burn` Rust binary. Mirrors the
+// `@relayburn/sdk` napi-rs dispatcher pattern (see
+// `packages/sdk-node/src/binding.cjs`): the umbrella `relayburn` package
+// declares the per-platform packages plus the generic `@relayburn/cli`
+// fallback as `optionalDependencies`, npm installs the matching native
+// package when available, and this script `require.resolve`s the native
+// `burn` binary first, then falls back to the TS CLI when needed.
+//
+// The actual binaries live in `packages/relayburn/npm/<platform>/bin/burn`
+// and are dropped there by the cli-build CI matrix at publish time. They
+// are gitignored at rest.
+//
+// ESM is fine here — the umbrella declares `"type": "module"` and engines
+// pins Node >=22.
+
+import { createRequire } from 'node:module';
+import { spawnSync } from 'node:child_process';
+
+const require = createRequire(import.meta.url);
+
+// Map (process.platform, process.arch) → platform-package short string.
+// Linux glibc-vs-musl detection follows the same `process.report` probe
+// the napi-rs loader uses; we only ship glibc artifacts today, so a musl
+// host falls through to the generic CLI fallback below.
+function detectShort() {
+  const { platform, arch } = process;
+
+  if (platform === 'darwin' && arch === 'arm64') return 'darwin-arm64';
+  if (platform === 'darwin' && arch === 'x64') return 'darwin-x64';
+  if (platform === 'linux' && arch === 'arm64' && !isMusl()) return 'linux-arm64-gnu';
+  if (platform === 'linux' && arch === 'x64' && !isMusl()) return 'linux-x64-gnu';
+
+  // Forward-compat for #359 (Windows). The win32-x64 package is not
+  // published yet, so resolution will fail with the same actionable
+  // error path as any other unsupported platform — but the mapping is
+  // here so #359 only needs to add a matrix leg + optionalDependency,
+  // not touch this dispatcher.
+  if (platform === 'win32' && arch === 'x64') return 'win32-x64';
+
+  return null;
+}
+
+function isMusl() {
+  if (!process.report) return false;
+  try {
+    const { glibcVersionRuntime } = (process.report.getReport() || {}).header || {};
+    return !glibcVersionRuntime;
+  } catch {
+    return false;
+  }
+}
+
+function binSuffix() {
+  return process.platform === 'win32' ? '.exe' : '';
+}
+
+const short = detectShort();
+const fallbackSpecifier = '@relayburn/cli/dist/cli.js';
+const passthroughArgs = process.argv.slice(2);
+
+function formatError(err) {
+  return err && err.message ? err.message : String(err);
+}
+
+function writeResolveFailure(prebuiltError, fallbackError) {
+  if (!short) {
+    process.stderr.write(
+      `relayburn: unsupported prebuilt platform ${process.platform}-${process.arch}.\n` +
+        `Supported prebuilt packages: darwin-arm64, darwin-x64, linux-arm64-gnu (glibc), linux-x64-gnu (glibc).\n` +
+        `Track native Windows support at https://github.com/AgentWorkforce/burn/issues/359.\n` +
+        `Tried generic TypeScript CLI fallback \`${fallbackSpecifier}\`, but it was not installed.\n` +
+        `Reinstall \`relayburn\` with optional dependencies enabled or install \`@relayburn/cli\`.\n` +
+        `\nFallback resolution error: ${formatError(fallbackError)}\n`,
+    );
+    return;
+  }
+
+  const pkg = `@relayburn/cli-${short}`;
+  process.stderr.write(
+    `relayburn: failed to resolve prebuilt \`burn\` binary for ${short}.\n` +
+      `Expected the optional dependency \`${pkg}\` to be installed; it ships the binary\n` +
+      `at \`bin/burn${binSuffix()}\`. This usually means \`npm install\` skipped the optional\n` +
+      `dependency (e.g. \`--no-optional\`, a lockfile pinned without it, or an unsupported\n` +
+      `platform filter).\n` +
+      `Tried generic TypeScript CLI fallback \`${fallbackSpecifier}\`, but it also failed.\n` +
+      `Reinstall \`relayburn\` without \`--no-optional\` and try again.\n` +
+      `\nPrebuilt resolution error: ${formatError(prebuiltError)}\n` +
+      `Fallback resolution error: ${formatError(fallbackError)}\n`,
+  );
+}
+
+let command = null;
+let childArgs = passthroughArgs;
+let prebuiltError = null;
+
+if (short) {
+  const pkg = `@relayburn/cli-${short}`;
+  const binSpecifier = `${pkg}/bin/burn${binSuffix()}`;
+  try {
+    command = require.resolve(binSpecifier);
+  } catch (err) {
+    prebuiltError = err;
+  }
+}
+
+if (!command) {
+  try {
+    command = process.execPath;
+    childArgs = [require.resolve(fallbackSpecifier), ...passthroughArgs];
+  } catch (fallbackError) {
+    writeResolveFailure(prebuiltError, fallbackError);
+    process.exit(1);
+  }
+}
+
+const child = spawnSync(command, childArgs, {
+  stdio: 'inherit',
+  windowsHide: false,
+});
+
+if (child.error) {
+  process.stderr.write(`relayburn: failed to spawn \`burn\`: ${child.error.message}\n`);
+  process.exit(1);
+}
+
+// Propagate signal exits the same way Node's own child-process docs
+// recommend — POSIX shells map signal-terminated children to
+// `128 + signo`, and many CI environments key off that exact code.
+if (child.signal) {
+  // `os.constants.signals` is the Node-side mapping, but it's keyed by
+  // signal name and we have it in hand already; defer to the standard
+  // 128+signo formula via `process.kill` fallback for unknown names.
+  const { constants } = await import('node:os');
+  const signo = constants.signals[child.signal];
+  process.exit(typeof signo === 'number' ? 128 + signo : 1);
+}
+
+process.exit(child.status ?? 1);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "relayburn",
-  "version": "1.10.0",
-  "description": "Token usage & cost attribution for agent CLIs (installs the `burn` command)",
+  "version": "2.1.0",
+  "description": "Token usage & cost attribution for agent CLIs (installs the `burn` command). Resolves a prebuilt Rust binary from the `@relayburn/cli-<platform>` packages with a TypeScript CLI fallback.",
   "type": "module",
   "bin": {
     "burn": "./bin/burn.js"
@@ -12,11 +12,17 @@
     "CHANGELOG.md",
     "package.json"
   ],
+  "scripts": {
+    "build": "chmod +x bin/burn.js"
+  },
   "engines": {
     "node": ">=22"
   },
-  "dependencies": {
-    "@relayburn/cli": "1.10.0"
+  "optionalDependencies": {
+    "@relayburn/cli-darwin-arm64": "2.1.0",
+    "@relayburn/cli-darwin-x64": "2.1.0",
+    "@relayburn/cli-linux-arm64-gnu": "2.1.0",
+    "@relayburn/cli-linux-x64-gnu": "2.1.0"
   },
   "repository": {
     "type": "git",
@@ -25,8 +31,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "scripts": {
-    "build": "chmod +x bin/burn.js"
   }
-}
+}