@esso0428/pi-subagents 0.15.0

package/dist/worktree.js

@@ -0,0 +1,160 @@
+/**
+ * worktree.ts — Git worktree isolation for agents.
+ *
+ * Creates a temporary git worktree so the agent works on an isolated copy of the repo.
+ * On completion, if no changes were made, the worktree is cleaned up.
+ * If changes exist, a branch is created and returned in the result.
+ */
+import { execFileSync } from "node:child_process";
+import { randomUUID } from "node:crypto";
+import { existsSync, realpathSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join, relative } from "node:path";
+/**
+ * Create a temporary git worktree for an agent.
+ * Returns the worktree path, or undefined if not in a git repo.
+ */
+export function createWorktree(cwd, agentId) {
+    // Verify we're in a git repo with at least one commit (HEAD must exist)
+    let baseSha;
+    let subdir;
+    try {
+        execFileSync("git", ["rev-parse", "--is-inside-work-tree"], { cwd, stdio: "pipe", timeout: 5000 });
+        baseSha = execFileSync("git", ["rev-parse", "HEAD"], { cwd, stdio: "pipe", timeout: 5000 })
+            .toString()
+            .trim();
+        // Where cwd sits inside the repo ("" at the root): the agent must work at
+        // the same subdirectory inside the copy, or a monorepo-package cwd would
+        // silently widen to the whole repo. realpath both sides — git emits
+        // resolved paths while cwd may arrive through a symlink (macOS /tmp).
+        const topLevel = execFileSync("git", ["rev-parse", "--show-toplevel"], { cwd, stdio: "pipe", timeout: 5000 })
+            .toString()
+            .trim();
+        subdir = relative(realpathSync(topLevel), realpathSync(cwd));
+    }
+    catch {
+        return undefined;
+    }
+    const branch = `pi-agent-${agentId}`;
+    const suffix = randomUUID().slice(0, 8);
+    const worktreePath = join(tmpdir(), `pi-agent-${agentId}-${suffix}`);
+    try {
+        // Create detached worktree at HEAD
+        execFileSync("git", ["worktree", "add", "--detach", worktreePath, "HEAD"], {
+            cwd,
+            stdio: "pipe",
+            timeout: 30000,
+        });
+        return { path: worktreePath, branch, baseSha, workPath: subdir ? join(worktreePath, subdir) : worktreePath };
+    }
+    catch {
+        // If worktree creation fails, return undefined (agent runs in normal cwd)
+        return undefined;
+    }
+}
+/**
+ * Clean up a worktree after agent completion.
+ * - If no changes: remove worktree entirely.
+ * - If changes exist: create a branch, commit changes, return branch info.
+ */
+export function cleanupWorktree(cwd, worktree, agentDescription) {
+    if (!existsSync(worktree.path)) {
+        return { hasChanges: false };
+    }
+    try {
+        // Check for uncommitted changes in the worktree
+        const status = execFileSync("git", ["status", "--porcelain"], {
+            cwd: worktree.path,
+            stdio: "pipe",
+            timeout: 10000,
+        }).toString().trim();
+        if (status) {
+            // Changes exist — stage, commit, and create a branch
+            execFileSync("git", ["add", "-A"], { cwd: worktree.path, stdio: "pipe", timeout: 10000 });
+            // Truncate description for commit message (no shell sanitization needed — execFileSync uses argv)
+            const safeDesc = agentDescription.slice(0, 200);
+            const commitMsg = `pi-agent: ${safeDesc}`;
+            execFileSync("git", ["commit", "--no-verify", "-m", commitMsg], {
+                cwd: worktree.path,
+                stdio: "pipe",
+                timeout: 10000,
+            });
+        }
+        else {
+            const currentSha = execFileSync("git", ["rev-parse", "HEAD"], {
+                cwd: worktree.path,
+                stdio: "pipe",
+                timeout: 5000,
+            }).toString().trim();
+            if (currentSha === worktree.baseSha) {
+                // No changes — remove worktree
+                removeWorktree(cwd, worktree.path);
+                return { hasChanges: false };
+            }
+        }
+        // Create a branch pointing to the worktree's HEAD.
+        // If the branch already exists, append a suffix to avoid overwriting previous work.
+        let branchName = worktree.branch;
+        try {
+            execFileSync("git", ["branch", branchName], {
+                cwd: worktree.path,
+                stdio: "pipe",
+                timeout: 5000,
+            });
+        }
+        catch {
+            // Branch already exists — use a unique suffix
+            branchName = `${worktree.branch}-${Date.now()}`;
+            execFileSync("git", ["branch", branchName], {
+                cwd: worktree.path,
+                stdio: "pipe",
+                timeout: 5000,
+            });
+        }
+        // Update branch name in worktree info for the caller
+        worktree.branch = branchName;
+        // Remove the worktree (branch persists in main repo)
+        removeWorktree(cwd, worktree.path);
+        return {
+            hasChanges: true,
+            branch: worktree.branch,
+            path: worktree.path,
+        };
+    }
+    catch {
+        // Best effort cleanup on error
+        try {
+            removeWorktree(cwd, worktree.path);
+        }
+        catch { /* ignore */ }
+        return { hasChanges: false };
+    }
+}
+/**
+ * Force-remove a worktree.
+ */
+function removeWorktree(cwd, worktreePath) {
+    try {
+        execFileSync("git", ["worktree", "remove", "--force", worktreePath], {
+            cwd,
+            stdio: "pipe",
+            timeout: 10000,
+        });
+    }
+    catch {
+        // If git worktree remove fails, try pruning
+        try {
+            execFileSync("git", ["worktree", "prune"], { cwd, stdio: "pipe", timeout: 5000 });
+        }
+        catch { /* ignore */ }
+    }
+}
+/**
+ * Prune any orphaned worktrees (crash recovery).
+ */
+export function pruneWorktrees(cwd) {
+    try {
+        execFileSync("git", ["worktree", "prune"], { cwd, stdio: "pipe", timeout: 5000 });
+    }
+    catch { /* ignore */ }
+}

package/examples/agent-tool-description.md

@@ -0,0 +1,42 @@
+Launch a new agent to handle complex, multi-step tasks autonomously. Each agent type has specific capabilities and tools available to it.
+
+Available agent types and the tools they have access to:
+{{typeList}}
+
+Custom agents can be defined in .pi/agents/<name>.md (project) or {{agentDir}}/agents/<name>.md (global) — they are picked up automatically. Project-level agents override global ones. Creating a .md file with the same name as a default agent overrides it.
+
+When using the Agent tool, specify a subagent_type parameter to select which agent type to use.
+
+## When not to use
+
+If the target is already known, use a direct tool — `read` for a known path, `grep`/`find` for a specific symbol or string. Reserve this tool for open-ended questions that span the codebase, or tasks that match an available agent type.
+
+## Usage notes
+
+- Always include a short (3-5 word) description summarizing what the agent will do (shown in UI).
+- When you launch multiple agents for independent work, send them in a single message with multiple tool uses, with run_in_background: true on each, so they run concurrently. If the user specifies that they want agents run "in parallel", you MUST send a single message with multiple tool calls. Foreground calls run sequentially — only one executes at a time.
+- When the agent is done, it returns a single message back to you. The result is not visible to the user — to show the user, send a text message with a concise summary.
+- Trust but verify: an agent's summary describes what it intended to do, not necessarily what it did. When an agent writes or edits code, check the actual changes before reporting work as done.
+- Use run_in_background for work you don't need immediately. You will be notified when it completes — do NOT poll or sleep waiting for it. Continue with other work or respond to the user instead.
+- Foreground vs background: use foreground (default) when you need the agent's results before you can proceed. Use background when you have genuinely independent work to do in parallel.
+- Use resume with an agent ID to continue a previous agent's work. A new (non-resume) Agent call starts a fresh agent with no memory of prior runs, so the prompt must be self-contained.
+- Use steer_subagent to send mid-run messages to a running background agent.
+- Clearly tell the agent whether you expect it to write code or just to do research (search, file reads, etc.), since it is not aware of the user's intent.
+- If an agent's description says it should be used proactively, try to use it without the user having to ask for it first.
+- Use model to specify a different model (as "provider/modelId", or fuzzy e.g. "haiku", "sonnet").
+- Use thinking to control extended thinking level.
+- Use inherit_context if the agent needs the parent conversation history.
+- Use isolation: "worktree" to run the agent in an isolated git worktree (safe parallel file modifications). The worktree is automatically cleaned up if the agent makes no changes; otherwise the path and branch are returned in the result.{{scheduleGuideline}}
+
+## Writing the prompt
+
+Provide clear, detailed prompts so the agent can work autonomously. Brief it like a smart colleague who just walked into the room — it hasn't seen this conversation, doesn't know what you've tried, doesn't understand why this task matters.
+- Explain what you're trying to accomplish and why.
+- Describe what you've already learned or ruled out.
+- Give enough context about the surrounding problem that the agent can make judgment calls rather than just following a narrow instruction.
+- If you need a short response, say so ("report in under 200 words").
+- Lookups: hand over the exact command. Investigations: hand over the question — prescribed steps become dead weight when the premise is wrong.
+
+Terse command-style prompts produce shallow, generic work.
+
+**Never delegate understanding.** Don't write "based on your findings, fix the bug" or "based on the research, implement it." Those phrases push synthesis onto the agent instead of doing it yourself. Write prompts that prove you understood: include file paths, line numbers, what specifically to change.

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@esso0428/pi-subagents",
+  "version": "0.15.0",
+  "description": "A pi extension that brings smart Claude Code-style autonomous sub-agents to pi, with npm:pi-subagents-style JSON agent overrides.",
+  "author": "ESSO0428",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ESSO0428/pi-subagents.git"
+  },
+  "homepage": "https://github.com/ESSO0428/pi-subagents#readme",
+  "bugs": {
+    "url": "https://github.com/ESSO0428/pi-subagents/issues"
+  },
+  "license": "MIT",
+  "keywords": [
+    "pi-package",
+    "pi",
+    "pi-extension",
+    "subagent",
+    "agent",
+    "autonomous"
+  ],
+  "peerDependencies": {
+    "@earendil-works/pi-ai": ">=0.80.0",
+    "@earendil-works/pi-coding-agent": ">=0.80.0",
+    "@earendil-works/pi-tui": ">=0.80.0"
+  },
+  "dependencies": {
+    "@sinclair/typebox": "^0.34.49",
+    "croner": "^10.0.1",
+    "nanoid": "^5.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run lint && npm run typecheck && npm run test && npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:e2e": "vitest run e2e --reporter=verbose",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check src/ test/",
+    "lint:fix": "biome check --fix src/ test/"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.14",
+    "@types/node": "^25.5.0",
+    "typescript": "^6.0.0",
+    "vitest": "^4.0.18"
+  },
+  "pi": {
+    "extensions": [
+      "./src/index.ts"
+    ],
+    "video": "https://github.com/tintinweb/pi-subagents/raw/master/media/demo.mp4",
+    "image": "https://github.com/tintinweb/pi-subagents/raw/master/media/screenshot.png"
+  }
+}