omp-mode-switch 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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

@@ -0,0 +1,84 @@
+# omp-mode-switch
+
+[![npm version](https://img.shields.io/npm/v/omp-mode-switch)](https://www.npmjs.com/package/omp-mode-switch)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+An OMP plugin that lets you switch between three permission modes at runtime. Press **Tab** to cycle, or use `/mode <ask|auto|plan>`.
+
+---
+
+## Installation
+
+```bash
+omp plugin install omp-mode-switch
+```
+
+Restart OMP (or start a new session) to activate.
+
+### Manual
+
+Copy `mode-switch.ts` to `~/.omp/agent/extensions/` or your project's `.omp/extensions/`.
+
+## Usage
+
+### Modes
+
+| Mode   | Behavior |
+|--------|----------|
+| `ask`  | Every tool call prompts for your confirmation (default) |
+| `auto` | All tool calls are approved automatically |
+| `plan` | Read-only tools only + `.md` file writing. Dangerous `bash` commands are blocked |
+
+### Switching
+
+| Action       | Effect |
+|--------------|--------|
+| **Tab**      | Cycle: `ask → auto → plan → ask` |
+| `/mode ask`  | Switch to ask mode |
+| `/mode auto` | Switch to auto mode |
+| `/mode plan` | Switch to plan mode |
+
+### Status indicator
+
+The current mode is shown as a colored widget at the bottom of the editor area:
+
+- **ASK** (yellow)
+- **AUTO** (green)
+- **PLAN** (blue-cyan)
+
+## Example workflow
+
+1. **Explore** — Use `plan` mode to read through the codebase safely
+2. **Plan** — Write `.md` plans in `plan` mode
+3. **Execute** — Switch to `auto` to run changes
+4. **Review** — Switch to `ask` for step-by-step confirmation on critical operations
+
+The mode resets to `ask` on each new session.
+
+## How it works
+
+- Registers a **Tab** shortcut via `pi.registerShortcut()`
+- Registers a `/mode` command via `pi.registerCommand()`
+- Intercepts `tool_call` events to block destructive tools in `plan` mode
+- Restricts tools via `pi.setActiveTools()` in plan mode
+- Shows status via `ctx.ui.setWidget()` with colored text
+
+## Development
+
+```bash
+git clone https://github.com/your-username/omp-mode-switch.git
+cd omp-mode-switch
+# Make changes to mode-switch.ts
+# Copy to ~/.omp/agent/extensions/ and restart OMP to test
+```
+
+## Publishing
+
+```bash
+npm login
+npm publish
+```
+
+## License
+
+MIT

package/README.zh-CN.md

@@ -0,0 +1,84 @@
+# omp-mode-switch
+
+[![npm version](https://img.shields.io/npm/v/omp-mode-switch)](https://www.npmjs.com/package/omp-mode-switch)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+一个 OMP 插件，让你在运行中切换三种权限模式。按 **Tab** 键循环切换，或使用 `/mode <ask|auto|plan>` 命令。
+
+---
+
+## 安装
+
+```bash
+omp plugin install omp-mode-switch
+```
+
+重启 OMP（或新建会话）即可生效。
+
+### 手动安装
+
+将 `mode-switch.ts` 复制到 `~/.omp/agent/extensions/` 或项目的 `.omp/extensions/`。
+
+## 使用方法
+
+### 模式
+
+| 模式   | 行为 |
+|--------|------|
+| `ask`  | 每个工具调用都需确认（默认） |
+| `auto` | 自动批准所有工具调用 |
+| `plan` | 仅允许只读工具和 `.md` 文件写入，危险 bash 命令被拦截 |
+
+### 切换
+
+| 操作          | 效果 |
+|---------------|------|
+| **Tab**       | 循环：`ask → auto → plan → ask` |
+| `/mode ask`   | 切换到确认模式 |
+| `/mode auto`  | 切换到自动模式 |
+| `/mode plan`  | 切换到计划模式 |
+
+### 状态指示
+
+当前模式以彩色指示器显示在编辑器底部：
+
+- **ASK**（黄色）
+- **AUTO**（绿色）
+- **PLAN**（蓝青色）
+
+## 工作流程示例
+
+1. **探索** — 用 `plan` 模式安全阅读代码
+2. **规划** — 在 `plan` 模式下编写 `.md` 规划文档
+3. **执行** — 切换到 `auto` 执行修改
+4. **审查** — 切换到 `ask` 对关键操作逐次确认
+
+每次新会话自动重置为 `ask` 模式。
+
+## 工作原理
+
+- 通过 `pi.registerShortcut()` 注册 Tab 快捷键
+- 通过 `pi.registerCommand()` 注册 `/mode` 命令
+- 拦截 `tool_call` 事件，在 `plan` 模式下阻止破坏性工具
+- 在 `plan` 模式下通过 `pi.setActiveTools()` 限制可用工具
+- 通过 `ctx.ui.setWidget()` 显示彩色状态指示
+
+## 开发
+
+```bash
+git clone https://github.com/your-username/omp-mode-switch.git
+cd omp-mode-switch
+# 修改 mode-switch.ts
+# 复制到 ~/.omp/agent/extensions/ 后重启 OMP 测试
+```
+
+## 发布
+
+```bash
+npm login
+npm publish
+```
+
+## 许可证
+
+MIT

package/mode-switch.ts

@@ -0,0 +1,148 @@
+/**
+ * Mode Switch - OMP permission mode switching plugin
+ *
+ * Three modes:
+ *   ask   Prompt for every tool call (default)
+ *   auto  Auto-approve all tool calls
+ *   plan  Read-only mode: only read/search tools + .md writing allowed
+ *
+ * Shortcut: Tab cycles ask → auto → plan → ask
+ * Command:  /mode <ask|auto|plan>
+ * Display:  Colored widget at editor bottom, e.g. [ASK] [AUTO] [PLAN]
+ *
+ * Install:
+ *   omp plugin install omp-mode-switch
+ *   (Restart OMP to activate)
+ *
+ * Manual install: copy to ~/.omp/agent/extensions/mode-switch.ts
+ */
+
+import type { ExtensionAPI, ExtensionContext } from "@oh-my-pi/pi-coding-agent";
+
+// ─── Types ──────────────────────────────────────────────────────────────────
+
+type Mode = "ask" | "auto" | "plan";
+
+// ─── Read-only tools allowed in plan mode ───────────────────────────────────
+
+const READ_ONLY_TOOLS = [
+  "read", "grep", "glob", "search", "ast_grep",
+  "codegraph_search", "codegraph_explore", "codegraph_files",
+  "codegraph_status", "codegraph_node", "codegraph_callers",
+  "codegraph_callees", "codegraph_impact",
+  "ls", "find", "head", "tail", "cat", "less",
+] as const;
+
+const roSet = new Set<string>(READ_ONLY_TOOLS);
+
+// ─── Bash safety checks ─────────────────────────────────────────────────────
+
+const SAFE_BASH_COMMANDS = new Set([
+  "cat", "head", "tail", "less", "more", "ls", "find", "grep", "rg",
+  "git", "echo", "printf", "pwd", "which", "dirname", "basename",
+  "wc", "sort", "uniq", "cut", "date", "uptime", "whoami", "id", "env",
+]);
+
+const DANGEROUS_PATTERNS = [
+  " rm ", " rmdir ", " mv ", " cp ", " dd ", " chmod ",
+  " chown ", " sudo ", " su ", " &&", " ||", " >", " >>", " |",
+];
+
+function isSafeBash(cmd: string): boolean {
+  const t = cmd.trim();
+  if (!t) return false;
+  for (const p of DANGEROUS_PATTERNS) {
+    if (t.includes(p)) return false;
+  }
+  return SAFE_BASH_COMMANDS.has(t.split(/\s+/)[0]);
+}
+
+// ─── Helpers ────────────────────────────────────────────────────────────────
+
+function isMdWrite(name: string, input: Record<string, unknown>): boolean {
+  if (name !== "write") return false;
+  return typeof input.path === "string" && (input.path as string).endsWith(".md");
+}
+
+function coloredMode(ctx: ExtensionContext, m: Mode): string {
+  const t = ctx.ui.theme;
+  if (m === "ask")  return t.fg("warning", "ASK");
+  if (m === "auto") return t.fg("success", "AUTO");
+  return t.fg("accent", "PLAN");
+}
+
+// ─── Plugin entry ───────────────────────────────────────────────────────────
+
+export default function modeSwitch(pi: ExtensionAPI) {
+  let mode: Mode = "ask";
+  const CYCLE: Mode[] = ["ask", "auto", "plan"];
+
+  function showWidget(ctx: ExtensionContext | undefined) {
+    if (!ctx) return;
+    ctx.ui.setWidget("mode-switch", [coloredMode(ctx, mode)], {
+      placement: "belowEditor",
+    });
+  }
+
+  function switchTo(next: Mode, ctx: ExtensionContext | undefined) {
+    if (mode === next || !ctx) return;
+    mode = next;
+    showWidget(ctx);
+
+    if (mode === "plan") {
+      pi.setActiveTools([...READ_ONLY_TOOLS, "bash", "write", "edit"]);
+    } else {
+      pi.setActiveTools(pi.getAllTools());
+    }
+  }
+
+  // Tab key to cycle modes
+  pi.registerShortcut("Tab", {
+    description: "Cycle mode: ask → auto → plan → ask",
+    handler: (ctx) => {
+      const i = CYCLE.indexOf(mode);
+      switchTo(CYCLE[(i + 1) % CYCLE.length], ctx);
+    },
+  });
+
+  // /mode command
+  pi.registerCommand("mode", {
+    description: "Switch permission mode: /mode <ask|auto|plan>",
+    getArgumentCompletions: () => ["ask", "auto", "plan"],
+    handler: async (args, ctx) => {
+      const target = args[0]?.toLowerCase() as Mode | undefined;
+      if (target && CYCLE.includes(target)) {
+        switchTo(target, ctx);
+      }
+    },
+  });
+
+  // Plan mode: block non-readonly tools
+  pi.on("tool_call", async (event) => {
+    if (mode !== "plan") return;
+
+    const { toolName } = event;
+    if (roSet.has(toolName)) return;
+
+    if (toolName === "bash") {
+      const input = (event as Record<string, unknown>).input as Record<string, unknown> | undefined;
+      const cmd = input?.command as string | undefined;
+      if (cmd && isSafeBash(cmd)) return;
+      return { block: true, reason: "Blocked by plan mode: dangerous command" };
+    }
+
+    if ((toolName === "write" || toolName === "edit") && (event as any).input) {
+      const input = (event as any).input as Record<string, unknown>;
+      if (isMdWrite(toolName, input)) return;
+    }
+
+    return { block: true, reason: "Blocked by plan mode: read-only tools only" };
+  });
+
+  // Reset to ask on new session
+  pi.on("session_start", (_event, ctx) => {
+    mode = "ask";
+    showWidget(ctx);
+    pi.setActiveTools(pi.getAllTools());
+  });
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "omp-mode-switch",
+  "version": "1.0.0",
+  "description": "OMP plugin: switch between ask / auto / plan permission modes with Tab key",
+  "type": "module",
+  "main": "mode-switch.ts",
+  "scripts": {},
+  "files": [
+    "mode-switch.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "omp": {
+    "name": "Mode Switch",
+    "description": "Switch between ask / auto / plan permission modes with Tab key",
+    "version": "1.0.0",
+    "author": "OMP Community",
+    "extensions": {
+      "mode-switch": {
+        "description": "Mode Switch extension - permission mode toggle",
+        "main": "mode-switch.ts"
+      }
+    }
+  },
+  "keywords": [
+    "omp",
+    "plugin",
+    "mode",
+    "permission",
+    "security",
+    "ask",
+    "auto",
+    "plan",
+    "oh-my-pi"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/your-username/omp-mode-switch.git"
+  },
+  "bugs": {
+    "url": "https://github.com/your-username/omp-mode-switch/issues"
+  },
+  "homepage": "https://github.com/your-username/omp-mode-switch#readme",
+  "engines": {
+    "node": ">=18"
+  }
+}