mohamed-ashraf-elsaed/claude-kit

GitHub: mohamed-ashraf-elsaed/claude-kit

一条命令为 Laravel 项目配置 Claude Code 等 AI 编程 agent 的工程规则与质量门禁的脚手架工具。

Stars: 3 | Forks: 0

claude-kit — one command sets up Claude Code and a quality gate for Laravel

claude-kit

只需一条命令,即可在 Laravel 项目中配置好 Claude Code —— 以及任何 AI 编程 agent。
包含工程规则、质量门禁 (PHPStan · Pint · Pest)、技能、功能文档脚手架,以及感知技术栈的前端工具。

Latest version Tests Lint PHP version Downloads License

`claude-kit` 打包了一套经过实战检验的配置,让每个 Laravel 项目 —— 以及每位 开发者 —— 都能获得相同的安全护栏,而无需在不同的 代码库之间手动复制配置:包含一个 Stop hook + pre-commit **质量门禁**、可复用的 Claude Code **技能**、 PHPStan level 7 + strict-rules、Pint、带有 80% 覆盖率门禁的 Pest、 架构测试套件、功能文档脚手架,以及**感知技术栈的前端** 工具 (Vue、React、Blade 或无)。 ### 适用人群 - 希望 **Claude Code**、**Cursor** 或 **GitHub Copilot** 在 **Laravel** 代码库中高效工作,并要求保持一致且强制执行规范的团队。 - 任何希望通过**一条命令**搞定 PHPStan + Pint + Pest + git hooks,而不是手动配置的人。 - 需要 AI 编程 agent 无法绕过的 **AI 编程护栏**的项目 —— 在提交时、每个 Claude 回合结束时以及在 CI 中都运行相同的门禁。 ## 目录 - [环境要求](#requirements) - [安装](#installation) - [安装内容](#what-it-installs) - [选择安装内容](#choosing-what-to-install) - [混合更新模型](#the-hybrid-update-model) - [质量门禁](#the-quality-gate) - [文档](#documentation) - [贡献](#contributing) - [安全](#security) - [许可证](#license) ## 环境要求 - PHP **8.2+** - Laravel **11, 12, 或 13** - [Claude Code](https://claude.com/claude-code) (用于使用规则、hooks 和技能) - 一个覆盖率驱动 (`pcov` 或 Xdebug) 以强制执行 80% 覆盖率门禁 ## 安装 ``` composer require --dev mohamed-ashraf-elsaed/claude-kit php artisan claude-kit:install ``` 安装程序会检测你的前端技术栈 (Inertia + Vue、Inertia + React、 Blade/Livewire 或纯 API),询问需要脚手架生成哪些部分,并将它们写入到 你的项目中。然后: ``` composer install # installs the dev tooling and wires the git pre-commit hook npm install # only if a frontend stack was set up ``` 还没有发布到 Packagist?只需将以下内容添加到 你的 `composer.json` 中并运行 `composer require --dev mohamed-ashraf-elsaed/claude-kit:dev-main`,即可直接从 GitHub 安装: ``` { "repositories": [ { "type": "vcs", "url": "https://github.com/mohamed-ashraf-elsaed/claude-kit" } ] } ``` ## 安装内容 | 部分 | 你的项目中会生成什么 | | --- | --- | | **.claude 核心** | `.claude/settings.json` (Stop hook 绑定 + 权限白名单)、针对你技术栈的可复用技能,以及 `.mcp.json` (Laravel Boost)。 | | **CLAUDE.md** | 通用工程规则 (架构层、强类型、代码规范、测试),其中包含用于你的产品/集成/部署的 `TODO` 占位符。 | | **质量门禁** | `phpstan.neon` (level 7 + 通过内置基座的 strict-rules)、`pint.json`、`tests/Arch/ArchTest.php`、`.githooks/pre-commit`,以及合并后的 composer scripts。 | | **前端** | 匹配技术栈的 `eslint.config.js` / `.prettierrc` / `tsconfig.json`,以及合并后的 `package.json` 脚本和 devDependencies。纯 API 项目将跳过此项。 | | **文档** | `features/_TEMPLATE/` + `features/README.md`、`.editorconfig`、`.gitattributes`。 | | **CI** | 通用的 GitHub Actions `tests.yml` 和 `lint.yml`。 | 原有的文件绝不会被覆盖 —— 除非你传递了 `--force`,否则安装程序会跳过它们。`composer.json` 和 `package.json` 会被合并执行,并保留你原有的配置项。 ## 选择安装内容 `claude-kit:install` 是一个**完全交互式的配置器** —— 它会询问你 需要什么,而不是自行假设: - **代码风格:** 开启/关闭 Pint - **静态分析:** 开启/关闭 PHPStan → 级别 (0–9) → 开启/关闭 strict-rules - **测试:** 开启/关闭 → 运行器 (Pest / PHPUnit) → 最低覆盖率 → 架构测试 - **Hooks:** Claude Stop hook、git pre-commit hook、功能文档要求 - **技能:** 要安装哪些内置技能 —— 还可以通过 [skills.sh](https://www.skills.sh) (`npx skills find` / `add`) 选择搜索并安装更多 - **额外内容:** CLAUDE.md 规则、功能文档模板、`.editorconfig`、MCP、CI 你的回答会被记录在 `.claude-kit.json` 中,质量门禁会读取该文件。 ``` php artisan claude-kit:install # interactive (recommended) php artisan claude-kit:install --stack=inertia-react # preselect the stack php artisan claude-kit:install --no-interaction # accept sensible defaults php artisan claude-kit:install --force # overwrite existing files ``` - **技术栈:** `inertia-vue`、`inertia-react`、`blade`、`none` ## 混合更新模型 - **核心机制** —— `quality-checks.sh` 和 Stop hook —— 位于 `vendor/mohamed-ashraf-elsaed/claude-kit/runtime/` 并且属于*引用*模式,因此 `composer update` 会自动将修复推送到每个项目。 - **你拥有的内容** —— `CLAUDE.md`、技能、功能模板、 linter 配置以及生成的 `phpstan.neon` —— 会被写入到你的代码库中,因此 你可以自由地进行定制。 ## 质量门禁 `vendor/mohamed-ashraf-elsaed/claude-kit/runtime/quality-checks.sh` 是唯一的 真理来源。它会运行 Pint、PHPStan (level 7 + strict-rules) 和 Pest (+80% 覆盖率),然后运行你的 `package.json` 中实际定义的 前端检查。 相同的脚本支撑着 git pre-commit hook、Claude 的 Stop hook 和 CI — 因此 各处的门禁是完全一致的。 - 覆盖率检查需要 `pcov` 或 Xdebug 扩展;如果没有它们,门禁只会发出警告, 而不会仅仅因为覆盖率问题阻断运行。 - 可以通过设置 `CLAUDE_KIT_FEATURE_DOCS=0` 来禁用功能文档要求。 ## 文档 完整指南位于[wiki](https://github.com/mohamed-ashraf-elsaed/claude-kit/wiki) 和 [`docs/`](docs/) 目录中: - [安装](docs/Installation.md) - [用法](docs/Usage.md) - [配置](docs/Configuration.md) - [前端技术栈](docs/Frontend-Stacks.md) - [质量门禁](docs/Quality-Gate.md) - [技能](docs/Skills.md) - [架构](docs/Architecture.md) - [发布到 Packagist](docs/Publishing.md) - [升级](docs/Upgrading.md) - [常见问题](docs/FAQ.md) ## 安全 请私下报告漏洞 —— 参见 [SECURITY.md](SECURITY.md)。 ## 许可证 MIT 许可证。参见 [LICENSE](LICENSE)。
标签:AI编程助手, ffuf, Laravel, OpenVAS, PHP, SOC Prime, 开发工具, 自动化配置