# @codapult/guard 中文文档 规范地址：https://npmcn.com/package/%40codapult/guard/ 版本：0\.14\.1 npm 元数据更新时间：2026-11-10T06:16:16.999Z 中文译文更新时间：2026-11-10T06:35:46.759Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40codapult/guard 原文对照：https://npmcn.com/package/%40codapult/guard/?lang=original 项目主页：https://github.com/codapult/codapult-guard 源码仓库：https://github.com/codapult/codapult-guard ## 关键信息（来自 npm 元数据） - 包体积（解压后）：956 kB，87 个文件 - 模块格式：ES Module - TypeScript 类型：包内自带 - Node.js 要求：\>=20\.19\.0 - 运行依赖：8 个 - 首次发布：2026-09-18T07:11:05.072Z - 最新版本发布：2026-11-10T06:16:16.647Z - 近 30 天下载量：3143（2026-10-10 至 2026-11-08，npm 官方下载统计） - 已发布版本数：21（近 12 个月 21 个） ## 中文简介 JavaScript 和 TypeScript 工程的本地第一架构护栏,其一等支持Next.js SaaS 和 AI 协助开发 ## 安装 ```sh npm install @codapult/guard ``` 也可以使用：`pnpm add @codapult/guard`、`yarn add @codapult/guard`、`bun add @codapult/guard` ## README # @ codaput/ 守护 [![CI](https://github.com/codapult/codapult-guard/actions/workflows/ci.yml/badge.svg)](https://github.com/codapult/codapult-guard/actions/workflows/ci.yml) [![Fixtures](https://github.com/codapult/codapult-guard/actions/workflows/guard-fixtures.yml/badge.svg)](https://github.com/codapult/codapult-guard/actions/workflows/guard-fixtures.yml) [![npm](https://img.shields.io/npm/v/@codapult/guard?logo=npm)](https://www.npmjs.com/package/@codapult/guard) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://npmcn.com/package/%40codapult/guard/LICENSE) [![Node.js >=20.19](https://img.shields.io/badge/node-%3E%3D20.19-339933.svg?logo=node.js&logoColor=white)](https://npmcn.com/package/%40codapult/guard/package.json) [![TypeScript](https://img.shields.io/badge/TypeScript-first-3178C6.svg?logo=typescript&logoColor=white)](https://www.typescriptlang.org/) [![MCP Registry](https://img.shields.io/badge/MCP_Registry-Listed-4B6A88?style=flat-square)](https://registry.modelcontextprotocol.io/?q=io.github.codapult%2Fguard) [![MCPSafe](https://api.mcpsafe.io/badge/github/codapult/codapult-guard.svg)](https://mcpsafe.io/registry/github/codapult/codapult-guard) [![codapult-guard MCP server – quality and maintenance score on Glama](https://glama.ai/mcp/servers/codapult/codapult-guard/badges/score.svg)](https://glama.ai/mcp/servers/codapult/codapult-guard) ## AI协助发展的建筑护栏 Codapult Guard帮助团队维护随着项目变化而使其工程发挥作用的架构. 它绘制一个 JavaScript 或 TypeScript 代码库,让团队批准项目特定边界,以及 检查本地和CI中的未来变化。 AI代理可以使用相同的项目背景和核查 结果作为开发者. ### 抓住具体项目的回归 一个类型检查器可以确认代码是有效的类型脚本. 它不知道这个项目需要.. 客户端组件,以远离持久性模块。 一旦队伍批准边界, Guard 可以在已更改文件中检测到违反规则的导入, 并显示触发的规则 . ```text Project boundary: Client → Server Action → Service → Repository → Database Possible regression: Client ─────────────────────────────────────→ Database ``` Guard 发现寄存器中的架构; 它没有规定一个通用结构 或未经批准启动拟议规则. ## 开始吧 要求:节点.js `>=20.19` 和一个 JavaScript 或 TypeScript 项目. ```bash # pnpm pnpm add -D @codapult/guard pnpm exec codapult-guard init # npm npm install --save-dev @codapult/guard npx codapult-guard init ``` 审查所产生的项目模型、拟议规则、合同和基准 `.codapult/guard/` 在依靠结果之前。 然后运行警卫的建筑检查: ```bash pnpm exec codapult-guard verify --no-project-checks --tools off ``` `verify` 可以运行您配置的项目检查和检测到的适配器。 上面的旗帜限制了这一点 跑到警卫的内置检查。 与npm,运行 `npx codapult-guard verify --no-project-checks --tools off`。 。 。 . 见 [完整指南](https://npmcn.com/package/%40codapult/guard/docs/guard.md#install-and-initialize) 用于初始化和日常工作流程. ## 使用 AI 代理服务器的 Guard 为您的代理安装一个管理指令块, 以便它知道何时装入 Guard 上下文并运行 核查: ```bash pnpm exec codapult-guard install-agent codex ``` 支持的主机和 MCP 设置在 [AI-代理整合指南](https://npmcn.com/package/%40codapult/guard/docs/guard-agent-integration.md) 财务报告和审定财务报表 [主机集成指南](https://npmcn.com/package/%40codapult/guard/docs/integrations/)。 。 。 . MCP 服务器使用主机管理的本地 stdio, 没有网络收听器或应用程序级别 认证。 主机和操作系统控制程序访问和工作空间权限; 见 [安保模式](https://npmcn.com/package/%40codapult/guard/docs/guard.md#security-and-authentication)。 。 。 . ## 选择 GitHub 设置 从现有工作流程模板中选择一个预设,并只遵循此的托管步骤 保护级别。 大多数项目都可以从标准的PR检查开始. | 预设 | 用它当 | 指南 | | --- | --- | --- | | **公关检查** | 你需要警备队的发现和对普通拉力请求的检查. | [GitHub 公关检查](https://npmcn.com/package/%40codapult/guard/docs/github-setup-presets.md#github-pr-checks) | | **信任的公关核查** | 护卫检查必须来自受保护的工作流程来源,包括叉子公关. | [信任的 PR 设置](https://npmcn.com/package/%40codapult/guard/docs/github-setup-presets.md#trusted-pr-verification) | | **合并队列** | 您的仓库通过 GitHub 合并队列合并 . | [合并队列设置](https://npmcn.com/package/%40codapult/guard/docs/github-setup-presets.md#merge-queue) | 如果你不确定,请使用 **公关检查** 先说 这是有用的CI反馈,但是它的工作流程存在于 正在检查项目,可以通过拉动请求更改。 选择信任的校验 检查本身必须避免这种变化. ## 卫兵做什么 - 学习具体项目的结构、依赖性、界限和现有结论. - 检查批准的建筑规则和合同,而不强加通用建筑. - 显示更改影响, 并为 AI 审核准备有限制, 有编辑的上下文 . - 启用时运行已配置的项目检查和适配器; 它不会替换它们 . - 制作确定性CLI、JSON和SARIF结果供当地使用和CI. 警卫是当地第一,不叫LLM。 AI主机拥有模型访问,编辑,及其修复 循环。 警卫辅助TypeScript、ESLint或Biome、测试、SAST和依赖扫描仪;它确实 不代替他们. ## 文档 - [GitHub 设置预设](https://npmcn.com/package/%40codapult/guard/docs/github-setup-presets.md) ——选择和配置您需要的 CI 级别 . - [完整守护指南](https://npmcn.com/package/%40codapult/guard/docs/guard.md) ——指挥,政策,成果,安全,先进工作流程. - [AI-代理一体化](https://npmcn.com/package/%40codapult/guard/docs/guard-agent-integration.md) ——管理指令和MCP工作流程. - [东道国一体化](https://npmcn.com/package/%40codapult/guard/docs/integrations/) —— Codex, Cursor, Claude Code, 副驾驶,双子座CLI,以及通用MCP客户端. - [政策变异控制](https://npmcn.com/package/%40codapult/guard/docs/policy-mutations.md) 批准和保护政策行为. - [扩展](https://npmcn.com/package/%40codapult/guard/docs/extensions.md) ——适配器,输出格式和集成边界. ## 捐助者 维护者检查和项目固定范围记录在 [固定向导](https://npmcn.com/package/%40codapult/guard/docs/guard-fixtures.md) 财务报告和审定财务报表 [发布指南](https://npmcn.com/package/%40codapult/guard/docs/releasing.md)。 。 。 . ## 更多来自科达普尔特 从头开始用SaaS? [科达普尔](https://codapult.dev/) 是一个生产准备 Next.js SaaS 为AI辅助开发而建的基础,模块化建筑,内置AI,MCP上下文, 和您控制下的源代码. ## 许可证 麻省理工学院. 见 [自由主义](https://npmcn.com/package/%40codapult/guard/LICENSE)。 。 。 . ## 常见问题 ### @codapult/guard 是什么？ JavaScript 和 TypeScript 工程的本地第一架构护栏,其一等支持Next\.js SaaS 和 AI 协助开发 ### 如何安装 @codapult/guard？ 在项目目录运行 npm install @codapult/guard，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 codapult-guard，可以用 npx codapult-guard 直接运行。 ### @codapult/guard 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @codapult/guard 支持 ESM 还是 CommonJS？ 以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。 ### @codapult/guard 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=20\.19\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @codapult/guard 可以商用吗？ @codapult/guard 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @codapult/guard 的下载量有多少？ 根据 npm 官方下载统计，@codapult/guard 在 2026/10/10 – 2026/11/08 这 30 天内被下载 3,143 次，日均约 105 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @codapult/guard 还在维护吗？ 最新版本 0\.14\.1 发布于 2026/11/10（今天）；至今共发布 21 个版本，其中过去 12 个月发布了 21 个；首次发布于 2026/09/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。