@tduyng/pi-goal 0.0.0-stage → 0.0.2

package/LICENSE

@@ -0,0 +1,178 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+Use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 tduyng

package/README.md

@@ -1,3 +1,109 @@
-# Temporary Holding Version
+# @tduyng/pi-goal
 
-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.
+Keep working toward an explicit objective without typing "continue" after each run. Goals survive reload and tree navigation, track token use, and pause when output repeats or a token budget runs out.
+
+## /goal command
+
+Set a long-running objective with an optional token budget:
+
+```
+/goal refactor the auth module to use JWT refresh tokens
+/goal with token budget 50000 migrate the database schema
+```
+
+Subcommands: `edit` (opens the objective in an editor), `budget <tokens|off>` (set, raise, or remove the token budget), `check <command|off>` (the command that must exit 0 before the goal can complete), `pause`, `resume`, `clear`. Raising the budget past current spend resumes a budget-limited goal.
+
+## Tools
+
+- `create_goal`: the model creates a goal when the user explicitly asks. Objective max: 4,000 characters. Fails if an unfinished goal exists. A complete goal is replaced. When no token_budget is set, the response includes an advisory that spend is unbounded.
+- `get_goal`: returns the current goal's status, token and time usage, remaining budget, and thread ID.
+- `update_goal`: mark the goal `complete` or `blocked` after verifying the required conditions. Pass `notes` (max 3,000 characters) to replace the progress notes. `complete` runs the goal's check first and is refused unless it exits 0. The model should not mark a goal complete merely because the budget is nearly exhausted or because it is stopping work.
+
+Goal tools enter the active set while a goal is active or the user asks to create one. Otherwise their schemas stay out of the model request.
+
+## Automatic continuation
+
+After a successful agent run, the extension queues a continuation prompt so the model keeps working without user input. Standing orders live in the system prompt (byte-stable for prompt cache). Live counters (elapsed time, tokens used) ride in the continuation message at the request tail.
+
+Only one continuation fires per turn. If the loop extension also queued a prompt, the `hasPendingMessages()` guard ensures exactly one wins.
+
+### Runaway detection
+
+If the same tool-free output repeats 3 times in a row, the extension pauses the goal. Any tool call resets the streak.
+
+### Stagnation nudge
+
+After 5 goal turns with no successful `edit` or `write` tool result, the continuation message carries a line naming the count and asking for the next concrete change, or for the blocked audit when a blocker keeps repeating. User input resets the count. The nudge never pauses the goal.
+
+### Auto-continuation
+
+There is no fixed cap: a goal keeps queueing continuations until it completes, is paused, or hits its token budget. Stop one that is going nowhere with `/goal clear`.
+
+### Token counting
+
+Only `input` and `output` tokens count toward the goal budget. `cacheRead` and `cacheWrite` are excluded because providers report them as separate fields.
+
+## Completion check and notes
+
+`create_goal` with `check`, or `/goal check <command>`, sets a shell command such as `bun test`. `update_goal` with status `complete` runs it first. A failing check keeps the goal active and returns the output to the model. `/goal check off` removes it.
+
+The progress notes hold what is done, what failed and what is next. They are sent again in the next continuation after a compaction or a resume. A note written in a turn is already in that turn's context, so it is not repeated.
+
+## Status bar
+
+Shows elapsed time, token usage, and budget during active pursuit. Other states display as `Goal paused`, `Goal blocked`, `Goal hit usage limits`, `Goal budget reached`, or `Goal complete`.
+
+## /loop command
+
+Repeat a prompt on a fixed interval (e.g. `5m`, `1h`, `30s`) or after each agent run settles:
+
+```
+/loop 5m check for failing CI jobs
+/loop review recent work and fix unfinished items
+/loop stop
+```
+
+Starting a loop fires the first prompt immediately. `/loop` and `/goal` share the pending-message guard to avoid duplicate continuations. Loop state is session-scoped. The timer dies with the pi process. For durable scheduled runs across restarts, use `pi -p "<prompt>"` from an OS scheduler.
+
+Interval format: a number followed by a unit. Supported units: `ms`, `s`, `m`, `h`, `d`. Bare numbers without a unit are not supported to avoid silent misinterpretation.
+
+Self-paced mode fires 250ms after `agent_settled`, once pi's own retries and compactions have finished. The default prompt when none is provided: "Run a maintenance check: review recent work and address anything stale, broken, or left half-finished."
+
+Subcommands: `stop` (also `cancel`, `clear`, `off`), or bare `/loop` to show status. The status bar shows the pace label (e.g. `Loop every 5m (3)`) and iteration count.
+
+## Design
+
+The extension persists state as custom session entries, without an external database. Resuming a saved session restores its goal. Interval loops re-arm on resume, firing immediately if their interval has elapsed. The extension does not create goals automatically from ordinary tasks and does not reimplement timeout or retry logic that pi already handles.
+
+### Crash resume
+
+Reopening a session whose goal was mid-turn when the process died queues one continuation, so
+the run picks up instead of waiting for the user to type. A turn that ended on a user message,
+a tool result, or a tool call that never ran counts as cut off. A turn the user aborted, or one
+that ended in an error, does not: the first was their own stop, and the second is what pi-goal
+already pauses on. The resume counts as an automatic continuation, and only an interactive
+session resumes, because a headless run has no editor to send a message from. A resume pi
+refuses, because it is already replaying the interrupted turn, says nothing: the goal continues
+from that turn's own settle.
+
+### Blocked and completion audits
+
+The standing orders in the system prompt require the model to verify completion against the actual current state before marking a goal complete. For blocked status, the same blocking condition must repeat for at least 3 consecutive goal turns before the model calls update_goal with status blocked. Resuming a previously blocked goal resets the count.
+
+### Budget resume
+
+When resuming a goal that hit its token budget, the extension raises the budget to `tokensUsed + 50,000` so the next turn can proceed. The status bar notes the raised budget.
+
+### Prompt matching
+
+The `promptRequestsGoal` heuristic requires an action verb (create, set, start, new, add, track, pursue, manage, establish) plus a goal noun, or the phrase "long-running". A bare "goal" does not enable the tools.
+
+## Install
+
+```bash
+pi install npm:@tduyng/pi-goal
+```
+
+Local checkout: `pi install /path/to/dotfiles/pi/agent/extensions/pi-goal`
+
+No configuration is required.

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "@tduyng/pi-goal",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.2",
+  "description": "Long-running objectives that survive reload and tree navigation, plus a timed or self-paced loop to drive them.",
+  "keywords": [
+    "pi",
+    "pi-package",
+    "pi-extension",
+    "pi-coding-agent",
+    "goal",
+    "loop",
+    "autonomy"
+  ],
+  "homepage": "https://gitlab.com/tduyng/pi-agent/-/tree/main/extensions/pi-goal#readme",
+  "bugs": "https://gitlab.com/tduyng/pi-agent/-/issues",
+  "license": "Apache-2.0",
+  "author": "tduyng",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/tduyng/pi-agent.git",
+    "directory": "extensions/pi-goal"
+  },
+  "type": "module",
+  "files": [
+    "src",
+    "!src/**/*.test.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "peerDependencies": {
+    "@earendil-works/pi-ai": "*",
+    "@earendil-works/pi-coding-agent": "*"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "pi": {
+    "extensions": [
+      "./src/goal.ts",
+      "./src/loop/index.ts"
+    ]
+  },
+  "dependencies": {
+    "ata-validator": "^1.62.1"
+  }
+}

package/src/check.ts

@@ -0,0 +1,58 @@
+import { truncateTail } from '@earendil-works/pi-coding-agent'
+
+export type ExecFn = (
+    command: string,
+    cwd: string,
+    options: { onData: (data: Buffer) => void; signal?: AbortSignal; timeout?: number }
+) => Promise<{ exitCode: number | null }>
+
+export interface CheckResult {
+    ok: boolean
+    exitCode: number | null
+    timedOut: boolean
+    durationMs: number
+    output: string
+}
+
+export const MAX_CHECK_OUTPUT_BYTES = 1500
+export const DEFAULT_CHECK_TIMEOUT_MS = 300_000
+
+export async function runCheck(
+    exec: ExecFn,
+    cwd: string,
+    command: string,
+    options: { timeoutMs?: number; signal?: AbortSignal } = {}
+): Promise<CheckResult> {
+    const timeoutMs = options.timeoutMs && options.timeoutMs > 0 ? options.timeoutMs : DEFAULT_CHECK_TIMEOUT_MS
+    let captured = Buffer.alloc(0)
+    const started = Date.now()
+    const finish = (exitCode: number | null, error?: string): CheckResult => {
+        const durationMs = Date.now() - started
+        const output = captured.toString('utf8')
+        const body = error ? `${output}${output ? '\n' : ''}${error}` : output
+        const tail = truncateTail(body, { maxBytes: MAX_CHECK_OUTPUT_BYTES })
+        return {
+            ok: exitCode === 0,
+            exitCode,
+            timedOut: exitCode === null && (error === undefined || error.startsWith('timeout:')),
+            durationMs,
+            output: tail.content.trim()
+        }
+    }
+    let exitCode: number | null
+    try {
+        ;({ exitCode } = await exec(command, cwd, {
+            onData: (data) => {
+                const combined = Buffer.concat([captured, data])
+                captured = combined.subarray(Math.max(0, combined.length - MAX_CHECK_OUTPUT_BYTES))
+            },
+            signal: options.signal,
+            timeout: timeoutMs / 1000
+        }))
+    } catch (error) {
+        if (options.signal?.aborted) throw error
+        const message = error instanceof Error ? error.message : String(error)
+        return finish(null, message)
+    }
+    return finish(exitCode)
+}