Compare commits
6 Commits
ec09578de3
...
c9f61419cb
| Author | SHA1 | Date | |
|---|---|---|---|
| c9f61419cb | |||
| cc807484fc | |||
|
917cb344cf | ||
|
|
64a9c431bf | ||
| 957bcbb4a8 | |||
|
|
9195dc6bd1 |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -4,3 +4,5 @@ plugin/**/*.js
|
||||
plugin/**/*.js.map
|
||||
plugin/**/*.d.ts
|
||||
plugin/**/*.d.ts.map
|
||||
# Hand-written ambient declarations are tracked; only compiled .d.ts above is ignored.
|
||||
!plugin/openclaw-sdk.d.ts
|
||||
|
||||
192
README.md
192
README.md
@@ -1,84 +1,107 @@
|
||||
# HarborForge OpenClaw Plugin
|
||||
|
||||
OpenClaw 插件：向 HarborForge Monitor 暴露 OpenClaw 侧元数据，并提供可选的本地桥接能力；安装时也可顺带安装 `hf` CLI。
|
||||
OpenClaw plugin that exposes OpenClaw-side metadata to the HarborForge Monitor, provides an optional local Monitor bridge, drives the HarborForge Calendar scheduler, and can optionally install the `hf` CLI.
|
||||
|
||||
## 当前状态
|
||||
Part of the [HarborForge](../README.md) platform.
|
||||
|
||||
- 插件注册名：`harbor-forge`
|
||||
- 旧 sidecar `server/` 架构已移除
|
||||
- 监控桥接走本地 `monitor_port`
|
||||
- 安装脚本支持 `--install-cli`
|
||||
- `skills/hf/` 仅在 `--install-cli` 时一并安装
|
||||
- Role: OpenClaw integration layer for HarborForge (registered plugin id: `harbor-forge`).
|
||||
- Talks to the HarborForge backend (`backendUrl`, default `https://monitor.hangman-lab.top`) for Calendar APIs.
|
||||
- Talks to a local HarborForge.Monitor bridge over `127.0.0.1:<monitor_port>` (no fixed default; commonly `9100`).
|
||||
|
||||
## 项目结构
|
||||
## Current State
|
||||
|
||||
- Plugin registration id: `harbor-forge` (was `harborforge-monitor`)
|
||||
- Plugin version: `0.2.0` (package manifests); telemetry reports `pluginVersion` `0.3.1`
|
||||
- Legacy sidecar `server/` architecture removed — telemetry is served directly by the plugin
|
||||
- Monitor bridge runs over the local `monitor_port`
|
||||
- Calendar scheduler integration (PLG-CAL-001 / 002 / 004)
|
||||
- Installer supports `--install-cli` and an optional managed Monitor (`--install-monitor`)
|
||||
- `skills/hf/` is installed only with `--install-cli`
|
||||
|
||||
## Project Structure
|
||||
|
||||
```text
|
||||
HarborForge.OpenclawPlugin/
|
||||
├── package.json
|
||||
├── README.md
|
||||
├── docs/ # design notes (calendar, monitor connector)
|
||||
├── plugin/
|
||||
│ ├── openclaw.plugin.json
|
||||
│ ├── index.ts
|
||||
│ ├── openclaw.plugin.json # plugin manifest + config schema
|
||||
│ ├── index.ts # plugin entry, tool registration
|
||||
│ ├── tsconfig.json
|
||||
│ ├── core/
|
||||
│ │ ├── config.ts
|
||||
│ │ ├── managed-monitor.ts
|
||||
│ │ └── monitor-bridge.ts
|
||||
│ │ ├── config.ts # config defaults / resolution
|
||||
│ │ ├── managed-monitor.ts # optionally spawn HarborForge.Monitor
|
||||
│ │ ├── monitor-bridge.ts # client for the Monitor bridge
|
||||
│ │ └── openclaw-agents.ts # enumerate OpenClaw agents
|
||||
│ ├── calendar/ # Calendar scheduler + bridge
|
||||
│ │ ├── index.ts
|
||||
│ │ ├── scheduler.ts
|
||||
│ │ ├── calendar-bridge.ts
|
||||
│ │ └── types.ts
|
||||
│ ├── hooks/
|
||||
│ │ ├── gateway-start.ts
|
||||
│ │ └── gateway-stop.ts
|
||||
│ └── package.json
|
||||
├── skills/
|
||||
│ └── hf/
|
||||
│ └── SKILL.md
|
||||
│ └── SKILL.md # installed only with --install-cli
|
||||
└── scripts/
|
||||
└── install.mjs
|
||||
```
|
||||
|
||||
## 安装
|
||||
## Installation
|
||||
|
||||
### 普通安装
|
||||
### Standard Install
|
||||
|
||||
```bash
|
||||
node scripts/install.mjs
|
||||
```
|
||||
|
||||
这会：
|
||||
- 构建并安装 OpenClaw 插件
|
||||
- 复制常规 skills
|
||||
- **不会**安装 `hf` 二进制
|
||||
- **不会**复制 `skills/hf/`
|
||||
This will:
|
||||
- Build and install the OpenClaw plugin
|
||||
- Copy regular skills
|
||||
- **Not** install the `hf` binary
|
||||
- **Not** copy `skills/hf/`
|
||||
|
||||
### 安装插件 + `hf` CLI
|
||||
### Plugin + `hf` CLI
|
||||
|
||||
```bash
|
||||
node scripts/install.mjs --install-cli
|
||||
```
|
||||
|
||||
这会额外：
|
||||
- 构建 `HarborForge.Cli`
|
||||
- 安装 `hf` 到 `~/.openclaw/bin/hf`
|
||||
- `chmod +x ~/.openclaw/bin/hf`
|
||||
- 复制 `skills/hf/` 到 OpenClaw profile skills 目录
|
||||
This additionally:
|
||||
- Builds `HarborForge.Cli` (`go build ./cmd/hf`)
|
||||
- Installs `hf` to `<openclaw>/bin/hf` (default `~/.openclaw/bin/hf`) and `chmod +x`
|
||||
- Copies `skills/hf/` into the OpenClaw skills directory
|
||||
|
||||
### 常用选项
|
||||
### Common Options
|
||||
|
||||
```bash
|
||||
# 仅构建
|
||||
# Build only (no install / config)
|
||||
node scripts/install.mjs --build-only
|
||||
|
||||
# 指定 OpenClaw profile
|
||||
# Install only, skip dependency checks
|
||||
node scripts/install.mjs --skip-check
|
||||
|
||||
# Specify OpenClaw profile path (also honors OPENCLAW_PATH env)
|
||||
node scripts/install.mjs --openclaw-profile-path /custom/path/.openclaw
|
||||
|
||||
# 详细日志
|
||||
# Build and install a managed HarborForge.Monitor binary alongside the plugin
|
||||
node scripts/install.mjs --install-monitor yes --monitor-branch main
|
||||
|
||||
# Verbose logs
|
||||
node scripts/install.mjs --verbose
|
||||
|
||||
# 卸载
|
||||
# Uninstall (plugin, config entries, hf binary, managed monitor)
|
||||
node scripts/install.mjs --uninstall
|
||||
```
|
||||
|
||||
## 配置
|
||||
The installer also updates OpenClaw config (`plugins.load.paths`, `plugins.allow`, `plugins.entries.harbor-forge.enabled`) via `openclaw config`.
|
||||
|
||||
编辑 `~/.openclaw/openclaw.json`：
|
||||
## Configuration
|
||||
|
||||
Edit `~/.openclaw/openclaw.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -94,7 +117,9 @@ node scripts/install.mjs --uninstall
|
||||
"monitor_port": 9100,
|
||||
"reportIntervalSec": 30,
|
||||
"httpFallbackIntervalSec": 60,
|
||||
"logLevel": "info"
|
||||
"logLevel": "info",
|
||||
"calendarEnabled": true,
|
||||
"calendarHeartbeatIntervalSec": 60
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -102,51 +127,72 @@ node scripts/install.mjs --uninstall
|
||||
}
|
||||
```
|
||||
|
||||
然后重启：
|
||||
Then restart:
|
||||
|
||||
```bash
|
||||
openclaw gateway restart
|
||||
```
|
||||
|
||||
## 配置项
|
||||
## Config Options
|
||||
|
||||
| 选项 | 类型 | 默认值 | 说明 |
|
||||
|------|------|--------|------|
|
||||
| `enabled` | boolean | `true` | 是否启用插件 |
|
||||
| `backendUrl` | string | `https://monitor.hangman-lab.top` | HarborForge Monitor 后端地址 |
|
||||
| `identifier` | string | 主机名 | 服务器标识符 |
|
||||
| `apiKey` | string | 无 | HarborForge Monitor 生成的服务器 API Key |
|
||||
| `monitor_port` | number | 无 | 本地桥接端口；插件通过 `127.0.0.1:<monitor_port>` 与 HarborForge.Monitor 通信 |
|
||||
| `reportIntervalSec` | number | `30` | 报告间隔（秒） |
|
||||
| `httpFallbackIntervalSec` | number | `60` | HTTP 回退间隔（秒） |
|
||||
| `logLevel` | string | `info` | 日志级别：`debug` / `info` / `warn` / `error` |
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `enabled` | boolean | `true` | Enable the plugin |
|
||||
| `backendUrl` | string | `https://monitor.hangman-lab.top` | HarborForge backend base URL (Monitor + Calendar APIs) |
|
||||
| `identifier` | string | hostname | Server / claw identifier |
|
||||
| `apiKey` | string | (none) | Server API key from the HarborForge Monitor admin panel |
|
||||
| `monitor_port` | number | (none) | Local bridge port; plugin talks to HarborForge.Monitor via `127.0.0.1:<monitor_port>` |
|
||||
| `reportIntervalSec` | number | `30` | Metadata push interval (seconds) |
|
||||
| `httpFallbackIntervalSec` | number | `60` | HTTP heartbeat interval when WS unavailable |
|
||||
| `logLevel` | string | `info` | Log level: `debug` / `info` / `warn` / `error` |
|
||||
| `calendarEnabled` | boolean | `true` | Enable Calendar scheduler integration (PLG-CAL-001) |
|
||||
| `calendarHeartbeatIntervalSec` | number | `60` | Calendar heartbeat interval (seconds) |
|
||||
| `calendarApiKey` | string | (none) | API key for Calendar API auth; falls back to `apiKey` / `X-Agent-ID` |
|
||||
| `managedMonitor` | string | (none) | Absolute path to a HarborForge.Monitor binary; if set, gateway start/stop hooks spawn/stop it |
|
||||
|
||||
## 本地桥接说明
|
||||
## Local Monitor Bridge
|
||||
|
||||
当插件配置了 `monitor_port`，并且 HarborForge.Monitor 也使用相同的 `MONITOR_PORT` 时：
|
||||
When the plugin has `monitor_port` configured and HarborForge.Monitor uses the same `MONITOR_PORT`:
|
||||
|
||||
- Monitor 在 `127.0.0.1:<MONITOR_PORT>` 提供本地桥接服务
|
||||
- 插件可探测 `GET /health`
|
||||
- 插件工具 `harborforge_monitor_telemetry` 可读取 `GET /telemetry`
|
||||
- 如果桥接端口未配置或不可达，插件仍可正常运行
|
||||
- Monitor serves a local bridge on `127.0.0.1:<MONITOR_PORT>`
|
||||
- The plugin probes `GET /health`
|
||||
- The plugin tool `harborforge_monitor_telemetry` reads `GET /telemetry`
|
||||
- The plugin pushes OpenClaw metadata (version, plugin version, agents) via `POST /openclaw` on the `reportIntervalSec` cadence, enriching Monitor heartbeats
|
||||
- If the bridge port is unconfigured or unreachable, the plugin still works normally
|
||||
|
||||
也就是说，这条链路是**可选增强**，不是插件启动或 Monitor 心跳的前置条件。
|
||||
This link is an **optional enhancement**, not a precondition for the plugin to start or for Monitor heartbeats.
|
||||
|
||||
## 插件提供的信息
|
||||
## Managed Monitor
|
||||
|
||||
### OpenClaw 元数据
|
||||
- OpenClaw version
|
||||
- plugin version
|
||||
- 标识符 / 主机名
|
||||
- 时间戳
|
||||
If `managedMonitor` points to an installed HarborForge.Monitor binary, the `gateway_start` hook spawns it (passing `--backend-url`, `--identifier`, `--api-key`, `--monitor-port`, `--report-interval`, `--log-level` from the plugin config) and `gateway_stop` terminates it. Use `install.mjs --install-monitor yes` to build and wire this automatically.
|
||||
|
||||
### 系统快照
|
||||
- uptime
|
||||
- memory total/free/used/usagePercent
|
||||
- load avg1/avg5/avg15
|
||||
- platform
|
||||
## Calendar Scheduler
|
||||
|
||||
## 开发
|
||||
When `calendarEnabled` is true, on gateway start the plugin starts a Calendar scheduler that heartbeats the backend (`/calendar/agent/heartbeat`, `/calendar/agent/status`, `/calendar/agent/notify`) to receive and run scheduled TimeSlots, waking/spawning agents via the OpenClaw `spawn` API (with a notification fallback). Scheduler state is persisted to a state file; gateway restarts can be requested by the backend (PLG-CAL-004).
|
||||
|
||||
## Tools Provided
|
||||
|
||||
| Tool | Description |
|
||||
|------|-------------|
|
||||
| `harborforge_status` | Plugin status, resolved config, Monitor bridge health, calendar status, telemetry snapshot |
|
||||
| `harborforge_telemetry` | Current system telemetry snapshot from this host |
|
||||
| `harborforge_monitor_telemetry` | Query the Monitor bridge for host hardware telemetry |
|
||||
| `harborforge_calendar_status` | Calendar scheduler status and current slot |
|
||||
| `harborforge_calendar_complete` | Complete the current calendar slot with actual duration |
|
||||
| `harborforge_calendar_abort` | Abort the current calendar slot |
|
||||
| `harborforge_calendar_pause` | Pause the current calendar slot |
|
||||
| `harborforge_calendar_resume` | Resume the paused calendar slot |
|
||||
| `harborforge_restart_status` | Check whether a gateway restart is pending |
|
||||
|
||||
### Telemetry Snapshot Fields
|
||||
|
||||
- `identifier`, `hostname`, `platform`, `timestamp`
|
||||
- `uptime`
|
||||
- `memory`: `total` / `free` / `used` / `usagePercent`
|
||||
- `load`: `avg1` / `avg5` / `avg15`
|
||||
- `openclaw`: `version` / `pluginVersion`
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
cd plugin
|
||||
@@ -154,14 +200,16 @@ npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
## 依赖
|
||||
The build runs `tsc` and emits `dist/` (`dist/index.js` is the plugin entry).
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Node.js 18+
|
||||
- OpenClaw Gateway
|
||||
- Go 1.20+（仅 `--install-cli` 需要）
|
||||
- Go 1.20+ (only for `--install-cli` / `--install-monitor`)
|
||||
|
||||
## 相关提示
|
||||
## Tips
|
||||
|
||||
- 安装 `hf` 后，建议把 `~/.openclaw/bin` 加到 `PATH`
|
||||
- Agent 使用 `hf` 时，优先试 `hf --help-brief`
|
||||
- 完整命令树看 `hf --help`
|
||||
- After installing `hf`, add `~/.openclaw/bin` to your `PATH`
|
||||
- When an agent uses `hf`, try `hf --help-brief` first
|
||||
- For the full command tree, see `hf --help`
|
||||
|
||||
@@ -29,7 +29,7 @@ import {
|
||||
CalendarSlotResponse,
|
||||
SlotAgentUpdate,
|
||||
SlotStatus,
|
||||
} from './types';
|
||||
} from './types.js';
|
||||
|
||||
export interface CalendarBridgeConfig {
|
||||
/** HarborForge backend base URL (e.g. "https://monitor.hangman-lab.top") */
|
||||
@@ -292,7 +292,7 @@ export class CalendarBridgeClient {
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
import { hostname } from 'os';
|
||||
import { getPluginConfig } from '../core/config';
|
||||
import { getPluginConfig } from '../core/config.js';
|
||||
|
||||
export interface CalendarPluginConfig {
|
||||
/** Backend URL for calendar API (overrides monitor backendUrl) */
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
* • AgentWakeContext — context passed to agent when waking
|
||||
*
|
||||
* Usage in plugin/index.ts:
|
||||
* import { createCalendarBridgeClient, createCalendarScheduler } from './calendar';
|
||||
* import { createCalendarBridgeClient, createCalendarScheduler } from './calendar.js';
|
||||
*
|
||||
* const agentId = process.env.AGENT_ID || 'unknown';
|
||||
* const calendar = createCalendarBridgeClient(api, 'https://monitor.hangman-lab.top', agentId);
|
||||
@@ -28,7 +28,7 @@
|
||||
* scheduler.start();
|
||||
*/
|
||||
|
||||
export * from './types';
|
||||
export * from './calendar-bridge';
|
||||
export * from './scheduler';
|
||||
export * from './schedule-cache';
|
||||
export * from './types.js';
|
||||
export * from './calendar-bridge.js';
|
||||
export * from './scheduler.js';
|
||||
export * from './schedule-cache.js';
|
||||
|
||||
@@ -18,8 +18,7 @@
|
||||
|
||||
import { writeFileSync, readFileSync, existsSync, mkdirSync } from 'fs';
|
||||
import { join, dirname } from 'path';
|
||||
import { CalendarBridgeClient } from './calendar-bridge';
|
||||
import { ScheduleCache } from './schedule-cache';
|
||||
import { CalendarBridgeClient } from './calendar-bridge.js';
|
||||
import {
|
||||
CalendarSlotResponse,
|
||||
SlotStatus,
|
||||
@@ -27,7 +26,7 @@ import {
|
||||
SlotAgentUpdate,
|
||||
CalendarEventDataJob,
|
||||
CalendarEventDataSystemEvent,
|
||||
} from './types';
|
||||
} from './types.js';
|
||||
|
||||
export interface CalendarSchedulerConfig {
|
||||
/** Calendar bridge client for backend communication */
|
||||
@@ -45,8 +44,6 @@ export interface CalendarSchedulerConfig {
|
||||
};
|
||||
/** Heartbeat interval in milliseconds (default: 60000) */
|
||||
heartbeatIntervalMs?: number;
|
||||
/** Schedule sync interval in milliseconds (default: 300000 = 5 min) */
|
||||
syncIntervalMs?: number;
|
||||
/** Enable verbose debug logging */
|
||||
debug?: boolean;
|
||||
/** Directory for state persistence (default: plugin data dir) */
|
||||
@@ -98,10 +95,8 @@ interface SchedulerState {
|
||||
currentSlot: CalendarSlotResponse | null;
|
||||
/** Last heartbeat timestamp */
|
||||
lastHeartbeatAt: Date | null;
|
||||
/** Heartbeat interval handle */
|
||||
/** Interval handle for cleanup */
|
||||
intervalHandle: ReturnType<typeof setInterval> | null;
|
||||
/** Schedule sync interval handle */
|
||||
syncIntervalHandle: ReturnType<typeof setInterval> | null;
|
||||
/** Set of slot IDs that have been deferred in current session */
|
||||
deferredSlotIds: Set<string>;
|
||||
/** Whether agent is currently processing a slot */
|
||||
@@ -122,13 +117,10 @@ export class CalendarScheduler {
|
||||
private config: Required<CalendarSchedulerConfig>;
|
||||
private state: SchedulerState;
|
||||
private stateFilePath: string;
|
||||
/** Local cache of today's full schedule, synced periodically from backend */
|
||||
private scheduleCache: ScheduleCache = new ScheduleCache();
|
||||
|
||||
constructor(config: CalendarSchedulerConfig) {
|
||||
this.config = {
|
||||
heartbeatIntervalMs: 60000, // 1 minute default
|
||||
syncIntervalMs: 300_000, // 5 minutes default
|
||||
debug: false,
|
||||
stateDir: this.getDefaultStateDir(),
|
||||
...config,
|
||||
@@ -141,7 +133,6 @@ export class CalendarScheduler {
|
||||
currentSlot: null,
|
||||
lastHeartbeatAt: null,
|
||||
intervalHandle: null,
|
||||
syncIntervalHandle: null,
|
||||
deferredSlotIds: new Set(),
|
||||
isProcessing: false,
|
||||
isRestartPending: false,
|
||||
@@ -336,21 +327,14 @@ export class CalendarScheduler {
|
||||
this.state.isRestartPending = false;
|
||||
this.config.logger.info('Calendar scheduler started');
|
||||
|
||||
// Run initial sync + heartbeat immediately
|
||||
this.runSync();
|
||||
// Run initial heartbeat immediately
|
||||
this.runHeartbeat();
|
||||
|
||||
// Schedule periodic heartbeats (slot execution checks)
|
||||
// Schedule periodic heartbeats
|
||||
this.state.intervalHandle = setInterval(
|
||||
() => this.runHeartbeat(),
|
||||
this.config.heartbeatIntervalMs
|
||||
);
|
||||
|
||||
// Schedule periodic schedule sync (full day schedule refresh)
|
||||
this.state.syncIntervalHandle = setInterval(
|
||||
() => this.runSync(),
|
||||
this.config.syncIntervalMs
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -364,41 +348,10 @@ export class CalendarScheduler {
|
||||
clearInterval(this.state.intervalHandle);
|
||||
this.state.intervalHandle = null;
|
||||
}
|
||||
if (this.state.syncIntervalHandle) {
|
||||
clearInterval(this.state.syncIntervalHandle);
|
||||
this.state.syncIntervalHandle = null;
|
||||
}
|
||||
|
||||
this.config.logger.info('Calendar scheduler stopped');
|
||||
}
|
||||
|
||||
/**
|
||||
* Sync today's full schedule from backend into local cache.
|
||||
* Runs every syncIntervalMs (default: 5 min).
|
||||
* Catches new slots assigned by other agents or the manager.
|
||||
*/
|
||||
async runSync(): Promise<void> {
|
||||
if (!this.state.isRunning || this.state.isRestartPending) return;
|
||||
|
||||
const today = new Date().toISOString().slice(0, 10);
|
||||
try {
|
||||
const slots = await this.config.bridge.getDaySchedule(today);
|
||||
if (slots) {
|
||||
this.scheduleCache.sync(today, slots);
|
||||
this.logDebug(`Schedule synced: ${slots.length} slots for ${today}`);
|
||||
}
|
||||
} catch (err) {
|
||||
this.config.logger.warn(`Schedule sync failed: ${String(err)}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the local schedule cache (for status reporting / tools).
|
||||
*/
|
||||
getScheduleCache(): ScheduleCache {
|
||||
return this.scheduleCache;
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a single heartbeat cycle.
|
||||
* Fetches pending slots and handles execution logic.
|
||||
@@ -658,11 +611,13 @@ Task Code: ${code}
|
||||
Estimated Duration: ${duration} minutes
|
||||
Slot Type: ${slot.slot_type}
|
||||
Priority: ${slot.priority}
|
||||
Working Sessions: ${jobData.working_sessions?.join(', ') || 'none recorded'}
|
||||
|
||||
Follow the daily-routine skill's task-handson workflow to execute this task.
|
||||
Use harborforge_calendar_complete when finished, or harborforge_calendar_pause to pause.
|
||||
Before going idle, check for overdue slots as described in the slot-complete workflow.`;
|
||||
Please focus on this task for the allocated time. When you finish or need to pause,
|
||||
report your progress back to the calendar system.
|
||||
|
||||
Working sessions: ${jobData.working_sessions?.join(', ') || 'none recorded'}
|
||||
|
||||
Start working on ${code} now.`;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -675,15 +630,19 @@ Before going idle, check for overdue slots as described in the slot-complete wor
|
||||
switch (sysData.event) {
|
||||
case 'ScheduleToday':
|
||||
return `System Event: Schedule Today
|
||||
|
||||
Please review today's calendar and schedule any pending tasks or planning activities.
|
||||
Estimated time: ${slot.estimated_duration} minutes.
|
||||
|
||||
Follow the daily-routine skill's plan-schedule workflow to plan today's work.`;
|
||||
Check your calendar and plan the day's work.`;
|
||||
|
||||
case 'SummaryToday':
|
||||
return `System Event: Daily Summary
|
||||
|
||||
Please provide a summary of today's activities and progress.
|
||||
Estimated time: ${slot.estimated_duration} minutes.
|
||||
|
||||
Review today's completed, deferred, and abandoned slots. Write a summary to your daily note (memory/YYYY-MM-DD.md).`;
|
||||
Review what was accomplished and prepare end-of-day notes.`;
|
||||
|
||||
case 'ScheduledGatewayRestart':
|
||||
return `System Event: Scheduled Gateway Restart
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { hostname } from 'os';
|
||||
import { getPluginConfig } from '../core/config';
|
||||
import { startManagedMonitor } from '../core/managed-monitor';
|
||||
import { getPluginConfig } from '../core/config.js';
|
||||
import { startManagedMonitor } from '../core/managed-monitor.js';
|
||||
|
||||
export function registerGatewayStartHook(api: any, deps: {
|
||||
logger: any;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { stopManagedMonitor } from '../core/managed-monitor';
|
||||
import { stopManagedMonitor } from '../core/managed-monitor.js';
|
||||
|
||||
export function registerGatewayStopHook(api: any, deps: {
|
||||
logger: any;
|
||||
|
||||
@@ -11,18 +11,20 @@
|
||||
* served directly by the plugin when Monitor queries via the
|
||||
* local monitor_port communication path.
|
||||
*/
|
||||
import { hostname, freemem, totalmem, uptime, loadavg, platform } from 'os';
|
||||
import { getPluginConfig } from './core/config';
|
||||
import { MonitorBridgeClient, type OpenClawMeta } from './core/monitor-bridge';
|
||||
import type { OpenClawAgentInfo } from './core/openclaw-agents';
|
||||
import { registerGatewayStartHook } from './hooks/gateway-start';
|
||||
import { registerGatewayStopHook } from './hooks/gateway-stop';
|
||||
import { hostname, freemem, totalmem, uptime, loadavg, platform } from 'node:os';
|
||||
import { definePluginEntry } from 'openclaw/plugin-sdk/plugin-entry';
|
||||
import { MultiAgentScheduleCache } from './calendar/schedule-cache.js';
|
||||
import { getPluginConfig } from './core/config.js';
|
||||
import { MonitorBridgeClient, type OpenClawMeta } from './core/monitor-bridge.js';
|
||||
import type { OpenClawAgentInfo } from './core/openclaw-agents.js';
|
||||
import { registerGatewayStartHook } from './hooks/gateway-start.js';
|
||||
import { registerGatewayStopHook } from './hooks/gateway-stop.js';
|
||||
import {
|
||||
createCalendarBridgeClient,
|
||||
createCalendarScheduler,
|
||||
CalendarScheduler,
|
||||
AgentWakeContext,
|
||||
} from './calendar';
|
||||
} from './calendar/index.js';
|
||||
|
||||
interface PluginAPI {
|
||||
logger: {
|
||||
@@ -53,10 +55,7 @@ interface PluginAPI {
|
||||
getAgentStatus?: () => Promise<{ status: string } | null>;
|
||||
}
|
||||
|
||||
export default {
|
||||
id: 'harbor-forge',
|
||||
name: 'HarborForge',
|
||||
register(api: PluginAPI) {
|
||||
function register(api: PluginAPI): void {
|
||||
const logger = api.logger || {
|
||||
info: (...args: any[]) => console.log('[HarborForge]', ...args),
|
||||
error: (...args: any[]) => console.error('[HarborForge]', ...args),
|
||||
@@ -290,7 +289,6 @@ export default {
|
||||
);
|
||||
|
||||
// Multi-agent sync + check loop
|
||||
const { MultiAgentScheduleCache } = require('./calendar/schedule-cache') as typeof import('./calendar/schedule-cache');
|
||||
const scheduleCache = new MultiAgentScheduleCache();
|
||||
|
||||
const SYNC_INTERVAL_MS = 300_000; // 5 min
|
||||
@@ -595,5 +593,16 @@ export default {
|
||||
}));
|
||||
|
||||
logger.info('HarborForge plugin registered (id: harbor-forge)');
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
// HarborForge's local PluginAPI is broader than the standard OpenClawPluginApi
|
||||
// (it surfaces optional `version`/`runtime`/`spawn` accessors that older
|
||||
// OpenClaw builds exposed). The cast at the definePluginEntry boundary
|
||||
// acknowledges that gap — the runtime api object is whatever the gateway
|
||||
// passes us, and each access is guarded with optional chaining / fallbacks.
|
||||
export default definePluginEntry({
|
||||
id: 'harbor-forge',
|
||||
name: 'HarborForge',
|
||||
description: 'HarborForge plugin for OpenClaw - project management, monitoring, and CLI integration',
|
||||
register: register as (api: any) => void,
|
||||
});
|
||||
|
||||
25
plugin/openclaw-sdk.d.ts
vendored
Normal file
25
plugin/openclaw-sdk.d.ts
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
// Ambient declarations for the focused subpaths of the openclaw plugin SDK
|
||||
// that this plugin needs at compile time.
|
||||
//
|
||||
// We intentionally do NOT take a `dependencies` (or `devDependencies`) entry
|
||||
// on the openclaw npm package itself: openclaw is provided by the host
|
||||
// gateway at runtime, and listing it as a file:/.../openclaw devDep breaks
|
||||
// the installer's `npm install --omit=dev` step because npm/arborist trips
|
||||
// over openclaw's own (deeply nested) dependency graph.
|
||||
//
|
||||
// These declarations cover only what we use here. They are deliberately
|
||||
// permissive — the runtime contract is whatever the gateway hands us, and
|
||||
// we guard each api access with optional chaining or a fallback at call site.
|
||||
|
||||
declare module 'openclaw/plugin-sdk/plugin-entry' {
|
||||
export function definePluginEntry<T extends {
|
||||
id: string;
|
||||
name: string;
|
||||
description?: string;
|
||||
register: (api: any) => void | Promise<void>;
|
||||
}>(opts: T): T;
|
||||
}
|
||||
|
||||
declare module 'openclaw/plugin-sdk/core' {
|
||||
export type OpenClawPluginApi = unknown;
|
||||
}
|
||||
@@ -1,9 +1,19 @@
|
||||
{
|
||||
"id": "harbor-forge",
|
||||
"name": "HarborForge",
|
||||
"version": "0.2.0",
|
||||
"description": "HarborForge plugin for OpenClaw - project management, monitoring, and CLI integration",
|
||||
"entry": "./dist/index.js",
|
||||
"activation": {
|
||||
"onStartup": true
|
||||
},
|
||||
"contracts": {
|
||||
"tools": [
|
||||
"harborforge_status",
|
||||
"harborforge_telemetry",
|
||||
"harborforge_monitor_telemetry",
|
||||
"harborforge_calendar_status",
|
||||
"harborforge_calendar_complete"
|
||||
]
|
||||
},
|
||||
"configSchema": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
"name": "harbor-forge-plugin",
|
||||
"version": "0.2.0",
|
||||
"description": "OpenClaw plugin for HarborForge monitor bridge and CLI integration",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"scripts": {
|
||||
"clean": "rm -rf dist",
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2022",
|
||||
"module": "CommonJS",
|
||||
"moduleResolution": "node",
|
||||
"module": "nodenext",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true,
|
||||
"strict": true,
|
||||
"skipLibCheck": true,
|
||||
|
||||
Reference in New Issue
Block a user