pulumi-package-docs 0.4.0 → 0.6.0

package/README.md

@@ -16,11 +16,21 @@ pulumi-package-docs [options]
   -d, --dir <path>   Pulumi project directory to inspect (default: current directory)
   -p, --port <port>  Port to serve on (default: 3000)
   --host             Expose the server on your network
+  --open             Open the docs in your default browser once ready
   -h, --help         Show this help message
 ```
 
 Requires the `pulumi` CLI to be installed and on `PATH`; it's used to fetch each provider's schema (`pulumi package get-schema`). If a schema was fetched successfully before, it's cached and reused if a later CLI call fails.
 
+### Standalone binary
+
+Each [release](https://github.com/pierskarsenbarg/pulumi-package-docs/releases) also includes standalone executables (macOS arm64/x64, Linux x64/arm64, Windows x64) built with Bun — no Node.js install required. Download the one for your platform, make it executable, and run it the same way:
+
+```bash
+chmod +x pulumi-package-docs-darwin-arm64
+./pulumi-package-docs-darwin-arm64 --dir /path/to/pulumi/project
+```
+
 ## MCP
 
 The server also exposes an [MCP](https://modelcontextprotocol.io) endpoint at `/mcp` (Streamable HTTP), so a coding agent can look up the same local provider docs without browsing the site. Point an MCP client at `http://localhost:3000/mcp` (e.g. in Claude Code, `claude mcp add --transport http pulumi-package-docs http://localhost:3000/mcp`). Tools:
@@ -57,4 +67,9 @@ Build the production app with:
 npm run build
 ```
 
-`bin/cli.js` is the `npx` entry point: it serves the production build with `vite preview` if one exists (`npm run build` first), otherwise falls back to `vite dev`.
+`bin/cli.js` is the `npx` entry point: it serves the production build with `vite preview` if one exists (`npm run build` first), otherwise falls back to `vite dev`. `bin/cli-bun.js` is a separate entry point used to build the standalone Bun executables (see above); it serves the built SSR handler directly with `Bun.serve` instead of shelling out to Vite. Build one locally with:
+
+```bash
+npm run build
+npm run compile:bun
+```

package/bin/args.js

@@ -0,0 +1,35 @@
+import { resolve } from 'node:path'
+
+export function parseArgs(argv) {
+  const options = { dir: process.cwd(), port: '3000', host: false, open: false }
+  for (let i = 0; i < argv.length; i++) {
+    const arg = argv[i]
+    if (arg === '--dir' || arg === '-d') {
+      options.dir = resolve(argv[++i])
+    } else if (arg === '--port' || arg === '-p') {
+      options.port = argv[++i]
+    } else if (arg === '--host') {
+      options.host = true
+    } else if (arg === '--open') {
+      options.open = true
+    } else if (arg === '--help' || arg === '-h') {
+      options.help = true
+    }
+  }
+  return options
+}
+
+export function printHelp() {
+  console.log(`pulumi-package-docs [options]
+
+Serves local documentation for the parameterized/local Pulumi providers used
+by a Pulumi project.
+
+Options:
+  -d, --dir <path>   Pulumi project directory to inspect (default: current directory)
+  -p, --port <port>  Port to serve on (default: 3000)
+  --host             Expose the server on your network
+  --open             Open the docs in your default browser once ready
+  -h, --help         Show this help message
+`)
+}

package/bin/cli-bun.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env bun
+import { spawn } from 'node:child_process'
+import { parseArgs, printHelp } from './args.js'
+import server from '../dist/server/server.js'
+import embeddedAssets from './embedded-assets.generated.js'
+
+const options = parseArgs(process.argv.slice(2))
+
+if (options.help) {
+  printHelp()
+  process.exit(0)
+}
+
+process.env.PULUMI_LOCAL_DOCS_DIR = options.dir
+
+function openBrowser(url) {
+  const command =
+    process.platform === 'darwin'
+      ? ['open', url]
+      : process.platform === 'win32'
+        ? ['cmd', '/c', 'start', '', url]
+        : ['xdg-open', url]
+  spawn(command[0], command.slice(1), {
+    stdio: 'ignore',
+    detached: true,
+  }).unref()
+}
+
+console.log(`Serving provider docs for: ${options.dir}`)
+
+const bunServer = Bun.serve({
+  port: Number(options.port),
+  hostname: options.host ? '0.0.0.0' : undefined,
+  async fetch(request) {
+    const url = new URL(request.url)
+    const embeddedPath = embeddedAssets[url.pathname]
+    if (embeddedPath) {
+      return new Response(Bun.file(embeddedPath))
+    }
+    return server.fetch(request)
+  },
+})
+
+const localUrl = `http://localhost:${bunServer.port}/`
+console.log(`  ➜  Local:   ${localUrl}`)
+console.log(`  ➜  MCP:     ${new URL('mcp', localUrl)}`)
+
+if (options.open) openBrowser(localUrl)

package/bin/cli.js

@@ -4,41 +4,11 @@ import { createRequire } from 'node:module'
 import { dirname, join, resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
 import { spawn } from 'node:child_process'
+import { parseArgs, printHelp } from './args.js'
 
 const packageRoot = resolve(dirname(fileURLToPath(import.meta.url)), '..')
 const require = createRequire(import.meta.url)
 
-function parseArgs(argv) {
-  const options = { dir: process.cwd(), port: '3000', host: false }
-  for (let i = 0; i < argv.length; i++) {
-    const arg = argv[i]
-    if (arg === '--dir' || arg === '-d') {
-      options.dir = resolve(argv[++i])
-    } else if (arg === '--port' || arg === '-p') {
-      options.port = argv[++i]
-    } else if (arg === '--host') {
-      options.host = true
-    } else if (arg === '--help' || arg === '-h') {
-      options.help = true
-    }
-  }
-  return options
-}
-
-function printHelp() {
-  console.log(`pulumi-package-docs [options]
-
-Serves local documentation for the parameterized/local Pulumi providers used
-by a Pulumi project.
-
-Options:
-  -d, --dir <path>   Pulumi project directory to inspect (default: current directory)
-  -p, --port <port>  Port to serve on (default: 3000)
-  --host             Expose the server on your network
-  -h, --help         Show this help message
-`)
-}
-
 const options = parseArgs(process.argv.slice(2))
 
 if (options.help) {
@@ -58,6 +28,7 @@ const viteArgs = [
   options.port,
 ]
 if (options.host) viteArgs.push('--host')
+if (options.open) viteArgs.push('--open')
 
 if (!hasProductionBuild) {
   console.log(

package/bin/generate-embedded-assets.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+// Generates bin/embedded-assets.generated.js: a module that statically
+// imports every file under dist/client with `{ type: "file" }`, so `bun
+// build --compile` embeds them into the standalone executable. Must run
+// after `npm run build` (dist/client must exist) and before
+// `bun build --compile ./bin/cli-bun.js`.
+import { readdirSync, statSync, writeFileSync } from 'node:fs'
+import { dirname, join, relative, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const packageRoot = resolve(dirname(fileURLToPath(import.meta.url)), '..')
+const clientDir = join(packageRoot, 'dist', 'client')
+const outFile = join(packageRoot, 'bin', 'embedded-assets.generated.js')
+
+function walk(dir) {
+  const files = []
+  for (const entry of readdirSync(dir)) {
+    const full = join(dir, entry)
+    if (statSync(full).isDirectory()) {
+      files.push(...walk(full))
+    } else {
+      files.push(full)
+    }
+  }
+  return files
+}
+
+const files = walk(clientDir)
+const lines = []
+const entries = []
+
+files.forEach((file, i) => {
+  const urlPath = `/${relative(clientDir, file).split('\\').join('/')}`
+  const importPath = `../dist/client/${relative(clientDir, file).split('\\').join('/')}`
+  const name = `asset${i}`
+  lines.push(
+    `import ${name} from ${JSON.stringify(importPath)} with { type: 'file' }`,
+  )
+  entries.push(`  ${JSON.stringify(urlPath)}: ${name},`)
+})
+
+const source = `${lines.join('\n')}
+
+export default {
+${entries.join('\n')}
+}
+`
+
+writeFileSync(outFile, source)
+console.log(
+  `Wrote ${files.length} embedded asset imports to ${relative(packageRoot, outFile)}`,
+)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pulumi-package-docs",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Local documentation viewer for the parameterized/local Pulumi providers used by a Pulumi project.",
   "type": "module",
   "license": "MIT",
@@ -31,7 +31,7 @@
     "build": "vite build",
     "preview": "vite preview",
     "start": "node bin/cli.js",
-    "prepublishOnly": "npm run build",
+    "compile:bun": "node bin/generate-embedded-assets.js && bun build ./bin/cli-bun.js --compile --outfile pulumi-package-docs",
     "test": "vitest run",
     "test:watch": "vitest",
     "lint": "oxlint",