AI导哈

AI代理增强工具

Equip是一个为AI代理提供增强包的工具，包含MCP服务器、行为规则和代理技能，支持跨平台部署。

  • by CharlesMulic
  • JavaScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 CharlesMulic/equip

使用说明

装备

为您的AI代理配备增强功能——MCP服务器、行为规则和跨平台工作的代理技能包。

不和 · 增补作者指南

它的作用

你想给你的AI编码代理添加一个功能——一个知识库、一个文档提取器、一个代码格式化器。它应该适用于Claude Code、Cursor、VS Code、Windsurf和其他所有平台。每个平台都有自己的配置格式、文件路径和怪癖。

Equip处理所有这些。一个命令，每个平台。

equip prior           # Installs MCP server + rules + skills on all detected platforms

安装

npm install -g @cg3/equip

或者在不安装的情况下使用：

npx @cg3/equip prior

快速开始

equip prior                    # Install an augment
equip status                   # See what's installed across all platforms
equip doctor                   # Validate config integrity + credential health
equip update prior             # Re-fetch and re-install latest version
equip refresh                  # Refresh expired OAuth tokens
equip reauth prior             # Re-authenticate and rotate credentials
equip snapshot-diff claude-code # Preview exactly what restore would change
equip restore claude-code      # Restore a platform to its pre-equip state
unequip prior                  # Remove an augment

发展与CI

npm test                       # Unit + integration coverage on the host
npm run test:docker:acceptance # Hermetic Docker acceptance for fake Claude/Codex homes
npm pack --dry-run             # Inspect the exact npm payload before release

Docker的接受通道故意狭窄：它启动一个干净的Node容器，为本地夹具注册表提供服务，将直接模式增强安装到伪造的Claude Code和Codex家庭中，并验证编写的MCP配置、规则、技能和 ~/.equip 国家。这是CLI级安装流的正确位置，它应该保持密封和CI友好，而不依赖于实时注册表数据。

释放模型

稳定的npm版本现在使用Changesets和专用的GitHub Actions发布工作流。

贡献者工作流程：

npm run changeset

维护人员工作流程：

  • 将变更集合并到 main
  • 让发布工作流打开或更新 Version packages 公关
  • 合并该PR以发布 @cg3/equip

对于PR创建步骤，启用 Settings -> Actions -> General -> Workflow permissions -> Allow GitHub Actions to create and approve pull requests，或设置a RELEASE_GITHUB_TOKEN 工作流使用的存储库秘密。

承诺 package.json 版本在 main 是规范发布版本。标签和GitHub发布是该流的输出，而不是决定版本的机制。

当 package.json 对于未发布的版本，已经领先于npm，应该没有待定的版本 .changeset/*.md 同一发布行的文件。否则，工作流将准备下一个版本PR，而不是发布当前包。

看 发布管理 以获得完整的发布和出版合同。

增强功能如何工作

增强是一个由最多四层组成的包，可以增强你的代理：

图层 功能 覆盖范围
MCP服务器 制造能力 可用的 --代理可以调用它们 所有平台
行为规则 教导代理人 何时以及如何 使用它们 大多数平台
代理技能 给予 详细知识 按需加载 大多数平台
生命周期挂钩 结构上强制执行 关键时刻的行为 克劳德代码

每一层都弥补了前一层的局限性。它们共同为您的代理提供了最佳的覆盖范围。

支持平台

平台 MCP 规则 技能 钩子
克劳德代码 是 是 有 有
光标 是 -- 是 --
VS代码/副本 是 -- 是 --
风帆 是 是 有 -
Cline 是 是 对 -
Roo代码 是 是 有 -
食品法典 是 是 有 --
Gemini CLI 是 是 有 --
朱尼 是的 -- -- --
副驾驶（JetBrains） 是 -- -- --
副驾驶CLI 是 -- -- --
亚马逊Q 是 -- -- --
选项卡 是 是 -- --

看 平台 有关配置路径、检测和每个平台的详细信息。

CLI命令

命令 描述
equip <augment> 从注册表安装增强
equip status 已安装增强模块的跨平台库存
equip doctor 验证配置完整性和凭据运行状况
equip update <augment> 重新获取定义并重新安装
equip refresh [augment] 刷新过期的OAuth令牌
equip reauth <augment> 重新验证和更新凭据
equip uninstall <augment> 删除增强（别名： unequip)
equip snapshot [platform] 捕获当前平台配置状态
equip snapshots [platform] 列出可用的配置快照
equip snapshot-diff <platform> 打印快照还原的JSON预览
equip restore <platform> 将平台配置还原到以前的快照
equip ./script.js 运行本地安装脚本（用于开发）

选项： --verbose, --dry-run, --api-key-file <path>, --api-key <key>, --platform <name>, --accept-risk, --non-interactive, --delete-added, --preserve-added, --json

看 CLI参考 了解详情。

对于增强作者

装备通过分配你的增强 注册表服务定义您的MCP服务器URL、身份验证要求、规则和技能——装备处理跨所有平台的平台检测、配置转换、凭据管理和安装。

对于当地发展：

equip ./my-augment.js          # Test locally on all detected platforms
equip .                        # Run current directory's package

请参阅 增补作者指南 完整的演练。

认证

Equip处理需要它的增强的身份验证：

  • API密钥 --提示， --api-key-file <path> （建议用于CI和外壳安全），或 --api-key <key> 当您接受shell历史记录/进程列表公开时
  • OAuth --具有自动令牌刷新功能的浏览器PKCE流
  • OAuth+密钥交换 -浏览器流到提供商颁发的API密钥
  • OIDC授权 --根据增强定义注入短期委托访问令牌的令牌交换

凭据安全存储在 ~/.equip/credentials/。过期的令牌在每次装备命令时都会自动刷新。

文档

指南 说明
增补作者指南 构建和发布增强
平台 支持的平台、功能、配置路径
快照 配置还原点、JSON还原差异和还原安全策略
MCP服务器 配置格式转换，API参考
行为规则 基于标记的版本化指令
代理技能 SKILL.md格式，跨平台分发
生命周期挂钩 事件驱动的执行脚本
CLI参考 命令、状态、选项
发布管理 变更集、CI发布流、npm认证

状态管理

Equip追踪一切 ~/.equip/:

  • storage/intents.jsonl --仅附加安装/更新/卸载日志
  • storage/content/ --用于注册表定义和本地编辑的不可变内容blob
  • cache/registries/ --注册表范围的HTTP缓存用于脱机回退
  • platforms.json --检测到具有功能和启用/禁用首选项的平台
  • platforms/ --每个平台的扫描结果（所有MCP服务器，托管和非托管）
  • credentials/ --每次增强存储的身份验证凭据
  • snapshots/ --用于回滚的平台配置快照（自动捕获初始状态）
  • equip.json --遥测和本地配置元数据等首选项

安装和本地脚本流在写入后通过扫描平台配置文件来协调来自磁盘的状态。 equip status 直接读取当前的平台配置文件，并在修改之前捕获初始快照，以便您可以恢复到装备前的状态。

设计原则

  • 零运行时依赖关系 --安装速度快，无供应链风险
  • 注册服务作为真相的来源 --扩充定义 api.cg3.io/equip
  • 单进程安装 --没有用于直接模式增强的辅助npm/npx
  • 原子文件写入 --碰撞安全配置修改
  • 结构化可观测性 --每次安装都会返回带有错误代码和警告的键入结果
  • 凭证生命周期 --自动存储、验证、刷新和旋转

经纪人模式边界

独立 equip CLI以直接模式安装增强。它编写平台MCP配置、规则、技能、凭据和本地状态，但不启动、停止、监视或操作代理运行时。

npm包还为发布自己的代理守护进程的主机应用程序提供了代理感知平台配置帮助程序。这些助手只编写指向主机提供的网桥二进制文件的平台配置条目，并为状态/医生/对账保留代理管理的状态。宿主应用程序拥有代理进程、凭据刷新、MCP代理、运行时健康状况以及围绕该生命周期的任何UI。

遥测

Equip发送保护隐私的安装指标（增强名称、平台、操作系统、架构、节点版本、设备版本和生成的安装ID），以帮助改进设备。 不包括凭据、文件路径或用户编写的内容。

默认情况下，遥测处于打开状态。要禁用，请编辑 ~/.equip/equip.json 并设置 preferences.telemetry 到 false.

许可证

FSL-1.1-ALv2-- 股份有限公司CG3。

相关 MCP