pkgref 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # pkgref
 
+## 0.0.2
+
+### Patch Changes
+
+- Fix npx execution and improve package documentation
+
 ## 0.0.1
 
 ### Patch Changes

package/README.md

@@ -1,40 +1,54 @@
 # pkgref
 
-[GitHub repository](https://github.com/yue4u/pkgref)
+Clone dependency source repositories and generate a local index of their docs
+and examples for coding agents and humans.
+
+Requires Node.js 24+ and Git.
+
+## Usage
+
+Run from a project containing `package.json`:
 
 ```sh
-pnpm dlx pkgref
-# list package.json deps in interactive mode for select and clone repo to target dir (default to docs/pkg-reference).
-pnpm dlx pkgref --pkgs=react,vitest --dir docs/repo
-# specify pkg and dir to clone with cli param
-pnpm dlx pkgref update
-# fast-forward all clones in docs/pkg-reference
+npx pkgref
 ```
 
-## Features
+Use the arrow keys to navigate, Space to select packages, and Enter to confirm.
+pkgref then shows the Git URLs, asks for a target directory (default:
+`docs/pkg-reference`), and offers to link the index from `AGENTS.md`.
 
-- list docs/example dir in cloned repo to root as index markdown for search
+Skip prompts by supplying packages and a target:
 
-## Future
+```sh
+npx pkgref --pkgs=react,vitest --dir docs/pkg-reference
+```
 
-- support more than package.json
+Update every clean clone in the target:
 
-## Development
+```sh
+npx pkgref update
+npx pkgref update --dir docs/other-references
+```
 
-- Install dependencies:
+## Output
 
-```bash
-vp install
-```
+Repositories are shallow-cloned and deduplicated. `INDEX.md` links to nested
+`doc`, `docs`, `example`, and `examples` directories, or to the repository root
+when none exist. Reruns preserve earlier index entries.
 
-- Run the unit tests:
+pkgref never overwrites a user-owned index or unrelated path. Existing clones
+with local changes are left untouched. Failures return a nonzero exit code
+without discarding successful work.
 
-```bash
-vp test
-```
+See [SPEC.md](./SPEC.md) for the full behavioral contract.
 
-- Build the library:
+## Development
 
-```bash
+```sh
+vp install
+vp check
+vp test
 vp pack
 ```
+
+[GitHub](https://github.com/yue4u/pkgref)

package/dist/cli.mjs

@@ -1,11 +1,12 @@
 #!/usr/bin/env node
 import { execFile } from "node:child_process";
+import { realpathSync } from "node:fs";
 import { access, mkdir, readFile, readdir, writeFile } from "node:fs/promises";
 import { basename, join, relative, resolve, sep } from "node:path";
 import { parseArgs, promisify } from "node:util";
 import { cancel, confirm, isCancel, multiselect, note, text } from "@clack/prompts";
 //#region package.json
-var version = "0.0.1";
+var version = "0.0.2";
 //#endregion
 //#region src/core.ts
 const INDEX_MARKER = "<!-- generated by pkgref; do not edit -->";
@@ -459,6 +460,6 @@ async function exists(path) {
 		return false;
 	}
 }
-if (import.meta.url === `file://${process.argv[1]}`) process.exitCode = await runCli();
+if (import.meta.filename === realpathSync(process.argv[1])) process.exitCode = await runCli();
 //#endregion
 export { invalidCloneReason, processRepository, pullRepository, resolveRepository, runCli };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pkgref",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Clone dependency source repositories and index their docs and examples.",
   "homepage": "https://github.com/yue4u/pkgref#readme",
   "bugs": {
@@ -34,15 +34,8 @@
     "vite": "npm:@voidzero-dev/vite-plus-core@0.2.5",
     "vite-plus": "0.2.5"
   },
-  "devEngines": {
-    "packageManager": {
-      "name": "pnpm",
-      "version": "11.17.0",
-      "onFail": "download"
-    }
-  },
   "engines": {
-    "node": ">=20"
+    "node": ">=24"
   },
   "scripts": {
     "build": "vp pack",