wehub-resource-sync
426e9eeabd
Voice Workbench / headless workbench (mocked backends) (push) Has been cancelled
Voice Workbench / real acoustic lane (nightly, provisioned only) (push) Has been cancelled
ci / test (push) Has been cancelled
ci / lint-and-format (push) Has been cancelled
ci / build (push) Has been cancelled
ci / dev-startup (push) Has been cancelled
gitleaks / gitleaks (push) Has been cancelled
Markdown Links / Relative Markdown Links (push) Has been cancelled
Quality (Extended) / Homepage Build (PR smoke) (push) Has been cancelled
Quality (Extended) / Comment-only diff guard (push) Has been cancelled
Quality (Extended) / Format + Type Safety Ratchet (push) Has been cancelled
Quality (Extended) / Develop Gate (secret scan + UI determinism) (push) Has been cancelled
Quality (Extended) / Develop Gate (lint) (push) Has been cancelled
Chat shell gestures / Chat shell gesture + parity e2e (push) Has been cancelled
Cloud Gateway Discord / Test (push) Has been cancelled
Benchmark Bridge Tests / benchmark (bunx @biomejs/biome check packages/lifeops-bench/src, benchmark-lint) (push) Has been cancelled
Benchmark Bridge Tests / benchmark (bunx vitest run --config packages/lifeops-bench/vitest.config.ts --root packages/lifeops-bench --passWithNoTests, benchmark-tests) (push) Has been cancelled
Build Agent Image / build-and-push (push) Has been cancelled
Dev Smoke / bun run dev onboarding chat (push) Has been cancelled
Dev Smoke / Vite HMR dependency-level smoke (push) Has been cancelled
Electrobun Submodule Guard / electrobun gitlink is fetchable (push) Has been cancelled
Publish @elizaos/example-code / check_npm (push) Has been cancelled
Publish @elizaos/example-code / publish_npm (push) Has been cancelled
Publish @elizaos/plugin-elizacloud / verify_version (push) Has been cancelled
Publish @elizaos/plugin-elizacloud / publish_npm (push) Has been cancelled
Sandbox Live Smoke / Sandbox live smoke (push) Has been cancelled
Snap Build & Test / Build Snap (amd64) (push) Has been cancelled
Snap Build & Test / Build Snap (arm64) (push) Has been cancelled
Test Packaging / elizaos CLI global-install smoke (node + bun) (push) Has been cancelled
Cloud Gateway Webhook / Test (push) Has been cancelled
Cloud Tests / lint-and-types (push) Has been cancelled
Cloud Tests / unit-tests (push) Has been cancelled
Cloud Tests / integration-tests (push) Has been cancelled
Cloud Tests / e2e-tests (push) Has been cancelled
CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
Deploy Apps Worker (Product 2) / Determine environment (push) Has been cancelled
Deploy Apps Worker (Product 2) / Deploy apps worker to apps-control host (${{ needs.determine-env.outputs.environment }}) (push) Has been cancelled
Deploy Eliza Provisioning Worker / Determine environment (push) Has been cancelled
Deploy Eliza Provisioning Worker / Deploy worker to Hetzner host (${{ needs.determine-env.outputs.environment }} @ ${{ needs.determine-env.outputs.deployment_sha }}) (push) Has been cancelled
Dev Smoke / Classify changed paths (push) Has been cancelled
supply-chain / sbom (push) Has been cancelled
supply-chain / vulnerability-scan (push) Has been cancelled
Build, Push & Deploy to Phala Cloud / build-and-push (push) Has been cancelled
Test Packaging / Validate Packaging Configs (push) Has been cancelled
Test Packaging / Build & Test PyPI Package (push) Has been cancelled
Test Packaging / PyPI on Python ${{ matrix.python }} (push) Has been cancelled
Test Packaging / Pack & Test JS Tarballs (push) Has been cancelled
UI Fixture E2E / ui-fixture-e2e (push) Has been cancelled
UI Fixture E2E / fixture-e2e (push) Has been cancelled
UI Story Gate / story-gate (push) Has been cancelled
vault-ci / test (macos-latest) (push) Has been cancelled
vault-ci / test (ubuntu-latest) (push) Has been cancelled
vault-ci / test (windows-latest) (push) Has been cancelled
vault-ci / app-core wiring tests (push) Has been cancelled
verify-patches / verify patches/CHECKSUMS.sha256 (push) Has been cancelled
Voice Benchmark Smoke / voice-emotion fixture smoke (push) Has been cancelled
Voice Benchmark Smoke / voiceagentbench fixture smoke (push) Has been cancelled
Voice Benchmark Smoke / voicebench-quality unit smoke (push) Has been cancelled
Voice Benchmark Smoke / voicebench TypeScript unit (no audio) (push) Has been cancelled
Voice Benchmark Smoke / voice bench smoke summary (push) Has been cancelled
Windows CI / windows ([bun run --cwd packages/app-core test bun run --cwd packages/elizaos test bun run --cwd packages/cloud/shared test], app-and-cli) (push) Has been cancelled
Windows CI / windows ([bun run --cwd packages/scenario-runner test bun run --cwd packages/vault test bun run --cwd packages/security test bun run --cwd plugins/plugin-coding-tools test], framework-packages) (push) Has been cancelled
Windows CI / windows ([bun run --cwd plugins/plugin-elizacloud test bun run --cwd plugins/plugin-discord test bun run --cwd plugins/plugin-anthropic test bun run --cwd plugins/plugin-openai test bun run --cwd plugins/plugin-app-control test bun run --cwd plugins/pl… (push) Has been cancelled
Windows CI / windows ([node packages/scripts/run-turbo.mjs run build --filter=@elizaos/core --filter=@elizaos/shared --filter=@elizaos/agent --concurrency=4 node packages/scripts/run-bash-linux-only.mjs scripts/verify-riscv64-buildpaths.sh node packages/scripts/run… (push) Has been cancelled
Windows CI / windows ([node packages/scripts/run-turbo.mjs run typecheck --filter=@elizaos/core --filter=@elizaos/shared --filter=@elizaos/cloud-shared --concurrency=4 bun run --cwd packages/core test bun run --cwd packages/shared test], core-runtime, 75) (push) Has been cancelled
83 lines
3.3 KiB
Markdown
83 lines
3.3 KiB
Markdown
# @elizaos/macosalarm
|
|
|
|
macOS native alarm scheduling for Eliza agents via `UNUserNotificationCenter`.
|
|
|
|
## What it does
|
|
|
|
This plugin adds the `ALARM` action to an Eliza agent, enabling it to:
|
|
|
|
- **Set** calendar-trigger alarms that fire as macOS system notifications (with sound).
|
|
- **Cancel** pending alarms by ID.
|
|
- **List** all pending alarms registered by the agent.
|
|
|
|
Alarms are delivered through macOS's native `UNUserNotificationCenter` API. A self-contained Swift CLI (`swift-helper/main.swift`) is compiled to a binary at `bin/macosalarm-helper` during the build step. The Eliza runtime spawns this binary via stdin/stdout JSON IPC — no network calls, no third-party services.
|
|
|
|
## Platform support
|
|
|
|
**macOS (darwin) only.** The plugin is auto-enabled on darwin (`"autoEnable": "darwin"`). On any other platform the action's validate hook returns `false` and no alarms are attempted.
|
|
|
|
## Requirements
|
|
|
|
- macOS with `swiftc` available (Xcode Command Line Tools).
|
|
- Node.js >= 24.
|
|
- The package must be built before use: `bun run build` compiles both the TypeScript and the Swift helper binary.
|
|
|
|
## Installation
|
|
|
|
The plugin is part of the elizaOS monorepo. In your agent character config, reference the package name `@elizaos/macosalarm` (it auto-enables on darwin). For manual loading:
|
|
|
|
```ts
|
|
import macosAlarmPlugin from "@elizaos/macosalarm";
|
|
// add to your runtime's plugins array
|
|
```
|
|
|
|
## Build
|
|
|
|
```bash
|
|
bun run --cwd plugins/plugin-native-macosalarm build
|
|
```
|
|
|
|
This runs `tsc --noCheck` and then `swiftc swift-helper/main.swift -O -o bin/macosalarm-helper`.
|
|
|
|
## Configuration
|
|
|
|
| Env variable | Default | Purpose |
|
|
|-------------|---------|---------|
|
|
| `ELIZA_MACOSALARM_HELPER_BIN` | `bin/macosalarm-helper` (relative to package root) | Override the path to the compiled Swift binary |
|
|
|
|
No other configuration is required.
|
|
|
|
## Capabilities
|
|
|
|
### ALARM action
|
|
|
|
The `ALARM` action has three subactions. The subaction is inferred from the message text when not explicitly provided.
|
|
|
|
| Subaction | Required params | Description |
|
|
|-----------|----------------|-------------|
|
|
| `set` | `timeIso`, `title` | Schedule a new alarm. `timeIso` must be an ISO-8601 timestamp. `body`, `sound`, and `id` are optional. |
|
|
| `cancel` | `id` | Remove a pending alarm by its ID (returned from a prior `set`). |
|
|
| `list` | — | Return all pending macOS alarms. |
|
|
|
|
Example interactions:
|
|
|
|
- "Set an alarm for 7am tomorrow" — schedules via `set`.
|
|
- "Cancel alarm alarm-abc123" — cancels via `cancel`.
|
|
- "List my pending alarms" — lists via `list`.
|
|
|
|
Keyword matching covers English and several other languages (Spanish, French, German, Chinese, Japanese, Korean, Vietnamese).
|
|
|
|
### Permissions
|
|
|
|
On first use of `set`, macOS will prompt the user to allow notifications from the process. If the user denies this permission, alarm scheduling will fail with a `permission-denied` error.
|
|
|
|
### Role gate
|
|
|
|
The `ALARM` action requires the agent's user to have at minimum the `ADMIN` role.
|
|
|
|
## Limitations
|
|
|
|
- macOS only — no Windows or Linux support.
|
|
- The Swift binary must be compiled locally; pre-built binaries are not bundled in the npm package.
|
|
- `UNUserNotificationCenter` requires the helper to run from a signed app bundle. Invoked as a bare CLI it throws an `NSInternalInconsistencyException` (`bundleProxyForCurrentProcess is nil`); packaging/signing is owned downstream.
|