pi-onlyne 0.2.3 → 0.2.5

package/README.md

@@ -1,14 +1,35 @@
 # pi-onlyne
 
-Pi extension for using Onlyne as a workspace-local messaging bridge.
+**Give pi agents a real IM inbox/outbox through [Onlyne](https://github.com/dbydd/onlyne).**
 
-## What it does
+`pi-onlyne` is the Pi extension for Onlyne. It adds tools and commands to pi so an agent can receive messages from IM channels and send replies without pretending that a chat platform is a terminal, a browser tab, or a custom workflow engine.
 
-- Watches an existing Onlyne workspace.
-- Starts Onlyne for the current workspace when requested.
-- Subscribes to inbound channel events without polling.
-- Lets the agent reply, send, or broadcast messages through tools.
-- Keeps config in the project, not in global home state.
+## What is Onlyne?
+
+[Onlyne](https://github.com/dbydd/onlyne) is a small workspace-local IM channel daemon. It runs in your project directory, keeps its config/state under `.onlyne/`, and brokers local agent calls to real messaging adapters such as Telegram, Feishu/Lark, QQ Bot, and WeChat.
+
+Onlyne is deliberately narrow:
+
+- local workspace daemon, not a global cloud service
+- channel broker, not an agent runtime
+- Unix socket / stdio friendly, not a web dashboard
+- local history and event stream, not a heavy message platform
+
+## What does this extension do?
+
+`pi-onlyne` connects pi to an existing Onlyne workspace and exposes Onlyne as native pi tools.
+
+With this extension, a pi agent can:
+
+- watch an Onlyne workspace for inbound IM messages
+- surface inbound messages into the current pi session
+- reply to the current inbound message
+- send a message to a specific channel conversation
+- broadcast the same message to multiple conversations
+- inject a local loopback activation so background scripts can wake the session
+- mark an inbound message as intentionally not replied
+
+Messages are Markdown by default, matching normal agent output. Use `rawText: true` only when the message must be sent literally.
 
 ## Install
 
@@ -16,16 +37,37 @@ Pi extension for using Onlyne as a workspace-local messaging bridge.
 pi install npm:pi-onlyne
 ```
 
-For a one-off run:
+For a one-off run without installing:
 
 ```bash
 pi -e npm:pi-onlyne
 ```
 
-## Requirements
+You also need the `onlyne` CLI installed and an initialized workspace:
+
+```bash
+onlyne init
+# Optional: refresh the workspace-local agent skill
+onlyne export-skill
+```
+
+If `onlyne` is not on `PATH`, set:
+
+```bash
+export ONLYNE_BIN=/path/to/onlyne
+```
+
+## Typical workflow
 
-- `onlyne` available on `PATH`, or set `ONLYNE_BIN`.
-- A workspace with `.onlyne/` already initialized.
+1. Initialize/configure Onlyne in your project.
+2. Install this Pi extension.
+3. Start watching from pi:
+
+```text
+/onlyne watch on
+```
+
+When a message arrives through Onlyne, pi receives it as a follow-up message. The agent can then call `onlyne_reply`, or deliberately call `onlyne_mark_no_reply`.
 
 ## Commands
 
@@ -42,13 +84,70 @@ pi -e npm:pi-onlyne
 onlyne_reply({ text })
 onlyne_send({ channelId, conversationId, text, rawText? })
 onlyne_broadcast({ targets, text, rawText? })
-onlyne_mark_no_reply({ reason })
+onlyne_loopback({ text, conversationId?, rawText? })
+onlyne_mark_no_reply({ reason? })
+```
+
+### Send one message
+
+```ts
+onlyne_send({
+  channelId: "telegram",
+  conversationId: "123456",
+  text: "# Build report\n\nAll checks passed."
+})
+```
+
+### Send literal text
+
+```ts
+onlyne_send({
+  channelId: "telegram",
+  conversationId: "123456",
+  text: "# not a heading",
+  rawText: true
+})
+```
+
+### Broadcast
+
+```ts
+onlyne_broadcast({
+  targets: [
+    { channelId: "telegram", conversationId: "123456" },
+    { channelId: "feishu", conversationId: "oc_xxx" }
+  ],
+  text: "# Release shipped\n\nVersion 0.2.3 is live."
+})
+```
+
+### Loopback wake-up
+
+From any local script, inject an inbound message into the current Onlyne daemon:
+
+```bash
+onlyne client '{"id":"wake","op":"loopback","text":"background job finished","raw_text":true}'
 ```
 
-Messages default to Markdown. Set `rawText: true` only when the text must be sent literally.
+Pi treats channel `loopback` as wake-up-only: it sends a follow-up to the session, but does not expect `onlyne_reply`.
+
+## Local state
+
+This extension stores its own pi-side config at:
+
+```text
+.pi/onlyne.json
+```
+
+Onlyne itself stores workspace state under:
+
+```text
+.onlyne/
+```
 
-## Config
+That keeps each project isolated: different workspaces can run different Onlyne daemons, channels, histories, and policies.
 
-Project-local config lives at `.pi/onlyne.json`. Defaults are safe: watch is manual, inbound messages auto-handle once watch is on, and outbound reply fallback is guarded.
+## Links
 
-See `SPEC.md` for behavior details.
+- Onlyne main repository: https://github.com/dbydd/onlyne
+- pi-onlyne package: https://www.npmjs.com/package/pi-onlyne

package/SPEC.md

@@ -14,6 +14,7 @@ Pi extension for Onlyne. Onlyne remains a workspace-local IM broker; this extens
 - Outbound defaults to `guarded-explicit`: prefer tool reply, fallback to final text, else send configured error text.
 - Send tools default to Markdown and may pass `raw_text: true` to Onlyne for literal text.
 - Broadcast sends concurrently with per-target retry and per-target results.
+- Loopback inbound messages wake Pi without creating a reply obligation.
 
 ## Config
 
@@ -36,6 +37,7 @@ Stored in project `.pi/onlyne.json`:
 - `onlyne_reply({ text })`
 - `onlyne_send({ channelId, conversationId, text, rawText? })`
 - `onlyne_broadcast({ targets, text, rawText? })`
+- `onlyne_loopback({ text, conversationId?, rawText? })`
 - `onlyne_mark_no_reply({ reason? })`
 
 ## Deferred

package/dist/index.js

@@ -1,6 +1,6 @@
 import { defineTool } from "@earendil-works/pi-coding-agent";
 import { Type } from "typebox";
-import { broadcast, connectOrSpawn, sendWithRetry, stopProcess, subscribe } from "./onlyne.js";
+import { broadcast, connectOrSpawn, loopback, sendWithRetry, stopProcess, subscribe } from "./onlyne.js";
 import { inboundModeFor, loadConfig, saveConfig } from "./config.js";
 import { findWorkspace } from "./workspace.js";
 const state = { cwd: process.cwd(), workspace: null, watching: false, owner: "stopped" };
@@ -11,7 +11,11 @@ async function startWatch(pi) { state.workspace = findWorkspace(state.cwd); if (
     throw new Error("current workspace has no .onlyne configuration"); const conn = await connectOrSpawn(state.workspace); state.owner = conn.owner; state.child = conn.process; state.socket = subscribe(state.workspace.socketPath, (line) => { if (!line?.event || line.type !== "inbound_message")
     return; const inbound = inboundText(line); if (!inbound)
     return; const mode = inboundModeFor(currentConfig(), inbound.channelId, inbound.conversationId); if (mode === "muted")
-    return; state.currentInbound = { ...inbound, replied: false, noReply: false, reminders: 0 }; if (mode === "auto-handle")
+    return; if (inbound.channelId === "loopback") {
+    if (mode === "auto-handle")
+        pi.sendUserMessage(`Onlyne loopback activation${inbound.conversationId ? ` (${inbound.conversationId})` : ""}:\n\n${inbound.text}`, { deliverAs: "followUp" });
+    return;
+} state.currentInbound = { ...inbound, replied: false, noReply: false, reminders: 0 }; if (mode === "auto-handle")
     pi.sendUserMessage(`Onlyne inbound message from ${inbound.channelId}/${inbound.conversationId}:\n\n${inbound.text}\n\nReply with onlyne_reply, or call onlyne_mark_no_reply if no reply is needed.`, { deliverAs: "followUp" }); }); state.watching = true; return `watching ${state.workspace.root} (${state.owner})`; }
 function stopWatch() { state.socket?.destroy(); state.socket = undefined; if (state.owner === "extension")
     stopProcess(state.child); state.child = undefined; state.watching = false; state.owner = "stopped"; return "watch stopped"; }
@@ -73,6 +77,8 @@ export default function onlyne(pi) {
             throw new Error("onlyne workspace not found"); const res = await sendWithRetry(state.workspace.socketPath, params, params.text, currentConfig().outbound.retry.attempts, params.rawText ?? false); return textResult(JSON.stringify(res), res); } }));
     pi.registerTool(defineTool({ name: "onlyne_broadcast", label: "Onlyne broadcast", description: "Send Markdown to many Onlyne channel conversations concurrently. Set rawText=true only for literal plain text.", parameters: Type.Object({ targets: Type.Array(Type.Object({ channelId: Type.String(), conversationId: Type.String() })), text: Type.String(), rawText: Type.Optional(Type.Boolean()) }), executionMode: "parallel", async execute(_id, params) { if (!state.workspace)
             throw new Error("onlyne workspace not found"); const cfg = currentConfig(); const results = await broadcast(state.workspace.socketPath, params.targets, params.text, cfg.outbound.retry.attempts, cfg.outbound.retry.concurrency, params.rawText ?? false); return textResult(JSON.stringify({ ok: results.every((r) => r.ok), results }), results); } }));
+    pi.registerTool(defineTool({ name: "onlyne_loopback", label: "Onlyne loopback", description: "Inject a local loopback activation message so scripts can wake the current Pi session. Set rawText=false for Markdown.", parameters: Type.Object({ text: Type.String(), conversationId: Type.Optional(Type.String()), rawText: Type.Optional(Type.Boolean()) }), executionMode: "parallel", async execute(_id, params) { if (!state.workspace)
+            throw new Error("onlyne workspace not found"); const res = await loopback(state.workspace.socketPath, params.text, params.conversationId ?? "self", params.rawText ?? true); return textResult(JSON.stringify(res), res); } }));
     pi.registerTool(defineTool({ name: "onlyne_mark_no_reply", label: "Onlyne no reply", description: "Mark the current Onlyne inbound message as intentionally not replied.", parameters: Type.Object({ reason: Type.Optional(Type.String()) }), executionMode: "parallel", async execute(_id, params) { if (state.currentInbound)
             state.currentInbound.noReply = true; return textResult("marked no reply", params); } }));
 }

package/dist/onlyne.d.ts

@@ -28,5 +28,6 @@ export declare function connectOrSpawn(ws: Workspace): Promise<{
     process?: ChildProcess;
 }>;
 export declare function stopProcess(child?: ChildProcess): void;
+export declare function loopback(socketPath: string, text: string, conversationId?: string, rawText?: boolean): Promise<any>;
 export declare function sendWithRetry(socketPath: string, target: SendTarget, text: string, attempts: number, rawText?: boolean): Promise<SendResult>;
 export declare function broadcast(socketPath: string, targets: SendTarget[], text: string, attempts: number, concurrency: number, rawText?: boolean): Promise<SendResult[]>;

package/dist/onlyne.js

@@ -80,6 +80,9 @@ export async function connectOrSpawn(ws) {
 export function stopProcess(child) { if (!child || child.killed)
     return; child.kill("SIGTERM"); setTimeout(() => { if (!child.killed)
     child.kill("SIGKILL"); }, 1500).unref(); }
+export async function loopback(socketPath, text, conversationId = "self", rawText = true) {
+    return request(socketPath, { id: `loopback-${Date.now()}`, op: "loopback", conversation_id: conversationId, text, raw_text: rawText });
+}
 export async function sendWithRetry(socketPath, target, text, attempts, rawText = false) {
     let error = "unknown error";
     for (let i = 0; i < Math.max(1, attempts); i++) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-onlyne",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "Pi extension tools for sending messages through Onlyne.",
   "type": "module",
   "main": "./dist/index.js",