pi-rg-fd 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Li Tianyu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,60 @@
-# Temporary Holding Version
+# pi-rg-fd
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Pi coding agent extension that rewrites the default system prompt's `grep` and `find` advice to `rg` and `fd` when those tools are on `PATH`.
+
+Pi 1.4's bash tool line names `grep` and `find`, and the default guideline still names `find`, so models reach for those commands even when ripgrep and fd are installed. This package replaces those exact lines in place. The usual prompt gets shorter, and text that is not one of those Pi 1.4 lines is left as Pi wrote it.
+
+## Install
+
+```bash
+pi install npm:pi-rg-fd
+```
+
+For one session without saving the install: `pi -e npm:pi-rg-fd`.
+
+Requires [Pi](https://github.com/earendil-works/pi) 1.4.x (`@earendil-works/pi-coding-agent`).
+
+## Replaced lines
+
+Verified against the published `@earendil-works/pi-coding-agent@1.4.0` sources (`dist/core/tools/bash.js` and `dist/core/system-prompt.js`). These are the only default prompt lines that name the `grep` or `find` commands. The read, edit, write, and ls tool snippets do not. The optional `grep` and `find` tools are separate Pi tools (they already shell out to `rg` and `fd`); their lines are left alone.
+
+Bash tool snippet, before:
+
+```text
+Execute bash commands (ls, grep, find, etc.)
+```
+
+Default guideline (bash enabled, and the grep/find/ls tools off), before:
+
+```text
+Use bash for file operations like ls, rg, find
+```
+
+With both `rg` and `fd` on `PATH`, those become:
+
+```text
+Execute bash commands (ls, rg, fd, etc.)
+Use bash for file operations like ls, rg, fd
+```
+
+Each binary is swapped on its own. `fd` is checked independently of `rg`. On Windows the scan accepts `rg.exe` and `fd.exe` (and the rest of `PATHEXT`). On Debian and Ubuntu, where the package installs `fdfind`, that name is used instead of `fd`.
+
+| On PATH | Bash tool line | Guideline |
+| --- | --- | --- |
+| `rg` and `fd` | `Execute bash commands (ls, rg, fd, etc.)` | `Use bash for file operations like ls, rg, fd` |
+| `rg` only | `Execute bash commands (ls, rg, find, etc.)` | unchanged (it already says `rg`; `find` stays) |
+| `fd` only | `Execute bash commands (ls, grep, fd, etc.)` | `Use bash for file operations like ls, rg, fd` |
+| `fdfind` only | `Execute bash commands (ls, grep, fdfind, etc.)` | `Use bash for file operations like ls, rg, fdfind` |
+| neither | unchanged | unchanged |
+
+`rg` and `fd` are shorter than `grep` and `find`. `fdfind` is two characters longer than `find`, which is the Debian binary's name. If neither line is present (a custom system prompt, or a future Pi release that rewords them), the hook returns without changing the prompt.
+
+Availability is resolved once, when the extension loads, by stating files on `PATH`. The `before_agent_start` hook is a string replace cached by the prompt text, so the same input always yields the same output.
+
+## Prompt text only
+
+`pi-cli-guard` and `pi-prefer-rg` rewrite or block bash commands when the model runs them. `pi-rg-fd` edits the system prompt Pi already built. Commands the model still emits run unchanged.
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,34 @@
+import { detectSearchTools, rewritePrompt } from "./prompt.js";
+
+const CACHE_LIMIT = 8;
+
+/**
+ * @param {{ rg: boolean, fd: "fd" | "fdfind" | null }} [tools]
+ */
+export function createExtension(tools = detectSearchTools()) {
+	/** @type {Map<string, string>} */
+	const cache = new Map();
+
+	return function piRgFd(pi) {
+		if (!tools.rg && !tools.fd) return;
+
+		pi.on("before_agent_start", (event) => {
+			const input = event.systemPrompt;
+			if (typeof input !== "string") return;
+
+			let output = cache.get(input);
+			if (output !== undefined) {
+				cache.delete(input);
+				cache.set(input, output);
+			} else {
+				output = rewritePrompt(input, tools);
+				cache.set(input, output);
+				if (cache.size > CACHE_LIMIT) cache.delete(cache.keys().next().value);
+			}
+
+			if (output !== input) return { systemPrompt: output };
+		});
+	};
+}
+
+export default createExtension();

package/package.json

@@ -1,6 +1,41 @@
 {
   "name": "pi-rg-fd",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Pi extension that rewrites the default grep/find prompt lines to rg and fd when those tools are on PATH.",
+  "type": "module",
+  "main": "index.js",
+  "license": "MIT",
+  "author": "Li Tianyu",
+  "keywords": [
+    "pi-package",
+    "pi",
+    "extension",
+    "ripgrep",
+    "fd"
+  ],
+  "files": [
+    "index.js",
+    "prompt.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TomXPRIME/pi-rg-fd.git"
+  },
+  "homepage": "https://github.com/TomXPRIME/pi-rg-fd",
+  "bugs": {
+    "url": "https://github.com/TomXPRIME/pi-rg-fd/issues"
+  },
+  "engines": {
+    "node": ">=22.19.0"
+  },
+  "scripts": {
+    "test": "node --test"
+  },
+  "pi": {
+    "extensions": [
+      "./index.js"
+    ]
+  }
+}

package/prompt.js

@@ -0,0 +1,126 @@
+import { statSync } from "node:fs";
+import path from "node:path";
+
+/**
+ * Default bash tool line in @earendil-works/pi-coding-agent 1.4.0
+ * (`bashToolSystemPromptContribution.snippet`).
+ */
+export const BASH_SNIPPET = "Execute bash commands (ls, grep, find, etc.)";
+
+/**
+ * Default guideline in Pi 1.4.0 when bash is enabled and the grep, find, and
+ * ls tools are not (`buildRules` in `system-prompt.js`).
+ */
+export const BASH_RULE = "Use bash for file operations like ls, rg, find";
+
+const WINDOWS_PATHEXT = ".COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC";
+
+/**
+ * @param {Record<string, string | undefined>} env
+ * @param {string} name
+ * @param {string} platform
+ */
+function envValue(env, name, platform) {
+	if (platform !== "win32") return env[name] ?? "";
+	const lower = name.toLowerCase();
+	for (const key of Object.keys(env)) {
+		if (key.toLowerCase() === lower) return env[key] ?? "";
+	}
+	return "";
+}
+
+/**
+ * @param {string} name
+ * @param {string} platform
+ * @param {string} pathext
+ */
+function commandNames(name, platform, pathext) {
+	if (platform !== "win32") return [name];
+	const extensions = new Set([".exe", ".EXE"]);
+	for (const raw of pathext.split(";")) {
+		const ext = raw.trim();
+		if (ext === "" || ext === ".") {
+			extensions.add("");
+			continue;
+		}
+		const suffix = ext.startsWith(".") ? ext : `.${ext}`;
+		extensions.add(suffix);
+		extensions.add(suffix.toLowerCase());
+		extensions.add(suffix.toUpperCase());
+	}
+	return [...extensions].map((ext) => (ext ? name + ext : name));
+}
+
+/**
+ * @param {string} file
+ * @param {string} platform
+ */
+function isRunnableFile(file, platform) {
+	try {
+		const stat = statSync(file);
+		if (!stat.isFile()) return false;
+		if (platform === "win32") return true;
+		return (stat.mode & 0o111) !== 0;
+	} catch {
+		return false;
+	}
+}
+
+/**
+ * Locate `rg` and `fd` by scanning PATH. No processes are spawned.
+ * `fd` is `"fd"`, `"fdfind"` (Debian/Ubuntu), or null.
+ *
+ * @param {{ env?: NodeJS.ProcessEnv, platform?: string }} [options]
+ * @returns {{ rg: boolean, fd: "fd" | "fdfind" | null }}
+ */
+export function detectSearchTools(options = {}) {
+	const platform = options.platform ?? process.platform;
+	const env = options.env ?? process.env;
+	const dirs = envValue(env, "PATH", platform)
+		.split(platform === "win32" ? ";" : ":")
+		.filter((dir) => dir.length > 0);
+	const pathext = platform === "win32" ? envValue(env, "PATHEXT", platform) || WINDOWS_PATHEXT : "";
+
+	const has = (name) => {
+		const names = commandNames(name, platform, pathext);
+		for (const dir of dirs) {
+			for (const candidate of names) {
+				if (isRunnableFile(path.join(dir, candidate), platform)) return true;
+			}
+		}
+		return false;
+	};
+
+	return {
+		rg: has("rg"),
+		fd: has("fd") ? "fd" : has("fdfind") ? "fdfind" : null,
+	};
+}
+
+/**
+ * @param {string} text
+ * @param {string} from
+ * @param {string} to
+ */
+function replaceExact(text, from, to) {
+	if (from === to || !text.includes(from)) return text;
+	return text.replaceAll(from, to);
+}
+
+/**
+ * Replace Pi's default grep/find lines in place. Unknown text is returned
+ * unchanged (same string when nothing matches).
+ *
+ * @param {string} prompt
+ * @param {{ rg: boolean, fd: "fd" | "fdfind" | null }} tools
+ */
+export function rewritePrompt(prompt, tools) {
+	if (!tools.rg && !tools.fd) return prompt;
+	const contentTool = tools.rg ? "rg" : "grep";
+	const fileTool = tools.fd ?? "find";
+	let next = replaceExact(prompt, BASH_SNIPPET, `Execute bash commands (ls, ${contentTool}, ${fileTool}, etc.)`);
+	if (tools.fd) {
+		next = replaceExact(next, BASH_RULE, `Use bash for file operations like ls, rg, ${tools.fd}`);
+	}
+	return next;
+}