@arcanemachine/pi-notify-marker

Marker file plugin for Pi coding agent - create files when events occur

Package details

extension

Install @arcanemachine/pi-notify-marker from npm and Pi will load the resources declared by the package manifest.

$ pi install npm:@arcanemachine/pi-notify-marker
Package
@arcanemachine/pi-notify-marker
Version
0.2.0
Published
May 4, 2026
Downloads
not available
Author
arcanemachine
License
MIT
Types
extension
Size
7.7 KB
Dependencies
0 dependencies · 1 peer
Pi manifest JSON
{
  "extensions": [
    "./src/index.ts"
  ],
  "image": "https://raw.githubusercontent.com/arcanemachine/pi-notify-marker/main/logo.jpg"
}

Security note

Pi packages can execute code and influence agent behavior. Review the source before installing third-party packages.

README

pi-notify-marker

Marker file plugin for Pi coding agent - create files when Pi events occur.

A plugin for Pi that creates marker files when specific events occur. Useful for external monitoring scripts to detect when the AI needs attention (e.g. when running Pi in a container where native OS notifications cannot be triggered).

This project is similar to opencode-notify-marker but for Pi coding agent.

Why This Exists

So that you can run Pi in a container, and still have a means of getting OS notifications on the host.

How It Works

The plugin automatically creates marker files in a custom directory when certain Pi events occur (e.g. agent has finished a task).

The included script ./watch-and-notify.sh watches the marker directory and sends Linux OS notifications (via notify-send) when files are created. It automatically deletes the marker file after showing the notification.

Supported Events

Event Marker File Description
Agent done AGENT_DONE Agent finished successfully
Roadblock ROADBLOCK Agent needs user input

Installation

From GitHub (Recommended)

pi install git:github.com/arcanemachine/pi-notify-marker

To update to the latest version:

pi update git:github.com/arcanemachine/pi-notify-marker

From npm

pi install npm:@arcanemachine/pi-notify-marker

To update to the latest version:

pi update npm:@arcanemachine/pi-notify-marker

From Local Clone

git clone https://github.com/arcanemachine/pi-notify-marker.git
cd pi-notify-marker
pi install /path/to/pi-notify-marker

No local npm install is required for normal usage.

Usage

If you want desktop notifications when the agent finishes:

  1. Start Pi in the container.

  2. Run watch-and-notify.sh from the host.

Development install (optional)

If you are editing the extension itself, install dev tooling only:

npm install --loglevel=warn

This package keeps @mariozechner/pi-coding-agent as an optional peer to avoid pulling a large dependency tree during normal installs.

Directory config

# Start Pi with custom marker directory
PI_NOTIFY_MARKER_DIR="/path/to/some/dir" pi

# Run watcher script pointing to the same directory
PI_NOTIFY_MARKER_WATCH_DIR="/path/to/some/dir" ./watch-and-notify.sh

Note: ~ may not be expanded in all environments. Prefer absolute paths. Relative paths and $HOME/... can also work, but make sure Pi and the watcher resolve to the same directory.