pi-better-goal 0.1.2 → 0.1.3

package/README.md

@@ -1,105 +1,36 @@
 # pi-better-goal
 
-`pi-better-goal` is a Pi package that provides a `/goal` runtime with background-aware continuation for async subagents.
+Goal tracking for [Pi](https://pi.dev), with background-aware continuation.
 
-It ships one extension that:
+It keeps the active objective visible, tracks active versus elapsed time, and prevents Pi from treating foreground idleness as completion while background work is still running.
 
-- reads `pi-better-subagents` durable run metadata from the temp registry
-- treats current-parent `running` and `orphaned` subagents as active background work
-- owns `/goal` plus the `get_goal` and `update_goal` tools; only `/goal <objective>` can create a goal
-- shows the current goal with active and elapsed clocks in a right-aligned widget above custom footers such as `pi-observability`
-- publishes a typed activity snapshot on `pi.events`
-- adds goal-aware prompt context while background work is active, so foreground idleness is not confused with goal completion
-- sends a hidden follow-up when active background work drains to zero, including `callback:false` subagent runs
-- provides a `/better-activity` command and `get_background_activity` tool for inspection
+## Core Features
 
-Goal state is stored as `pi-better-goal` custom entries in the Pi session. Existing `pi-codex-goal` entries are read for compatibility, but new state is written by this package.
+- `/goal` runtime for starting, pausing, resuming, completing, and clearing the current objective.
+- A compact goal widget that does not replace Pi's footer.
+- Background activity tracking for subagents and other registered providers.
+- A follow-up wake when active background work drains to zero.
 
-## Commands And Tools
-
-```text
-/goal
-/goal <objective>
-/goal pause
-/goal resume
-/goal clear
-/goal complete
-/better-activity
-```
-
-Model-callable tools:
-
-- `get_goal`
-- `update_goal`
-- `get_background_activity`
-
-## Goal Clock
-
-Only `/goal <objective>` can create or replace a goal; there is no model-callable
-goal creation tool. The right-aligned widget below the editor shows the objective,
-status, active time, and total elapsed time. Active time stops while paused. Both
-clocks freeze when the goal is completed and remain visible until the goal is
-cleared or replaced.
-
-The widget does not replace Pi's footer, so custom footer extensions such as
-`pi-observability` retain ownership of their layout and lifecycle.
-
-Set `PI_BETTER_GOAL_DISABLE_WAKE=1` to disable hidden background-drain wakeups.
-
-## Install Locally
-
-From this directory:
+## Install
 
 ```sh
-npm install
-pi install .
+pi install npm:pi-better-goal
 ```
 
-For a one-off run:
+Try it for one run:
 
 ```sh
-pi -e .
+pi -e npm:pi-better-goal
 ```
 
-## Event Contract
+## Update Or Remove
 
-The extension emits these events on `pi.events`:
-
-- `pi-better-goal:ready` with `{ version }`
-- `pi-better-goal:activity` with an `ActivitySnapshot`
-- `pi-better-goal:terminal-attention` when terminal or unhealthy background work needs attention
-
-Other extensions can register providers by emitting `pi-better-goal:register-provider` with:
-
-```ts
-{
-  id: "provider-id",
-  label: "Provider label",
-  getActivity(ctx) {
-    return {
-      providerId: "provider-id",
-      label: "Provider label",
-      items: [
-        { id: "work-1", status: "running", active: true }
-      ]
-    };
-  }
-}
+```sh
+pi update npm:pi-better-goal
+pi remove npm:pi-better-goal
 ```
 
-The built-in provider id is `subagents`.
-
-## Status Semantics
+## More Detail
 
-For `pi-better-subagents`, active background work is:
-
-- `running`
-- `orphaned`
-
-`orphaned` is active but unhealthy. `completed`, `failed`, `killed`, `lost`, and `exited` are non-active terminal states. Batches are represented as normal per-run items; batch metadata is display-only.
-
-## Validation
-
-```sh
-npm run verify
-```
+- Repository: https://github.com/1aboveio/pi-better-harness
+- Detailed notes: https://github.com/1aboveio/pi-better-harness/blob/main/packages/pi-better-goal/docs/usage.md

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-better-goal",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Background activity bridge for Pi goal continuations and async subagents.",
   "type": "module",
   "main": "src/index.ts",
@@ -65,4 +65,4 @@
   "engines": {
     "node": ">=22.0.0"
   }
-}
+}