equip (Charles Mulic)

装备

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

Discord 的中文翻译是“不和谐”或“纷争”。 · 增补作者指南

它做什么

你想给你的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，而不是发布当前包。

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

增强功能如何工作

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

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

支持的平台

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

CLI命令

选项： --verbose, --dry-run, --api-key-file , --api-key , --platform , --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

（建议用于CI和外壳安全），或 --api-key ` 当您接受shell历史记录/进程列表公开时

• OAuth --具有自动令牌刷新功能的浏览器PKCE流
• OAuth+密钥交换 -浏览器流到提供商颁发的API密钥
• OIDC授权 --根据增强定义注入短期委托访问令牌的令牌交换

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

文档

状态管理

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

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

许可证

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