quicker-rpc

仓库：QuickerHub/quicker-rpc

本 monorepo 包含三件紧密相关的东西：

底层统一：命名管道 + StreamJsonRpc，CLI 作客户端连插件内的 IQuickerRpcService。

完整文档索引 → docs/README.md · 路线图 → docs/ROADMAP.md

选你的入口

QuickerAgent

专为 Quicker 打造的 AI 助手：内置动作编辑器与步骤知识库，描述用途即可搜索执行，复杂编排进主窗口，轻量操作走 Alt+Space 启动器。

• 下载：quicker-agent-win-x64-setup.exe（落地页源码：quicker-agent-web/）
• 前置：本机 Quicker + QuickerAgent 插件动作
• 产品介绍：docs/quicker-agent.md
• 本地开发：agent-gui/README.md（pwsh ./dev.ps1）

第三方 Agent（Cursor 等）若只需无头读写动作、不需 QuickerAgent UI，用下文 qkrpc + MCP 即可。

qkrpc CLI 与插件

安装 CLI

从 GitHub Releases 下载 qkrpc-win-x64-setup.exe，或便携包 qkrpc-win-x64.zip。

• 系统要求：Windows 10 1607（10.0.14393）Enterprise/LTSC 或 Windows Server 2016 及以上（与 .NET 10 支持的操作系统 一致）
• 安装目录：%LOCALAPPDATA%\Programs\qkrpc
• 安装后新开终端；工作区 .vscode/settings.json 可为集成终端追加 PATH
• 卸载：Windows「设置 → 应用」或安装目录 unins000.exe

# 可选：静默安装
Invoke-WebRequest -Uri 'https://github.com/QuickerHub/quicker-rpc/releases/latest/download/qkrpc-win-x64-setup.exe' -OutFile "$env:TEMP\qkrpc-setup.exe" -UseBasicParsing
Start-Process -FilePath "$env:TEMP\qkrpc-setup.exe" -ArgumentList '/VERYSILENT' -Wait

加载 Quicker 插件

将 publish/plugin 下 DLL 放到动作的 {packagePath}，在 Quicker 子程序注册区：

load {packagePath}/QuickerRpc.Plugin.{version}.dll
type QuickerRpc.Plugin.Launcher, QuickerRpc.Plugin.{version}

子程序 QuickerRpc_Run 入口：Launcher.StartFromQuickerInParam(quicker_in_param, _context)。

验证

Quicker 已运行且插件已加载：

qkrpc help --json
# 可选：qkrpc serve → GET http://127.0.0.1:9477/health

CLI 退出码 0 成功、1 失败；脚本与 Agent 推荐始终加 --json。

第三方 Agent 一键接入

qkrpc agent setup              # 默认 Cursor 用户级 MCP + skills
qkrpc agent setup --upgrade    # CLI 升级后刷新 skills/rules
qkrpc agent setup --all        # 多宿主 MCP
qkrpc agent setup --project    # 额外写入项目配置（团队 opt-in）

说明：docs/agent-mcp-integration.md · Skills：docs/agent-skill-distribution.md

常用命令

完整表：docs/cli-commands.md · 机器可读：qkrpc help --json

# 写动作指南（先读 overview → authoring-workflow）
qkrpc guide get --topic overview --json

# 搜索 / 读取 / 创建 / 编辑
qkrpc action list --query "keyword" --json
qkrpc action get --id <guid> --return-mode full --json
qkrpc action create --title "My Action" --json
qkrpc action patch --id <guid> --patch-file patch.json --expected-edit-version <N> --json

# 步骤模块、图标、子程序（写步骤前必查 schema）
qkrpc step-runner search --query "clipboard|text" --json
qkrpc step-runner get --key <stepRunnerKey> --json
qkrpc fa search --query "address book" --json
qkrpc subprogram search --query "keyword" --json

# 运行、设计器、发布共享动作
qkrpc action run --id <idOrName> --wait --json
qkrpc action update --id <sharedActionGuid> --changelog "说明" --json

大 JSON 可用 --patch-file - / --xaction-file - 从 stdin 传入。

架构

QuickerAgent / 脚本 / MCP Agent
        |
        v
   qkrpc.exe (CLI client)  --named pipe-->  QuickerRpc.Plugin (RPC server)
                                                    |
                                                    v
                                          Quicker UI thread / services

• 管道名：QuickerRpc_Server_QRPC2026（QuickerRpcPipeNames.ServerPipe）
• Quicker 内部对象访问由插件切回 UI 线程执行
• QuickerAgent 默认走 qkrpc serve（9477）；MCP 走 qkrpc mcp stdio

仓库结构

开发

需要 .NET 10 SDK（global.json）。Plugin 目标 net472（与 Quicker.exe 一致）。

dotnet build QuickerRpc.slnx

# 编译 CLI、重载 Quicker 插件、启动 qkrpc serve
pwsh ./build.ps1 -t

自定义 Quicker 路径：

dotnet build QuickerRpc.Plugin -p:QuickerDllPath="D:\path\to\Quicker\bin\x64\Debug\net472"

QuickerAgent 前端（Node 20+、pnpm）：pwsh ./dev.ps1 — 见 agent-gui/README.md、docs/dev-supervisor-design.md。改 UI 时不要跑 build.ps1 -t（HMR 即可）。

测试（需 Quicker + 已加载插件）：

dotnet test QuickerRpc.Test -c Release
dotnet test QuickerRpc.Test --filter FullyQualifiedName~QuickerRpcPipeIntegrationTests

Coding Agent 约定：AGENTS.md（根目录）；agent-gui/ 另有 agent-gui/AGENTS.md。

发布

维护者：更新 version.json、撰写 publish/changelogs/vX.Y.Z.md 后：

pwsh ./publish/Publish-GitHubRelease.ps1

或推送 v* tag，由 .github/workflows/release-cli.yml 构建 GitHub Release。

getquicker 正式包须递增 version.json 第三段（见 .cursor/skills/quicker-qkbuild-version-publish/）。

延伸阅读

• docs/README.md — 文档总索引
• docs/quicker-agent.md — QuickerAgent 产品说明
• docs/agent-mcp-integration.md — MCP 与第三方 Agent
• docs/cli-commands.md — CLI 命令表
• docs/quicker-action-data-storage.md — 动作数据存储
• docs/ROADMAP.md — 产品路线图
• GitHub Releases