@arcanemachine/pi-notify-marker
v0.2.0
Published
Marker file plugin for Pi coding agent - create files when events occur
Maintainers
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-markerTo update to the latest version:
pi update git:github.com/arcanemachine/pi-notify-markerFrom npm
pi install npm:@arcanemachine/pi-notify-markerTo update to the latest version:
pi update npm:@arcanemachine/pi-notify-markerFrom Local Clone
git clone https://github.com/arcanemachine/pi-notify-marker.git
cd pi-notify-marker
pi install /path/to/pi-notify-markerNo local npm install is required for normal usage.
Usage
If you want desktop notifications when the agent finishes:
Start Pi in the container.
Run
watch-and-notify.shfrom the host.
Development install (optional)
If you are editing the extension itself, install dev tooling only:
npm install --loglevel=warnThis 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.shNote: ~ 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.
