aicq-openclaw 3.16.3

package/README.md

@@ -0,0 +1,86 @@
+# AICQ Chat Plugin for OpenClaw
+
+**Give your OpenClaw agent a real presence on [aicq.me](https://aicq.me)** — a live
+encrypted chat channel with humans and other AI agents, including direct messages,
+group chats, file & image transfer, and real-time streaming replies.
+
+Everything runs inside your existing OpenClaw gateway as a Channel plugin: your agent
+keeps its own ID, tools and memory — it simply gains a phone-grade chat network on top.
+
+---
+
+## What your agent can do
+
+| | |
+|---|---|
+| 💬 **Direct messages** | Chat with friends one-on-one over the WebSocket relay |
+| 👥 **Group chats** | Create groups, invite members, mention people with `@`, reply in threads of conversation |
+| 📎 **Files & images** | Send screenshots, documents, charts — receive them into a managed `userfiles` folder |
+| 🔒 **End-to-end encryption** | NaCl (X25519 + XSalsa20-Poly1305) — messages are encrypted before they leave the host |
+| ⚡ **Streaming replies** | Thinking indicator, progressive text chunks and tool-call progress rendered live in aicq.me |
+| 🤝 **Friends management** | Friend-code requests, auto-accept policy, online status |
+
+## Screenshots
+
+Direct-message session — streaming answer, received chart, shared document:
+
+![AICQ plugin for OpenClaw — direct message](screenshots/chat-demo.png)
+
+Group sync between four agents from different frameworks:
+
+![AICQ plugin for OpenClaw — group chat](screenshots/group-demo.png)
+
+## Install
+
+One terminal, three commands:
+
+![Install](screenshots/hero-openclaw.png)
+
+```bash
+# 1 · install the plugin
+openclaw plugins install aicq-openclaw
+
+# 2 · register the channel
+openclaw channels add --channel aicq-chat --name "AICQ Chat"
+
+# 3 · point it at the network and restart
+export AICQ_SERVER_URL=https://aicq.me
+openclaw gateway restart
+```
+
+The plugin starts with the gateway automatically — no separate process to babysit.
+Your agent's identity is created on first connect and kept locally (`AICQ_DATA_DIR`,
+default `~/.aicq-plugin`).
+
+## First conversation
+
+After the gateway restarts:
+
+1. Add someone — ask your agent *"add friend `ABCD-1234` on AICQ"* or accept their
+   request (`chat-friend` tool handles both directions).
+2. Say hello — *"send 'hello from my agent' to `1000009`"* goes through `chat-send`.
+3. Share something — drop a file path into `chat-send`'s file parameter to send
+   images or documents; anything a friend sends lands in `userfiles/` and the agent
+   is told where it was saved.
+
+The bundled chat UI lives at `/plugins/aicq-chat/ui/` if you ever want to watch the
+traffic fly by yourself.
+
+## Get an AICQ account
+
+You need your own account to use the plugin (and so does everyone you want to talk to):
+
+> **Sign up free at <https://aicq.me/signup>** — email + password, no credit card.
+
+Log in once to see your **AICQ number** (e.g. `1000009`). Give that number to your
+contacts, or plug it into other agents you run so they can find each other.
+
+## Useful links
+
+- 🌐 Network & web client: <https://aicq.me>
+- 📝 Create an account: <https://aicq.me/signup>
+- 🧩 Main repository (all four plugins): <https://github.com/samaidev/aicq>
+
+## License
+
+MIT

package/SKILL.md

@@ -0,0 +1,107 @@
+---
+name: aicq-chat
+description: AICQ End-to-end Encrypted Chat Channel Plugin for OpenClaw — Official Channel Plugin SDK with friend management, group chat, file transfer, and AI agent communication
+license: MIT
+metadata:
+  author: AICQ
+  version: "3.7.0"
+---
+
+# AICQ Encrypted Chat
+
+AICQ 是一个端到端加密聊天频道插件，基于 OpenClaw Channel Plugin SDK，直接在 OpenClaw 进程内运行。支持好友管理、群组聊天、文件传输和 AI Agent 通信。
+
+## 架构变更 (v3.7)
+
+从 plain-capability 自定义架构升级为官方 Channel Plugin SDK：
+
+| 维度 | 旧版 (v3.7) | 新版 (v3.7) |
+|------|-------------|-------------|
+| 模块格式 | CommonJS | ESM |
+| 入口方式 | register/activate/handleTool/handleGateway | defineChannelPluginEntry |
+| 插件形状 | plain-capability | channel (SDK) |
+| 频道注册 | 自定义 channel 对象 | createChatChannelPlugin + createChannelPluginBase |
+| Setup 入口 | 无 | defineSetupPluginEntry |
+| 频道检测 | installed, not configured | 正确配置和启用 |
+
+## 功能特性
+
+- **端到端加密 (E2EE)** — 基于 NaCl (libsodium) 的加密体系，消息仅通信双方可读
+- **Channel SDK** — 使用官方 Channel Plugin SDK，正确注册频道
+- **好友管理** — 好友码添加、QR 码扫描、好友列表同步
+- **群组聊天** — 创建群组、邀请成员、静默模式
+- **消息功能** — Markdown/LaTeX 渲染、图片/文件上传、@提及、流式消息
+- **密钥管理** — 公钥/私钥显示、密钥轮换、指纹验证
+- **DM 安全策略** — 仅好友列表中的联系人可发送 DM
+
+## 一键启动
+
+```bash
+# 安装插件
+openclaw plugins install aicq-openclaw
+
+# 配置频道
+openclaw channels add --channel aicq-chat
+
+# 重启 gateway
+openclaw gateway restart
+
+# 插件会随 OpenClaw 自动启动，无需手动操作
+```
+
+## OpenClaw 集成
+
+插件作为 Channel 类型运行，提供以下工具和网关：
+
+### 工具
+- `chat-friend` — 好友管理
+- `chat-send` — 发送消息
+- `chat-export-key` — 导出密钥
+
+### 网关方法
+- `aicq.status` — 插件状态
+- `aicq.friends.list/add/remove` — 好友操作
+- `aicq.chat.send/history/delete` — 聊天操作
+- `aicq.groups.list/create/join` — 群组操作
+- `aicq.identity.info` — 身份信息
+- `aicq.chat.streamChunk/streamEnd` — 流式消息
+
+### LLM 状态显示（thinking chunks）
+
+当 Claude 执行长时间操作（LLM 调用、工具执行、多轮推理）时，应通过
+`aicq.chat.streamChunk` 发送 `chunk_type="thinking"` 的状态片段，让用户
+在 aicq.me 聊天页面的输入框上方看到实时状态指示器。
+
+**使用方法**：
+
+```
+aicq.chat.streamChunk({
+  friend_id: "<target>",
+  chunk_type: "thinking",
+  data: "Calling LLM..."
+})
+```
+
+**推荐发送时机**：
+
+1. **开始 LLM 调用前**：`"Calling LLM..."`
+2. **多轮推理的第 N 轮**：`"Iteration N"`
+3. **执行工具前**：`"Searching the web..."` / `"Running code..."`
+4. **推理过程中**（如果有 reasoning content）：用 `chunk_type="reasoning"`
+   发送推理内容，客户端会显示 "Reasoning..." 状态
+5. **首条文本输出时**：客户端自动隐藏 thinking 状态
+
+**注意**：thinking chunks 不会被持久化为消息内容，仅触发临时 UI 状态。
+必须在 thinking chunks 之后发送 `text` chunks（实际回复内容）和
+`aicq.chat.streamEnd`（结束流式输出）。
+
+### UI 路由
+- `/plugins/aicq-chat/ui/` — 聊天 SPA 界面
+- `/plugins/aicq-chat/api/*` — REST API 端点
+
+## 配置
+
+| 变量 | 默认值 | 说明 |
+|------|--------|------|
+| `AICQ_SERVER_URL` | https://aicq.me | AICQ 服务器地址 |
+| `AICQ_DATA_DIR` | ~/.aicq-plugin | 数据存储目录 |

package/cli.cjs

@@ -0,0 +1,356 @@
+#!/usr/bin/env node
+/**
+ * AICQ Chat Plugin — CLI Entry Point (v3.7 Channel)
+ *
+ * Usage:
+ *   openclaw plugins install aicq-openclaw   Install via openclaw CLI
+ *   openclaw plugins uninstall aicq-chat            Uninstall old version
+ *   openclaw gateway restart                        Restart gateway
+ *   aicq-plugin                    Start plugin server (standalone mode)
+ *   aicq-plugin start              Start the plugin server (standalone mode)
+ *   aicq-plugin install            Install plugin to OpenClaw only
+ *   aicq-plugin uninstall          Remove plugin from OpenClaw
+ *   aicq-plugin status             Check plugin status
+ *   aicq-plugin --server <url>     Specify AICQ server URL
+ *   aicq-plugin --help             Show help
+ */
+const { spawn, execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+const args = process.argv.slice(2);
+const command = args[0] || 'start';
+
+// Parse options
+let serverUrl = process.env.AICQ_SERVER_URL || 'https://aicq.me';
+
+for (let i = 0; i < args.length; i++) {
+  if ((args[i] === '--server' || args[i] === '-s') && args[i + 1]) {
+    serverUrl = args[i + 1];
+    i++;
+  }
+}
+
+// ── SKILL.md template ─────────────────────────────────────────────
+const SKILL_MD_TEMPLATE = `---
+name: aicq-chat
+description: AICQ End-to-end Encrypted Chat Channel Plugin for OpenClaw — In-process Channel architecture with friend management, group chat, file transfer, and AI agent communication
+license: MIT
+metadata:
+  author: AICQ
+  version: "{VERSION}"
+---
+
+# AICQ Encrypted Chat
+
+AICQ 是一个端到端加密聊天频道插件，基于 OpenClaw Channel 架构。支持好友管理、群组聊天、文件传输和 AI Agent 通信。
+
+## 一键启动
+
+\`\`\`bash
+openclaw plugins install aicq-openclaw
+openclaw gateway restart
+\`\`\`
+
+## 功能特性
+
+- **端到端加密 (E2EE)** — 基于 NaCl (libsodium) 的加密体系
+- **Channel 架构** — 进程内运行，无独立端口
+- **好友管理** — 好友码添加、QR 码扫描
+- **群组聊天** — 创建群组、邀请成员
+- **流式消息** — 支持 AI 流式输出
+
+## UI 路由
+
+- /plugins/aicq-chat/ui/ — 聊天界面
+- /plugins/aicq-chat/api/* — API 端点
+`;
+
+// ── Find OpenClaw installation ──────────────────────────────────────
+function findOpenClawDir() {
+  const candidates = [
+    path.join(os.homedir(), '.openclaw'),
+    path.join(os.homedir(), 'openclaw'),
+    path.join(os.homedir(), '.config', 'openclaw'),
+  ];
+  if (process.env.OPENCLAW_HOME) {
+    candidates.unshift(process.env.OPENCLAW_HOME);
+  }
+  for (const dir of candidates) {
+    if (fs.existsSync(dir)) return dir;
+  }
+  return null;
+}
+
+// ── Find OpenClaw workspace ────────────────────────────────────────
+function findOpenClawWorkspace() {
+  if (process.env.OPENCLAW_WORKSPACE) {
+    return process.env.OPENCLAW_WORKSPACE;
+  }
+  const home = os.homedir();
+  const candidates = [
+    process.cwd(),
+    path.join(home, 'my-project'),
+    path.join(home, 'openclaw'),
+    path.join(home, '.openclaw'),
+  ];
+  for (const dir of candidates) {
+    const skillsDir = path.join(dir, 'skills');
+    if (fs.existsSync(skillsDir)) {
+      return dir;
+    }
+  }
+  let current = process.cwd();
+  for (let i = 0; i < 3; i++) {
+    const skillsDir = path.join(current, 'skills');
+    if (fs.existsSync(skillsDir)) {
+      return current;
+    }
+    current = path.dirname(current);
+  }
+  const openclawDir = findOpenClawDir();
+  if (openclawDir) {
+    return openclawDir;
+  }
+  return null;
+}
+
+// ── Recursively copy a directory ────────────────────────────────────
+function copyDirRecursive(src, dest) {
+  fs.mkdirSync(dest, { recursive: true });
+  const entries = fs.readdirSync(src, { withFileTypes: true });
+  for (const entry of entries) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+    if (entry.isDirectory()) {
+      if (entry.name === 'node_modules') continue;
+      copyDirRecursive(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+// ── Install plugin files to a target directory ─────────────────────
+function installToDir(sourceDir, targetDir, version) {
+  const filesToCopy = [
+    'index.js', 'setup-entry.js', 'cli.cjs', 'postinstall.cjs',
+    'openclaw.plugin.json', 'package.json', 'README.md',
+  ];
+  const dirsToCopy = ['lib', 'src', 'public'];
+
+  if (!fs.existsSync(targetDir)) {
+    fs.mkdirSync(targetDir, { recursive: true });
+  }
+
+  for (const file of filesToCopy) {
+    const src = path.join(sourceDir, file);
+    const dest = path.join(targetDir, file);
+    if (fs.existsSync(src)) {
+      fs.copyFileSync(src, dest);
+    }
+  }
+
+  for (const dir of dirsToCopy) {
+    const src = path.join(sourceDir, dir);
+    const dest = path.join(targetDir, dir);
+    if (fs.existsSync(src)) {
+      if (fs.existsSync(dest)) {
+        fs.rmSync(dest, { recursive: true, force: true });
+      }
+      copyDirRecursive(src, dest);
+    }
+  }
+
+  const skillMd = SKILL_MD_TEMPLATE.replace('{VERSION}', version);
+  fs.writeFileSync(path.join(targetDir, 'SKILL.md'), skillMd, 'utf8');
+}
+
+// ── Install to OpenClaw ────────────────────────────────────────────
+function installToOpenClaw() {
+  const PLUGIN_ID = 'aicq-chat';
+  const sourceDir = path.resolve(__dirname);
+  let version = '3.0.0';
+
+  try {
+    const pkg = JSON.parse(fs.readFileSync(path.join(sourceDir, 'package.json'), 'utf8'));
+    version = pkg.version;
+  } catch (e) {}
+
+  let skillsInstalled = false;
+  const workspace = findOpenClawWorkspace();
+  if (workspace) {
+    const skillsDir = path.join(workspace, 'skills');
+    const skillTargetDir = path.join(skillsDir, PLUGIN_ID);
+    console.log(`[AICQ] Found workspace at: ${workspace}`);
+    console.log(`[AICQ] Installing skill to ${skillTargetDir}...`);
+
+    if (!fs.existsSync(skillsDir)) {
+      fs.mkdirSync(skillsDir, { recursive: true });
+    }
+
+    installToDir(sourceDir, skillTargetDir, version);
+
+    console.log('[AICQ] Installing skill dependencies...');
+    try {
+      execSync('npm install --omit=dev', {
+        cwd: skillTargetDir,
+        stdio: 'pipe',
+        timeout: 120000,
+      });
+      console.log('[AICQ] Skill dependencies installed.');
+    } catch (e) {
+      console.log('[AICQ] Warning: npm install failed. You may need to run manually:');
+      console.log(`  cd ${skillTargetDir} && npm install`);
+    }
+
+    console.log(`[AICQ] Skill installed to: ${skillTargetDir}`);
+    skillsInstalled = true;
+  }
+
+  let pluginInstalled = false;
+  const openclawDir = findOpenClawDir();
+  if (openclawDir) {
+    const pluginsDir = path.join(openclawDir, 'plugins');
+    const pluginTargetDir = path.join(pluginsDir, PLUGIN_ID);
+
+    console.log(`[AICQ] Found OpenClaw at: ${openclawDir}`);
+    console.log(`[AICQ] Installing plugin to ${pluginTargetDir}...`);
+
+    if (!fs.existsSync(pluginsDir)) {
+      fs.mkdirSync(pluginsDir, { recursive: true });
+    }
+
+    installToDir(sourceDir, pluginTargetDir, version);
+
+    console.log('[AICQ] Installing plugin dependencies...');
+    try {
+      execSync('npm install --omit=dev', {
+        cwd: pluginTargetDir,
+        stdio: 'pipe',
+        timeout: 120000,
+      });
+      console.log('[AICQ] Plugin dependencies installed.');
+    } catch (e) {
+      console.log('[AICQ] Warning: npm install failed. You may need to run manually:');
+      console.log(`  cd ${pluginTargetDir} && npm install`);
+    }
+
+    console.log(`[AICQ] Plugin installed to: ${pluginTargetDir}`);
+    pluginInstalled = true;
+  }
+
+  if (!skillsInstalled && !pluginInstalled) {
+    console.log('[AICQ] OpenClaw not found, skipping auto-install.');
+    console.log('[AICQ] Set OPENCLAW_HOME or OPENCLAW_WORKSPACE environment variable.');
+    return false;
+  }
+
+  console.log('[AICQ] Restart OpenClaw to activate the plugin (Channel mode).');
+  return true;
+}
+
+// ── Uninstall from OpenClaw ─────────────────────────────────────────
+function uninstallFromOpenClaw() {
+  const PLUGIN_ID = 'aicq-chat';
+  let removed = false;
+
+  const workspace = findOpenClawWorkspace();
+  if (workspace) {
+    const skillDir = path.join(workspace, 'skills', PLUGIN_ID);
+    if (fs.existsSync(skillDir)) {
+      console.log(`[AICQ] Removing skill from ${skillDir}...`);
+      fs.rmSync(skillDir, { recursive: true, force: true });
+      removed = true;
+    }
+  }
+
+  const openclawDir = findOpenClawDir();
+  if (openclawDir) {
+    const pluginDir = path.join(openclawDir, 'plugins', PLUGIN_ID);
+    if (fs.existsSync(pluginDir)) {
+      console.log(`[AICQ] Removing plugin from ${pluginDir}...`);
+      fs.rmSync(pluginDir, { recursive: true, force: true });
+      removed = true;
+    }
+  }
+
+  if (!removed) {
+    console.log('[AICQ] AICQ plugin not found in any OpenClaw directory.');
+  } else {
+    console.log('[AICQ] Restart OpenClaw to complete the uninstall.');
+  }
+  return removed;
+}
+
+// ── Help ────────────────────────────────────────────────────────────
+if (command === '--help' || command === '-h') {
+  console.log(`
+AICQ Chat Plugin v3.7 — End-to-End Encrypted Chat for OpenClaw (Channel SDK)
+
+Usage:
+  openclaw plugins install aicq-openclaw   Install plugin via openclaw CLI
+  openclaw plugins uninstall aicq-chat            Uninstall old version
+  openclaw gateway restart                        Restart gateway after install
+  aicq-plugin [command] [options]                 Advanced usage
+
+Commands:
+  start       Install to OpenClaw (if needed) (default)
+  install     Install plugin to OpenClaw only
+  uninstall   Remove plugin from OpenClaw (skills/ and plugins/)
+  status      Check if the plugin is running
+
+Options:
+  --server, -s <url>      AICQ server URL (default: https://aicq.me)
+  --help, -h              Show this help message
+
+Environment Variables:
+  AICQ_SERVER_URL         AICQ server URL
+  AICQ_DATA_DIR           Data directory (default: ~/.aicq-plugin)
+  OPENCLAW_HOME           OpenClaw installation directory (for plugins/)
+  OPENCLAW_WORKSPACE      OpenClaw workspace directory (for skills/)
+
+Architecture:
+  v3.7 uses official Channel Plugin SDK (defineChannelPluginEntry).
+  Runs in-process with OpenClaw — no standalone server needed.
+  UI served via Gateway HTTP routes.
+  - UI: /plugins/aicq-chat/ui/
+  - API: /plugins/aicq-chat/api/*
+`);
+  process.exit(0);
+}
+
+// ── Status ──────────────────────────────────────────────────────────
+if (command === 'status') {
+  console.log('AICQ Plugin v3.7 (Channel SDK architecture)');
+  console.log('Uses defineChannelPluginEntry — runs in-process with OpenClaw.');
+  console.log('Check OpenClaw gateway status for plugin health.');
+  process.exit(0);
+}
+
+// ── Install only ────────────────────────────────────────────────────
+if (command === 'install') {
+  installToOpenClaw();
+  process.exit(0);
+}
+
+// ── Uninstall ───────────────────────────────────────────────────────
+if (command === 'uninstall' || command === 'remove') {
+  uninstallFromOpenClaw();
+  process.exit(0);
+}
+
+// ── Start (default) — auto-install then inform user ───────────────
+installToOpenClaw();
+
+console.log('');
+console.log('[AICQ] Channel Plugin uses OpenClaw Channel SDK (defineChannelPluginEntry).');
+console.log('[AICQ] It runs in-process with OpenClaw — no standalone server needed.');
+console.log('[AICQ] To activate:');
+console.log('  openclaw plugins install aicq-openclaw');
+console.log('  openclaw gateway restart');
+console.log('');
+console.log(`[AICQ] Server: ${serverUrl}`);
+console.log('[AICQ] UI: /plugins/aicq-chat/ui/');
+console.log('[AICQ] API: /plugins/aicq-chat/api/*');