pi-one-instruction 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 dundun6x
+
+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,27 @@
-# Temporary Holding Version
+# pi-one-instruction
 
-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.
+[![npm version](https://img.shields.io/npm/v/pi-one-instruction)](https://www.npmjs.com/package/pi-one-instruction)
+[![npm downloads](https://img.shields.io/npm/dm/pi-one-instruction)](https://www.npmjs.com/package/pi-one-instruction)
+[![license](https://img.shields.io/github/license/dundun6x/pi-one-instruction)](LICENSE)
+
+Overwrite Pi's instructions with a single `INSTRUCTION.md`.
+
+## Installation
+
+```bash
+$ pi install npm:pi-one-instruction
+```
+
+## Usage
+
+Create an `INSTRUCTION.md` in your project-level or user-level configuration directory (`./.pi/` or `~/.pi/agent/`). If both exist, the former takes precedence.
+
+- `/one-instruction on` — Enable the custom instruction
+- `/one-instruction off` — Disable the custom instruction
+- `/one-instruction view` — View the custom instruction
+
+When enabled (by default), the content of `INSTRUCTION.md` replaces the final assembled instructions, overwriting any modifications made by Pi or extensions.
+
+## License
+
+[MIT](LICENSE)

package/index.ts

@@ -0,0 +1,49 @@
+import { join } from "node:path"
+import { existsSync, readFileSync } from "node:fs";
+import { getAgentDir, getMarkdownTheme, type ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import { Markdown, type AutocompleteItem } from "@earendil-works/pi-tui";
+
+export default function (pi: ExtensionAPI) {
+  const conf = join(getAgentDir(), "INSTRUCTION.md");
+  const local_conf = join(process.cwd(), ".pi", "INSTRUCTION.md");
+  const path = [local_conf, conf].find(existsSync);
+  const instr = path ? readFileSync(path, "utf8") : null;
+  let enabled = true;
+  pi.registerEntryRenderer<{ content: string }>(
+    "one-instruction-view",
+    (entry, _options, _theme) => {
+      return new Markdown(entry.data?.content ?? "", 1, 1, getMarkdownTheme());
+    }
+  );
+  pi.registerCommand("one-instruction", {
+    description: "Toggle one instruction",
+    getArgumentCompletions: (prefix): AutocompleteItem[] => {
+      return ["on", "off", "view"]
+        .filter((value) => value.startsWith(prefix.trim()))
+        .map((value) => ({ value, label: value }));
+    },
+    handler: async (args, ctx) => {
+      const value = args.trim().toLowerCase();
+      if (value === "on") {
+        enabled = true;
+        ctx.ui.notify("One instruction enabled", "info");
+      } else if (value === "off") {
+        enabled = false;
+        ctx.ui.notify("One instruction disabled", "info");
+      } else if (value === "view") {
+        if (!instr) {
+          ctx.ui.notify("INSTRUCTION.md not found in project or user configuration", "warning");
+          return;
+        }
+        ctx.ui.notify("View INSTRUCTION.md", "info");
+        pi.appendEntry("one-instruction-view", { content: instr });
+      } else {
+        ctx.ui.notify("Usage: /one-instruction on|off|view", "warning");
+      }
+    },
+  });
+  pi.on("before_provider_request", (event) => {
+    if (!(instr && enabled)) return;
+    (event.payload as Record<string, unknown>).instructions = instr;
+  });
+}

package/package.json

@@ -1,6 +1,27 @@
 {
   "name": "pi-one-instruction",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Overwrite Pi's instructions with a single INSTRUCTION.md",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dundun6x/pi-one-instruction.git"
+  },
+  "keywords": ["pi-package", "pi-extension", "instructions"],
+  "files": [
+    "index.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "pi": {
+    "extensions": ["./index.ts"]
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-coding-agent": "*"
+  },
+  "devDependencies": {
+    "@earendil-works/pi-coding-agent": "latest",
+    "typescript": "latest"
+  }
+}