docdex 0.1.0 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.1.4
+- Version bump for republish (0.1.3 already exists on npm).
+
+## 0.1.3
+- Fixed npm trusted publishing configuration (environment + registry) and aligned version bump.
+
+## 0.1.2
+- Broadened platform coverage in the workflow (musl, Windows) and kept npm version aligned with release tags.
+
+## 0.1.1
+- Updated npm README with clearer install and usage details.
+
 ## 0.1.0
 - Initial npm scaffold for the Docdex CLI (`docdex`/`docdexd` bin).
 - Postinstall downloader to fetch platform-specific `docdexd` binaries.

package/README.md

@@ -1,28 +1,53 @@
-# Docdex (npm)
+# Docdex CLI (npm)
 
-Install the Docdex CLI via npm:
+Docdex is a lightweight, local docs indexer/searcher. It builds and serves a per-repo index of your Markdown/text files—no external services, no uploads.
 
+## Install
 ```bash
+# Global install
 npm i -g docdex
-# or
+
+# One-off use
 npx docdex --version
 ```
 
-Requirements:
+## Requirements
 - Node.js >= 18
-- Supported platforms: macOS (arm64, x64), Linux glibc (arm64, x64). Musl (Alpine) is detected automatically when artifacts are available.
+- Platforms: macOS (arm64, x64), Linux glibc (arm64, x64), Linux musl/Alpine (x64), Windows (x64). ARM64 Windows and Linux musl ARM64 can be added when artifacts are published.
+
+## What this package does
+- Provides a tiny JS launcher (`docdex`/`docdexd`).
+- On install, downloads the prebuilt `docdexd` binary for your platform from the GitHub release that matches the npm package version, storing it under `dist/<platform>/docdexd`.
+
+## What Docdex does
+- Indexes Markdown/text files in your repo (tantivy-based) and stores the index locally.
+- Serves search/snippet APIs over HTTP (`/search`, `/snippet`, `/healthz`) and via CLI commands.
+- Watches files while serving to keep the index fresh.
+- Hardened defaults: loopback bind, optional TLS/auth token, rate limits, strict state-dir perms.
+
+## Quick usage
+```bash
+# Check version
+docdex --version
+
+# Build an index
+docdexd index --repo /path/to/repo
 
-How it works:
-- The package ships a small launcher (`docdex`/`docdexd`); `postinstall` downloads the correct `docdexd` binary for your platform from the GitHub release matching the npm package version.
+# Serve HTTP API with live watching
+docdexd serve --repo /path/to/repo --host 127.0.0.1 --port 46137 --log info
+
+# Ad-hoc search via CLI (JSON)
+docdexd query --repo /path/to/repo --query "otp flow" --limit 5
+```
 
-Environment overrides (optional):
-- `DOCDEX_DOWNLOAD_REPO` — `owner/repo` slug hosting release assets (required if `package.json` repository is still a placeholder).
-- `DOCDEX_DOWNLOAD_BASE` — full base URL for release downloads (defaults to `https://github.com/<repo>/releases/download`).
-- `DOCDEX_VERSION` — force a specific version/tag when testing.
+## Environment overrides (optional)
+- `DOCDEX_DOWNLOAD_REPO` — `owner/repo` slug hosting release assets (defaults to the linked GitHub repo).
+- `DOCDEX_DOWNLOAD_BASE` — custom base URL for release downloads (defaults to `https://github.com/<repo>/releases/download`).
+- `DOCDEX_VERSION` — override version/tag to download (for testing).
 - `DOCDEX_LIBC` — force `gnu` or `musl` on Linux if auto-detection is wrong.
-- `DOCDEX_GITHUB_TOKEN` — token for authenticated GitHub downloads (avoids rate limits/private release issues).
+- `DOCDEX_GITHUB_TOKEN` — token for authenticated GitHub downloads (avoids rate limits/private releases).
 
-Notes:
+## Notes
 - Release assets are expected to be named `docdexd-<platform>.tar.gz` with a matching `.sha256`.
 - License: MIT (see `LICENSE`).
 - Changelog: see `CHANGELOG.md`.

package/bin/docdex.js

@@ -9,7 +9,11 @@ const { detectPlatformKey } = require("../lib/platform");
 
 function run() {
   const platformKey = detectPlatformKey();
-  const binaryPath = path.join(__dirname, "..", "dist", platformKey, "docdexd");
+  const basePath = path.join(__dirname, "..", "dist", platformKey);
+  const binaryPath = path.join(
+    basePath,
+    process.platform === "win32" ? "docdexd.exe" : "docdexd"
+  );
 
   if (!fs.existsSync(binaryPath)) {
     console.error(

package/lib/install.js

@@ -95,7 +95,7 @@ async function main() {
   await download(downloadUrl, tmpFile);
   await extractTarball(tmpFile, distDir);
 
-  const binaryPath = path.join(distDir, "docdexd");
+  const binaryPath = path.join(distDir, process.platform === "win32" ? "docdexd.exe" : "docdexd");
   if (!fs.existsSync(binaryPath)) {
     throw new Error(`Downloaded archive missing binary at ${binaryPath}`);
   }

package/lib/platform.js

@@ -29,6 +29,11 @@ function detectPlatformKey() {
     if (arch === "x64") return `linux-x64-${libc}`;
   }
 
+  if (platform === "win32") {
+    if (arch === "x64") return "win32-x64";
+    if (arch === "arm64") return "win32-arm64";
+  }
+
   throw new Error(`Unsupported platform: ${platform}/${arch}`);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docdex",
-  "version": "0.1.0",
+  "version": "0.1.4",
   "description": "Docdex CLI as an npm-installable binary wrapper.",
   "bin": {
     "docdex": "bin/docdex.js",
@@ -29,7 +29,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/bekirdag/docdex.git"
+    "url": "git+https://github.com/bekirdag/docdex.git"
   },
   "bugs": {
     "url": "https://github.com/bekirdag/docdex/issues"