@ codaput/ 守护
AI协助发展的建筑护栏
Codapult Guard帮助团队维护随着项目变化而使其工程发挥作用的架构. 它绘制一个 JavaScript 或 TypeScript 代码库,让团队批准项目特定边界,以及 检查本地和CI中的未来变化。 AI代理可以使用相同的项目背景和核查 结果作为开发者.
抓住具体项目的回归
一个类型检查器可以确认代码是有效的类型脚本. 它不知道这个项目需要.. 客户端组件,以远离持久性模块。 一旦队伍批准边界, Guard 可以在已更改文件中检测到违反规则的导入, 并显示触发的规则 .
Project boundary: Client → Server Action → Service → Repository → Database
Possible regression: Client ─────────────────────────────────────→ Database
Guard 发现寄存器中的架构; 它没有规定一个通用结构 或未经批准启动拟议规则.
开始吧
要求:节点.js >=20.19 和一个 JavaScript 或 TypeScript 项目.
# pnpm
pnpm add -D @codapult/guard
pnpm exec codapult-guard init
# npm
npm install --save-dev @codapult/guard
npx codapult-guard init
审查所产生的项目模型、拟议规则、合同和基准
.codapult/guard/ 在依靠结果之前。 然后运行警卫的建筑检查:
pnpm exec codapult-guard verify --no-project-checks --tools off
verify 可以运行您配置的项目检查和检测到的适配器。 上面的旗帜限制了这一点
跑到警卫的内置检查。 与npm,运行 npx codapult-guard verify --no-project-checks --tools off。 。 。 .
见 完整指南 用于初始化和日常工作流程.
使用 AI 代理服务器的 Guard
为您的代理安装一个管理指令块, 以便它知道何时装入 Guard 上下文并运行 核查:
pnpm exec codapult-guard install-agent codex
支持的主机和 MCP 设置在 AI-代理整合指南 财务报告和审定财务报表 主机集成指南。 。 。 .
MCP 服务器使用主机管理的本地 stdio, 没有网络收听器或应用程序级别 认证。 主机和操作系统控制程序访问和工作空间权限; 见 安保模式。 。 。 .
选择 GitHub 设置
从现有工作流程模板中选择一个预设,并只遵循此的托管步骤 保护级别。 大多数项目都可以从标准的PR检查开始.
| 预设 | 用它当 | 指南 |
|---|---|---|
| 公关检查 | 你需要警备队的发现和对普通拉力请求的检查. | GitHub 公关检查 |
| 信任的公关核查 | 护卫检查必须来自受保护的工作流程来源,包括叉子公关. | 信任的 PR 设置 |
| 合并队列 | 您的仓库通过 GitHub 合并队列合并 . | 合并队列设置 |
如果你不确定,请使用 公关检查 先说 这是有用的CI反馈,但是它的工作流程存在于 正在检查项目,可以通过拉动请求更改。 选择信任的校验 检查本身必须避免这种变化.
卫兵做什么
- 学习具体项目的结构、依赖性、界限和现有结论.
- 检查批准的建筑规则和合同,而不强加通用建筑.
- 显示更改影响, 并为 AI 审核准备有限制, 有编辑的上下文 .
- 启用时运行已配置的项目检查和适配器; 它不会替换它们 .
- 制作确定性CLI、JSON和SARIF结果供当地使用和CI.
警卫是当地第一,不叫LLM。 AI主机拥有模型访问,编辑,及其修复 循环。 警卫辅助TypeScript、ESLint或Biome、测试、SAST和依赖扫描仪;它确实 不代替他们.
文档
- GitHub 设置预设 ——选择和配置您需要的 CI 级别 .
- 完整守护指南 ——指挥,政策,成果,安全,先进工作流程.
- AI-代理一体化 ——管理指令和MCP工作流程.
- 东道国一体化 —— Codex, Cursor, Claude Code, 副驾驶,双子座CLI,以及通用MCP客户端.
- 政策变异控制 批准和保护政策行为.
- 扩展 ——适配器,输出格式和集成边界.
捐助者
维护者检查和项目固定范围记录在 固定向导 财务报告和审定财务报表 发布指南。 。 。 .
更多来自科达普尔特
从头开始用SaaS? 科达普尔 是一个生产准备 Next.js SaaS 为AI辅助开发而建的基础,模块化建筑,内置AI,MCP上下文, 和您控制下的源代码.
许可证
麻省理工学院. 见 自由主义。 。 。 .