7db59c9290
- 创建 pnpm monorepo 结构 (pnpm-workspace.yaml) - 添加 @ricardweii/claw-market CLI 包 - register/heartbeat/task/config 命令 - 中英文国际化支持 - JSON 输出格式支持 - 更新 openclaw-reporter skill 使用 CLI 替代 curl - 修复注册 API 返回缺少 name 字段的问题 - 更新 CLAUDE.md 文档说明 monorepo 结构
166 lines
6.8 KiB
Markdown
166 lines
6.8 KiB
Markdown
---
|
|
name: openclaw-reporter
|
|
description: |
|
|
Opt-in reporter for the OpenClaw global claw heatmap.
|
|
On first use, ASKS the user for consent before registering.
|
|
Sends a heartbeat (platform + model only) when the skill is loaded.
|
|
Task reports are only sent when the user explicitly mentions completing a task.
|
|
Data collected: user-chosen claw name, OS platform, model name, generic task category.
|
|
Credentials: the server returns an apiKey on registration, which is stored locally
|
|
in ~/.openclaw/config.json and sent as a Bearer token in subsequent requests.
|
|
No file paths, code, tool names, or project-specific data is ever sent.
|
|
requirements:
|
|
network: true
|
|
writeFiles:
|
|
- "~/.openclaw/config.json"
|
|
binaries:
|
|
- claw-market
|
|
env:
|
|
- name: CLAUDE_MODEL
|
|
required: false
|
|
description: "Current Claude model identifier. Used to report which model is active. Falls back to 'unknown' if not set."
|
|
hooks:
|
|
SessionStart:
|
|
- hooks:
|
|
- type: command
|
|
command: "claw-market heartbeat 2>/dev/null || true"
|
|
timeout: 10
|
|
---
|
|
|
|
# OpenClaw Reporter
|
|
|
|
This skill lets you participate in the OpenClaw global claw activity heatmap. It reports **minimal, non-code** activity data to visualize worldwide AI agent usage. Note: as with any HTTPS request, the server can observe your IP address.
|
|
|
|
## Prerequisites
|
|
|
|
This skill requires the `claw-market` CLI tool. Install it globally:
|
|
|
|
```bash
|
|
npm install -g @ricardweii/claw-market
|
|
```
|
|
|
|
## How It Works
|
|
|
|
- **Heartbeat**: Sent once when the skill is loaded (`SessionStart` hook). No other automated hooks are used — no `PostToolUse`, no `Stop` hooks.
|
|
- **Task report**: Sent **only** when the user explicitly mentions completing a task or asks for a report. The agent calls the task API directly — no automated scripts.
|
|
- **Registration**: One-time setup requiring explicit user consent (see below).
|
|
|
|
## Data Disclosure
|
|
|
|
This skill sends the following data to `https://kymr.top/` (the OpenClaw Market production server; server-side source code is in this repository under `app/api/v1/`):
|
|
|
|
| Data Field | Example | Purpose |
|
|
|---|---|---|
|
|
| Claw Name | `CoolClaw42` (user-chosen) | Your display name on the heatmap |
|
|
| Platform | `darwin`, `linux` | OS type for heatmap stats |
|
|
| Model | `claude-sonnet-4-6` | Model usage stats |
|
|
| Task summary | `"Completed a task"` | Generic activity indicator |
|
|
|
|
**Stored locally:** Registration returns an `apiKey` from the server, saved in `~/.openclaw/config.json` with `chmod 600` (owner-only access). The endpoint URL (`https://kymr.top/`) is hardcoded — not read from the config file — so a modified config cannot redirect telemetry.
|
|
|
|
**Visible to the server:** Your IP address is visible on every HTTPS request (inherent to any network call). The server uses IP for approximate geolocation on the heatmap — no more precise than city-level.
|
|
|
|
**Never sent:** system usernames, file paths, code snippets, project names, tool names, tool arguments, tool results, or secrets.
|
|
|
|
## Configuration
|
|
|
|
Config is stored at `~/.openclaw/config.json` (permissions `600`). Managed by the `claw-market` CLI tool.
|
|
|
|
## First-Time Setup (Requires User Consent)
|
|
|
|
If `~/.openclaw/config.json` does not exist, follow these steps:
|
|
|
|
### Step 1: Check CLI availability
|
|
|
|
First, verify `claw-market` is installed:
|
|
|
|
```bash
|
|
which claw-market || echo "NOT_INSTALLED"
|
|
```
|
|
|
|
If not installed, inform the user: "The openclaw-reporter skill requires the claw-market CLI. Install with: `npm install -g @ricardweii/claw-market`"
|
|
|
|
### Step 2: Ask for consent
|
|
|
|
Use the AskUserQuestion tool:
|
|
|
|
- Question: "OpenClaw Reporter wants to register a claw name and send a heartbeat (platform + model only) to https://kymr.top/ when the skill loads. Task reports are only sent when you explicitly mention completing a task. The server will issue an API key stored locally at ~/.openclaw/config.json. No file paths, code, tool names, or project data is sent. Allow?"
|
|
- Options: "Yes, register" / "No, skip"
|
|
|
|
**If the user selects "No, skip":** do NOT register and do NOT ask again in this session. Stop here.
|
|
|
|
### Step 3: Ask for a claw name
|
|
|
|
If the user consented, use AskUserQuestion again:
|
|
|
|
- Question: "Pick a name for your claw on the heatmap! (1-30 chars, letters/numbers/hyphens/underscores only, e.g. CoolClaw, NightCrawler, CodeClaw)"
|
|
- Let the user type a custom name via the "Other" option (no preset options needed, but provide a few fun suggestions as options)
|
|
- Options: "CoolClaw" / "CodeClaw" / "NightCrawler"
|
|
|
|
Use whatever the user provides as the claw name.
|
|
|
|
### Step 4: Register using CLI
|
|
|
|
After receiving the name, validate and register:
|
|
|
|
```bash
|
|
# Validate claw name: only allow alphanumeric, hyphens, underscores (1-30 chars).
|
|
CLAW_NAME="USER_CHOSEN_NAME_HERE"
|
|
|
|
if ! echo "$CLAW_NAME" | grep -qE '^[A-Za-z0-9_-]{1,30}$'; then
|
|
echo "Error: Claw name must be 1-30 characters, alphanumeric/hyphens/underscores only."
|
|
exit 1
|
|
fi
|
|
|
|
# Register using CLI
|
|
claw-market register "$CLAW_NAME"
|
|
```
|
|
|
|
## Task Reporting (Manual Only)
|
|
|
|
Task reports are **never sent automatically**. Only send a task report when the user explicitly mentions completing a task, finishing work, or asks to report activity.
|
|
|
|
When triggered, run:
|
|
|
|
```bash
|
|
# Estimate task duration (ask user or use a default)
|
|
DURATION_MS=60000 # Default 1 minute, adjust based on actual task time
|
|
|
|
claw-market task "Completed a task" --duration "$DURATION_MS" || echo "Task report failed (non-blocking)."
|
|
```
|
|
|
|
## Opt-Out / Unregister
|
|
|
|
To stop all OpenClaw reporting:
|
|
|
|
```bash
|
|
claw-market config clear
|
|
```
|
|
|
|
After deletion, no heartbeats or task reports will be sent. The skill will ask for consent again if re-enabled.
|
|
|
|
## Behavior Rules
|
|
|
|
1. **User consent is REQUIRED** before first registration — never register silently
|
|
2. If the user declines registration, respect the decision and do not ask again in the same session
|
|
3. Heartbeat is sent automatically via the `SessionStart` hook when the skill is loaded — this is the ONLY automated action
|
|
4. **Task reports are manual only** — only send when the user explicitly mentions completing a task or asks to report
|
|
5. If any OpenClaw request fails, continue normally — never interrupt the user's workflow
|
|
6. Never include identifying information in task summaries
|
|
7. **No system-level modifications**: never write to `~/.claude/settings.json` or any file outside `~/.openclaw/`
|
|
|
|
## CLI Reference
|
|
|
|
The `claw-market` CLI provides these commands:
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `claw-market register <name>` | Register a new claw |
|
|
| `claw-market heartbeat` | Send a heartbeat |
|
|
| `claw-market task <summary> -d <ms>` | Report a completed task |
|
|
| `claw-market config show` | Show current configuration |
|
|
| `claw-market config path` | Show config file path |
|
|
| `claw-market config clear` | Delete configuration (unregister) |
|
|
|
|
Global options: `--lang <en\|zh>`, `--json`, `--endpoint <url>`
|