squirrelscan 0.0.17 → 0.0.18

package/README.md

@@ -4,7 +4,7 @@
 
 **CLI Website Audits for Humans, Agents & LLMs**
 
-A comprehensive website audit tool for SEO, performance, accessibility, content, and more. Built from the ground up for AI coding agents and developer workflows.
+[squirrelscan](https://squirrelscan.com) is a comprehensive website audit tool for SEO, performance, accessibility, content, and more. Built from the ground up for AI coding agents and developer workflows.
 
 ## Features
 
@@ -26,27 +26,37 @@ Run audits directly in your terminal:
 squirrel audit example.com
 ```
 
-### 2. Pipe to AI
+### 2. AI Coding Agent Skill
 
-Pipe clean output to any AI assistant:
+Install the skill for autonomous workflows:
 
 ```bash
-squirrel audit example.com --format text | claude
+npx skills install squirrelscan/skills
 ```
 
-### 3. AI Agent Skill
-
-Install the skill for autonomous workflows:
+Use the slash command:
 
-```bash
-npx skills install squirrelscan/skills
 ```
+/audit-website
+```
+
+Or prompt your AI agent more specifically:
 
-Then prompt your AI agent:
 ```
-Use the audit-website skill to audit this site and fix all issues
+Use the audit-website skill to audit this site and fix all issues but only crawl 10 pages
 ```
 
+More information [in the skills repository](https://github.com/squirrelscan/skills) and our [Getting started with AI Agents](https://docs.squirrelscan.com/agents) documentation.
+
+### 3. Pipe to AI agent
+
+Pipe clean output to any AI assistant:
+
+```bash
+squirrel audit example.com --format llm | claude
+```
+
+
 ## Installation
 
 **npm (all platforms):**
@@ -79,7 +89,7 @@ squirrel audit https://example.com
 squirrel audit https://example.com -f html -o report.html
 
 # Pipe to Claude for AI analysis
-squirrel audit https://example.com --format text | claude
+squirrel audit https://example.com --format llm | claude
 
 # Limit pages for faster results
 squirrel audit https://example.com -m 10
@@ -106,7 +116,7 @@ squirrel audit https://example.com -m 10
 | **Schema** | JSON-LD structured data validation |
 | **Mobile** | Viewport, tap targets, responsive design |
 
-And 10 more categories covering video, analytics, i18n, local SEO, and more.
+And 10 more categories covering video, analytics, i18n, local SEO, and more. See the [rules reference](https://docs.squirrelscan.com/rules) on the documentation website.
 
 ## AI Agent Integration
 
@@ -133,6 +143,7 @@ See [AI Agent Integration docs](https://docs.squirrelscan.com/agents) for advanc
 | HTML | `-f html` | Visual reports for sharing |
 | Markdown | `-f markdown` | Documentation, GitHub |
 | Text | `-f text` | Clean output for piping to LLMs |
+| LLM | `-f llm` | LLM optimized output |
 
 ## Development Status
 

package/bin/squirrel.js

@@ -2,22 +2,51 @@
 
 /**
  * squirrel CLI wrapper
- * Executes the platform-specific binary downloaded during npm install
+ * Executes the natively installed binary
  */
 
-const { execFileSync, spawnSync } = require("child_process");
+const { spawnSync } = require("child_process");
 const path = require("path");
 const fs = require("fs");
-const { getBinaryExtension } = require("../lib/platform");
+const os = require("os");
 
-const binaryName = `squirrel${getBinaryExtension()}`;
-const binaryPath = path.join(__dirname, binaryName);
+// Native install locations (checked first) + npm package fallback (checked last)
+const homeDir = os.homedir();
+const isWindows = process.platform === "win32";
+const ext = isWindows ? ".exe" : "";
 
-// Check if binary exists
-if (!fs.existsSync(binaryPath)) {
+// Local npm package binary (fallback if self install failed)
+const localBinary = path.join(__dirname, `squirrel${ext}`);
+
+const binaryLocations = isWindows
+  ? [
+      path.join(homeDir, "AppData", "Local", "squirrel", "bin", "squirrel.exe"),
+      path.join(homeDir, ".local", "bin", "squirrel.exe"),
+      localBinary,
+    ]
+  : [
+      path.join(homeDir, ".local", "bin", "squirrel"),
+      "/usr/local/bin/squirrel",
+      "/opt/homebrew/bin/squirrel",
+      localBinary,
+    ];
+
+// Find binary
+let binaryPath = null;
+for (const loc of binaryLocations) {
+  if (fs.existsSync(loc)) {
+    binaryPath = loc;
+    break;
+  }
+}
+
+if (!binaryPath) {
   console.error("Error: squirrelscan binary not found.");
   console.error("");
-  console.error("The binary should have been downloaded during npm install.");
+  console.error("The binary should have been installed during npm install.");
+  console.error("Expected locations:");
+  binaryLocations.forEach((loc) => console.error(`  - ${loc}`));
+  console.error("");
   console.error("Try reinstalling: npm install -g squirrelscan");
   console.error("");
   console.error("Or install directly:");
@@ -29,18 +58,15 @@ if (!fs.existsSync(binaryPath)) {
 const args = process.argv.slice(2);
 
 try {
-  // Use spawnSync for proper signal handling and stdio inheritance
   const result = spawnSync(binaryPath, args, {
     stdio: "inherit",
     windowsHide: true,
   });
 
-  // Forward exit code
   if (result.status !== null) {
     process.exit(result.status);
   }
 
-  // Handle signal termination
   if (result.signal) {
     process.kill(process.pid, result.signal);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squirrelscan",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "CLI website audits for humans, agents and LLMs",
   "bin": {
     "squirrel": "bin/squirrel.js"

package/scripts/postinstall.js

@@ -2,18 +2,21 @@
 
 /**
  * postinstall script for squirrelscan npm package
- * Downloads the platform-specific binary from GitHub releases
+ * Downloads binary and runs native self-install
+ *
+ * Environment variables:
+ *   SQUIRREL_VERSION   - Pin to specific version (e.g., v0.0.15)
+ *   SQUIRREL_CHANNEL   - Release channel: stable or beta (default: stable)
  */
 
 const https = require("https");
 const fs = require("fs");
 const path = require("path");
 const crypto = require("crypto");
+const { spawnSync } = require("child_process");
 const { getPlatform, getBinaryExtension } = require("../lib/platform");
 
 const REPO = "squirrelscan/squirrelscan";
-const pkg = require("../package.json");
-const VERSION = `v${pkg.version}`;
 
 // Colors for terminal output
 const supportsColor = process.stdout.isTTY;
@@ -32,13 +35,10 @@ const error = (msg) => {
 
 /**
  * HTTPS GET with redirect following
- * @param {string} url
- * @returns {Promise<{data: Buffer, statusCode: number}>}
  */
 function httpsGet(url) {
   return new Promise((resolve, reject) => {
     const request = https.get(url, { headers: { "User-Agent": "squirrelscan-npm" } }, (res) => {
-      // Follow redirects
       if (res.statusCode >= 300 && res.statusCode < 400 && res.headers.location) {
         return httpsGet(res.headers.location).then(resolve).catch(reject);
       }
@@ -64,9 +64,6 @@ function httpsGet(url) {
 
 /**
  * Fetch with retry
- * @param {string} url
- * @param {number} attempts
- * @returns {Promise<Buffer>}
  */
 async function fetchWithRetry(url, attempts = 3) {
   for (let i = 1; i <= attempts; i++) {
@@ -85,29 +82,68 @@ async function fetchWithRetry(url, attempts = 3) {
 }
 
 /**
- * Compute SHA256 hash of buffer
- * @param {Buffer} buffer
- * @returns {string}
+ * Compute SHA256 hash
  */
 function sha256(buffer) {
   return crypto.createHash("sha256").update(buffer).digest("hex");
 }
 
+/**
+ * Get latest version from GitHub releases
+ */
+async function getLatestVersion(channel) {
+  const apiUrl = `https://api.github.com/repos/${REPO}/releases`;
+  info(`Fetching releases (channel: ${channel})...`);
+
+  let releases;
+  try {
+    const data = await fetchWithRetry(apiUrl);
+    releases = JSON.parse(data.toString());
+  } catch (err) {
+    error(`Failed to fetch releases: ${err.message}\n  URL: ${apiUrl}`);
+  }
+
+  if (!releases || releases.length === 0) {
+    error(`No releases found. Check: https://github.com/${REPO}/releases`);
+  }
+
+  let release;
+  if (channel === "stable") {
+    release = releases.find((r) => !r.prerelease);
+  } else {
+    release = releases[0];
+  }
+
+  if (!release) {
+    error(`No releases found for channel '${channel}'`);
+  }
+
+  return release.tag_name;
+}
+
 async function main() {
   const platform = getPlatform();
-  const binDir = path.join(__dirname, "..", "bin");
-  const binaryName = `squirrel${getBinaryExtension()}`;
-  const binaryPath = path.join(binDir, binaryName);
+  const ext = getBinaryExtension();
 
-  log(`Installing squirrelscan ${VERSION} for ${platform}...`);
-
-  // Ensure bin directory exists
-  if (!fs.existsSync(binDir)) {
-    fs.mkdirSync(binDir, { recursive: true });
+  // Write to npm package's bin/ directory (for squirrel.js wrapper fallback)
+  const binDir = path.join(__dirname, "..", "bin");
+  const binaryPath = path.join(binDir, `squirrel${ext}`);
+
+  // Determine version: pinned, channel-based, or package default
+  let version;
+  if (process.env.SQUIRREL_VERSION) {
+    version = process.env.SQUIRREL_VERSION;
+    log(`Installing pinned version: ${version}`);
+  } else {
+    const channel = process.env.SQUIRREL_CHANNEL || "stable";
+    version = await getLatestVersion(channel);
+    log(`Latest version: ${version} (channel: ${channel})`);
   }
 
+  log(`Installing squirrelscan ${version} for ${platform}...`);
+
   // Fetch manifest
-  const releaseUrl = `https://github.com/${REPO}/releases/download/${VERSION}`;
+  const releaseUrl = `https://github.com/${REPO}/releases/download/${version}`;
   const manifestUrl = `${releaseUrl}/manifest.json`;
 
   info("Fetching manifest...");
@@ -122,7 +158,7 @@ async function main() {
   // Get binary info for platform
   const binaryInfo = manifest.binaries?.[platform];
   if (!binaryInfo) {
-    error(`No binary available for platform: ${platform}\n  See: https://github.com/${REPO}/releases/tag/${VERSION}`);
+    error(`No binary available for platform: ${platform}\n  See: https://github.com/${REPO}/releases/tag/${version}`);
   }
 
   const { filename, sha256: expectedSha256 } = binaryInfo;
@@ -146,7 +182,12 @@ async function main() {
   }
   info(`Checksum verified: ${expectedSha256.slice(0, 16)}...`);
 
-  // Write binary
+  // Ensure bin directory exists
+  if (!fs.existsSync(binDir)) {
+    fs.mkdirSync(binDir, { recursive: true });
+  }
+
+  // Write binary to npm's bin/ (serves as fallback for squirrel.js wrapper)
   fs.writeFileSync(binaryPath, binaryData);
 
   // Make executable (Unix only)
@@ -154,8 +195,21 @@ async function main() {
     fs.chmodSync(binaryPath, 0o755);
   }
 
+  // Run self install to set up native layout (~/.local/bin/squirrel, ~/.squirrel/releases/)
+  info("Running self install...");
+  const result = spawnSync(binaryPath, ["self", "install"], {
+    stdio: "inherit",
+    windowsHide: true,
+  });
+
+  // Don't fail npm install if self install fails - binary still works via wrapper fallback
+  if (result.status !== 0) {
+    warn("Native install setup failed, but npm install succeeded");
+    warn("Run 'squirrel self install' manually for full functionality");
+  }
+
   log("Installation complete!");
-  info(`Binary: ${binaryPath}`);
+  info("Run 'squirrel --help' to get started");
 }
 
 main().catch((err) => {