@patrick-lai/qareel 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Patrick Lai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,15 @@
-# Temporary Holding Version
+# qareel
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Record polished, trustworthy QA demo videos of a web app from any coding agent.
+
+```sh
+npx @patrick-lai/qareel@latest guide
+```
+
+`guide` walks you through setup and your first recording. Install it for repeated use with `npm install -g @patrick-lai/qareel`, or without Node:
+
+```sh
+curl -fsSL https://github.com/patrick-lai/qareel/releases/latest/download/install.sh | sh
+```
+
+Supported: macOS and Linux on arm64 and x64. The binary for your machine comes from the matching `qareel-<os>-<arch>` package, which npm installs automatically.

package/bin/qareel.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+'use strict';
+
+const childProcess = require('node:child_process');
+const fs = require('node:fs');
+const os = require('node:os');
+const path = require('node:path');
+
+const SUPPORTED = ['darwin-arm64', 'darwin-x64', 'linux-x64', 'linux-arm64'];
+const key = `${process.platform}-${process.arch}`;
+const platformPackage = `qareel-${key}`;
+const version = require('../package.json').version;
+
+function fail(message) {
+  fs.writeSync(2, `qareel: ${message}\n`);
+  process.exit(1);
+}
+
+function isExecutable(file) {
+  try {
+    fs.accessSync(file, fs.constants.X_OK);
+    return fs.statSync(file).isFile();
+  } catch {
+    return false;
+  }
+}
+
+function packageRoot() {
+  try {
+    return path.dirname(require.resolve(`${platformPackage}/package.json`));
+  } catch {
+    return undefined;
+  }
+}
+
+function findBinary() {
+  if (!SUPPORTED.includes(key)) {
+    fail(`qareel runs on macOS and Linux with arm64 or x64; this machine is ${process.platform} ${process.arch}.`);
+  }
+  const root = packageRoot();
+  if (root !== undefined) {
+    const installed = require(path.join(root, 'package.json')).version;
+    if (installed !== version) {
+      fail(`${platformPackage} is version ${installed} but qareel is ${version}.\nFix: npm install ${platformPackage}@${version}`);
+    }
+    const binary = path.join(root, 'bin', 'qareel');
+    if (isExecutable(binary)) {
+      return binary;
+    }
+    fail(`${binary} is missing or not executable.\nFix: npm install ${platformPackage}@${version}`);
+  }
+  const vendored = path.join(__dirname, '..', 'vendor', key, 'bin', 'qareel');
+  if (isExecutable(vendored)) {
+    return vendored;
+  }
+  fail([
+    `the ${key} binary is not installed. npm installs it from the optional package ${platformPackage},`,
+    'which is skipped when optional dependencies are omitted (--omit=optional) or the lockfile came from another platform.',
+    `Fix: npm install ${platformPackage}@${version}`,
+    `Or for a global install: npm install -g @patrick-lai/qareel@${version}`,
+  ].join('\n'));
+}
+
+const binary = findBinary();
+const terminalSignals = ['SIGINT', 'SIGQUIT'];
+const waitForChild = () => {};
+for (const signal of terminalSignals) {
+  process.on(signal, waitForChild);
+}
+const result = childProcess.spawnSync(binary, process.argv.slice(2), { stdio: 'inherit' });
+for (const signal of terminalSignals) {
+  process.removeListener(signal, waitForChild);
+}
+if (result.error) {
+  fail(`could not start ${binary}: ${result.error.message}`);
+}
+if (result.signal) {
+  process.kill(process.pid, result.signal);
+  process.exit(128 + (os.constants.signals[result.signal] || 0));
+}
+process.exit(result.status === null ? 1 : result.status);

package/package.json

@@ -1,6 +1,26 @@
 {
   "name": "@patrick-lai/qareel",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "Record polished, trustworthy QA demo videos of a web app from any coding agent",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/patrick-lai/qareel.git"
+  },
+  "homepage": "https://github.com/patrick-lai/qareel",
+  "bin": {
+    "qareel": "bin/qareel.js"
+  },
+  "files": [
+    "bin/qareel.js"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "qareel-darwin-arm64": "0.2.0",
+    "qareel-darwin-x64": "0.2.0",
+    "qareel-linux-x64": "0.2.0",
+    "qareel-linux-arm64": "0.2.0"
+  }
+}