@runqk/cli 0.0.0 → 0.1.1

package/README.md

@@ -1,5 +1,34 @@
-# @runqk/cli
+# qk
 
-This 0.0.0 package bootstraps trusted publishing for qk, the Rust task runner.
-It contains no native binary and is not a functional CLI release.
-Future releases are built by https://github.com/Pajn/qk.
+qk (quick) is a standalone task runner written in Rust. It reads
+Nx-compatible workspace configuration and supports dependency ordering,
+affected selection, task caching and run history.
+
+## npm installation
+
+```sh
+npm install --global @runqk/cli
+qk --help
+```
+
+The npm package is `@runqk/cli`; its command is `qk`. Platform binaries are
+installed as optional dependencies from the `@runqk` organization.
+Supported platforms are Linux x64 and arm64, macOS arm64 and Windows x64.
+
+```sh
+qk show projects
+qk run web:build
+qk run-many -t build,test --parallel 4
+qk affected -t build,test --base main
+```
+
+## Cargo installation
+
+```sh
+cargo install qk-cli --locked
+```
+
+The crates.io `0.0.0` version is a metadata-only name reservation.
+Functional Cargo releases start at `0.1.1` and install the `qk` executable.
+
+Licensed under either MIT or Apache-2.0, at your option.

package/bin/qk.js

@@ -1,3 +1,29 @@
 #!/usr/bin/env node
-console.error('@runqk/cli 0.0.0 only bootstraps trusted publishing; the qk executable is not included.');
-process.exitCode = 1;
+'use strict'
+
+const PLATFORMS = {
+  darwin: {
+    arm64: '@runqk/cli-darwin-arm64/qk',
+  },
+  linux: {
+    arm64: '@runqk/cli-linux-arm64/qk',
+    x64: '@runqk/cli-linux-x64/qk',
+  },
+  win32: {
+    x64: '@runqk/cli-win32-x64/qk.exe',
+  },
+}
+
+const binPath = PLATFORMS[process.platform]?.[process.arch]
+
+if (!binPath) {
+  console.error(`Unsupported platform: ${process.platform} ${process.arch}`)
+  process.exit(1)
+}
+
+const bin = require.resolve(binPath)
+const result = require('child_process').spawnSync(bin, process.argv.slice(2), { stdio: 'inherit' })
+if (result.error) {
+  throw result.error
+}
+process.exitCode = result.status ?? 1

package/package.json

@@ -1,29 +1,25 @@
 {
   "name": "@runqk/cli",
-  "version": "0.0.0",
+  "version": "0.1.1",
+  "description": "A fast standalone task runner that reads Nx workspaces",
   "license": "MIT OR Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Pajn/qk.git"
   },
-  "publishConfig": {
-    "access": "public",
-    "tag": "bootstrap",
-    "registry": "https://registry.npmjs.org"
-  },
-  "description": "Trusted publishing bootstrap for qk, a standalone Nx-compatible task runner",
   "bin": {
     "qk": "bin/qk.js"
   },
-  "files": [
-    "bin",
-    "LICENSE-MIT",
-    "LICENSE-APACHE"
-  ],
+  "engines": {
+    "node": ">=14"
+  },
   "optionalDependencies": {
-    "@runqk/cli-linux-x64": "0.0.0",
-    "@runqk/cli-linux-arm64": "0.0.0",
-    "@runqk/cli-darwin-arm64": "0.0.0",
-    "@runqk/cli-win32-x64": "0.0.0"
+    "@runqk/cli-darwin-arm64": "0.1.1",
+    "@runqk/cli-linux-arm64": "0.1.1",
+    "@runqk/cli-linux-x64": "0.1.1",
+    "@runqk/cli-win32-x64": "0.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
   }
-}
+}