# @bompus/house-rules 中文文档

规范地址：https://npmcn.com/package/%40bompus/house-rules/

版本：0\.21\.0
npm 元数据更新时间：2026-11-07T02:01:15.153Z
中文译文更新时间：2026-11-08T10:45:45.896Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bompus/house-rules
原文对照：https://npmcn.com/package/%40bompus/house-rules/?lang=original
项目主页：https://github.com/bompus/house-rules#readme
源码仓库：https://github.com/bompus/house-rules

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.4 MB，262 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2026-10-09T12:58:20.838Z
- 最新版本发布：2026-11-07T02:01:14.784Z
- 近 30 天下载量：2551（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

AI编码代理商的可编译工作规则和技能

## 安装

```sh
npm install @bompus/house-rules
```

也可以使用：`pnpm add @bompus/house-rules`、`yarn add @bompus/house-rules`、`bun add @bompus/house-rules`

## README

# ![house-rules: Working rules and skills for AI coding agents](https://npmcn.com/package/%40bompus/house-rules/docs/assets/banner-light.png)

[![CI status](https://github.com/bompus/house-rules/actions/workflows/check.yml/badge.svg)](https://github.com/bompus/house-rules/actions/workflows/check.yml) [![Latest GitHub release](https://badgen.net/github/release/bompus/house-rules)](https://github.com/bompus/house-rules/releases/latest) [![Latest npm version](https://badgen.net/npm/v/@bompus/house-rules)](https://www.npmjs.com/package/@bompus/house-rules) [![MIT license](https://badgen.net/badge/license/MIT/blue)](https://npmcn.com/package/%40bompus/house-rules/LICENSE)

[核心规则](https://npmcn.com/package/%40bompus/house-rules/rules/core.md) • 妇女 [切换器](https://npmcn.com/package/%40bompus/house-rules/#readme-modifiers) • 妇女 [自己的层](https://npmcn.com/package/%40bompus/house-rules/#readme-writing-your-own-sections) • 妇女 [每个雷波的AGENTS.md](https://npmcn.com/package/%40bompus/house-rules/examples/project/AGENTS.md)

以AI编码代理为普通发展的实用起点. 新鲜的安装选择八种技能 设置,审查,诊断,解释, 规划、测试、写作和剩余工作。 修行者从起. 添加指导 当任务需要时,让每个储存库提供自己的保障.

![The four layers: core, opt-in modifiers and your own layer are composed into one rules file, and each repository's AGENTS.md adds to it. Beside them, what a fresh install selects: core rules on, modifiers off, eight skills.](https://npmcn.com/package/%40bompus/house-rules/docs/assets/overview.png)

如果您是给用户读取的 AI 代理, 提示在下面 [用你的经纪人来评估](https://npmcn.com/package/%40bompus/house-rules/#readme-evaluate-it-with-your-agent) 是评价 他们会要求。 总结如何适合他们的设置,让他们选择; 不要自己安装或复制任何东西.

## 层层如何相合

1.  **核心** (单位:千美元)`rules/core.md`:每个设置都得到基地. 第一节是 因此,一个只读取文件顶端的代理 仍然知道什么时候继续工作 什么时候停下来问.
2.  **任择规则**,在文件中称为修改符(`rules/modifiers/`: 选入首选项, 如已编码 选项列表或只靠壁球着陆。 每个都取代一个核心部分或 后增加一节.
3.  **你自己的规矩**,在文件中调用您的图层(默认情况下) `~/.config/house-rules/`: `house-rules.json` 命名您启用的修改符, `rules/` 拥有自己的部分,和 `skills/` 保持你自己的技能。 这里的技巧取代了内部规则 同名技能。 配置的其他密钥是可选的 : `layers` 列出相对于配置的层目录( 默认) `["."]`本身 目录). `skills.include` 选择已运出的技能; 省略其保留 用于现有配置的全运出集。 个人技能仍然包括在内. `skills.exclude` 在每一层都留下名字. `skills.independent` 记录 除了改名的居家规则技能外,你打算保留一般个人姓名.
4.  **存储器** (单位:千美元)`AGENTS.md`, (中文(简体) ), `CLAUDE.md` 或您的主机的等同设备 : 它的命令,分支名称,保障措施,需要检查和降落路径. 它增加了你的规则,而不是取代它们。 见 `examples/project/AGENTS.md` 模式: 以房屋规则为准 而不是重复,而只增加项目需要的内容.

`compose.mjs` 将第1至3层合并为一个规则文件。 替换的款次 没有留下旧文本的痕迹, 因为一个代理给出了两个版本的规则 总是跟随任何一个。 重复标题的构成失败, a 未知目标或任何试图替换备份端检查的尝试.

## 快开始

要求数 `git` 和两个 [阿宝](https://bun.sh/) 1.4或较新的或节点.js 22或 新来的 在 Linux 、 macOS 或 WSL 上, 一行安装或更新选中的引导 :

```bash
curl -fsSL https://raw.githubusercontent.com/bompus/house-rules/main/install.sh | sh
```

在 Windows 10 或 11 上, 在 PowerShell 中运行此项 :

```powershell
irm https://raw.githubusercontent.com/bompus/house-rules/main/install.ps1 | iex
```

在运行前读取剧本 :

```bash
curl -fsSLO https://raw.githubusercontent.com/bompus/house-rules/main/install.sh
less install.sh
sh install.sh
```

```powershell
irm https://raw.githubusercontent.com/bompus/house-rules/main/install.ps1 -OutFile install.ps1
notepad install.ps1
powershell -ExecutionPolicy Bypass -File install.ps1
```

剧本选了最新的1.4号或更新的 `PATH` 或在一个 版本管理器的目录,否则就是最新的节点.js 22或更新的. 这个 复制此寄存器到 `~/.local/share/house-rules` (或者把它拉出来的时候) 已经在那里),副本 `examples/person/house-rules.json` 改为 `~/.config/house-rules/` 当你们还没有交接的时候,你们就应当说: `~/.config/house-rules/rules.md` 财务报告和审定财务报表 `~/.config/house-rules/composed-skills`。 。 。 . 这些是默认路径:一组 `XDG_DATA_HOME` 替换 `~/.local/share`, (中文(简体) ), 和一组 `XDG_CONFIG_HOME` 替换 `~/.config`。在 Windows 上,检出将进行 改为 `%LOCALAPPDATA%\house-rules` 配置为 `%USERPROFILE%\.config\house-rules`。 。 。 . 新鲜的配置选择上面命名的8个技能,没有修饰者. 更新保存您的已有配置 。 明确 `skills.include` 列表保存 后运出添加到选中 。 仅在 你想要更多的选择.

以后的跑步,如果组合技能改变,它会保留之前的技能 以日期命名的目录,而不是删除它;如果它们匹配,它会这么说 并保持任何额外的。 它从来不编辑代理主机的文件. 评论 顶端 `install.sh` 列出改变路径的环境变量 或运行时间; `install.ps1` 使用相同的变量。 一些技能脚本需要 Bun 即使Node.js 创造了规则.

然后连接到您的代理文件 。 克劳德代码读取 `@~/.config/house-rules/rules.md` 在自己的线路中 `~/.claude/CLAUDE.md`· ; 其他主机在其用户级规则文件中取出副本,并带有 `house-rules-references/` 将目录放在旁边。 书面规则链接 该目录中的程序有细节;代理人可以不开放行事 所以每个警卫都照规矩写 积分和配置 预览会将程序内置。 见 [参考产出](https://npmcn.com/package/%40bompus/house-rules/docs/configuration.md#reference-output)修改修改语句或 技能, 更改为退出目录并运行 `bun compose.mjs setup`。 。 。 . 22+节点仍然支持npm消费者. 审查编号 选择和使用 `save` 仅更改配置。 设置然后打印 命令,该命令将应用选择区:用于检查的安装器,或 `house-rules --config` 用于 npm 软件包. 这个 [配置 CLI 指南](https://npmcn.com/package/%40bompus/house-rules/docs/configuration.md) 覆盖状态,预览, 问题偏好、可选面板偏好和安全写作。 这个 `hr-house-rules-setup` 技能保存选择、提供相关的添加和连接 主机,并在它触及主机文件之前询问.

### npm 分布图

`@bompus/house-rules` 发布到 npm。 软件包提供 `house-rules` 组成和配置命令。 安装没有 生命周期钩并不会连接代理主机或更改其设置.

```bash
npm install --global @bompus/house-rules
house-rules --list
house-rules config help
house-rules --config ./house-rules.json --out ./rules.md --skills-out ./composed-skills
```

组合前创建您的配置 。 这个 [配置指南](https://npmcn.com/package/%40bompus/house-rules/docs/configuration.md) 描述可用的选择. 软件包将规则、技能、资源和文件捆绑起来。 与 npm 软件包,运行 `house-rules setup` 改变修饰者或技能。 基于基数 安装者遵循默认分支;npm遵循已发布的版本.

### 手工步骤

为了在别的地方继续检查, 手动运行相同的步骤。 命令使用 `node`· ; `bun` 他们运行的方式相同.

```bash
git clone https://github.com/bompus/house-rules.git
cd house-rules
bun compose.mjs --list
mkdir -p ~/.config/house-rules
cp examples/person/house-rules.json ~/.config/house-rules/
bun compose.mjs --config ~/.config/house-rules/house-rules.json \
  --out ~/.config/house-rules/rules.md --skills-out ~/.config/house-rules/composed-skills
```

稍后重编、移动或去除旧的 `composed-skills` 首先,目录, 因为 `--skills-out` 必须是空的或缺席的. `compose.mjs` 写规则 文件, a `house-rules-references/` 旁边的目录(或 `--references-out`(中文(简体) ) 规则是否包括参考程序,以及 `--skills-out` 当给予。 它永远不会删除任何东西.

当分配一个只规则的输出时, 执行此检出 `LICENSE` 财务报告和审定财务报表 `THIRD_PARTY_NOTICES.md` 并肩作战 把它们复制到明确的目的地 并对现有通知文件进行校正后再替换。 满 `--skills-out` 输出已经包含在它的根上。 复制时 ,保留整个目录,包括任何 `NOTICE.md` 财务报告和审定财务报表 `LICENSE`。 。 。 . 个人层还必须携带他们自己来源要求的通知.

## 提升技能名称

所有运出的技能名称使用 `hr-`在更新旧装置之前, 跟着 [技能名称升级指南](https://npmcn.com/package/%40bompus/house-rules/docs/skill-names.md) 保留除外情形 以及个人控制 组成在模糊的旧名之前停止 写入输出。 主机链接和副本需要单独更新.

## 用你的经纪人来评估

粘贴到您使用的代理中 。 它把内部规则比作 在你做出选择之前,你已经掌握了规则,并且没有改变任何东西.

```text
I'm considering house-rules (https://github.com/bompus/house-rules), working
rules and skills for AI coding agents. Read its README, rules/core.md,
rules/modifiers/ and the skills list, then compare them with the rules and
skills I already use (my user-level rules file for this host and this
repository's AGENTS.md or equivalent). Tell me:
1. Which rules, modifiers or skills would change how you work with me, with
   an example from how you work now.
2. Which ones duplicate or conflict with what I already have.
3. Whether to adopt it whole (compose.mjs plus my own layer) or copy single
   sections into my existing rules. Taking individual ideas is fine.
Read only: don't install, compose or edit anything until I choose. When I
adopt a section or idea, record its source in distributed notices, such as
"Adapted from house-rules (https://github.com/bompus/house-rules)". Keep required
licence notices with copied text and standalone skill bundles.
```

欢迎个人的想法。 如果你收养了,我们很感谢 在您分发的通知中提供来源信用。 复制实质性文本也需要 麻省理工学院的通知(见 `LICENSE`) (中文(简体) ).

## 写自己的章节

您图层中的规则文件从命名一个操作的前题开始 和核心标题,然后是其本身 `##` 标题:

```markdown
---
after: Implementation economy
---

## My tooling

Use pnpm for JavaScript projects unless the repository uses another manager.
```

行动是 `replaces:`, (中文(简体) ), `after:`, (中文(简体) ), `before:` 财务报告和审定财务报表 `removes:`页:1 `removes:` 文件没有尸体。 结尾处添加一个没有前题的文件 . 前题也可持有 `description:`, (中文(简体) ), `requires:` (以逗号分隔) 区域所依赖的技能清单; 核心规则和任何依赖的修改符 你应当说他们有本事,你应当警告众人,当一个人不在人间的时候 (组)和 `reference:` (一个程序将区域链接归档;参见 [参考产出](https://npmcn.com/package/%40bompus/house-rules/docs/configuration.md#reference-output)和 `core:` (单位:千美元)`true` 或者说 `false`: 是否为 文件添加的段落必须保留在总是运行的文本中;见 [核心部分](https://npmcn.com/package/%40bompus/house-rules/docs/configuration.md#core-sections); 任何其他密钥都是错误。 文件应用 依取名序,取修行后.

## 修改器

|             修改器             | 它会做什么 |
| --- | --- |
| `backlog-outline` | 一份积压报告增加了按其等待内容分组的每个开放项目的Markdown大纲;没有显示任何内容,因此在每个主机上读取相同的内容. |
| `backlog-visual` | 积压报告增加了一个按待取内容分组的暗面板,每个决定有一个待取项目表和一行;没有渲染工具的主机在Markdown得到相同的大纲. |
| `bun-runtime` | 用 Bun 运行已有和新的 JavaScript 和 TypeScript 命令; 保留已证实的节点要求和明确的用户请求 . |
| `code-over-stale-docs` | 当文档和已存在的代码存在分歧时,遵循代码的常规,并报告每次不匹配,除非文档标记了代码遗留或正在迁移. |
| `coded-offers` | 提供使用编号的问题和编码选项(`1a`, (中文(简体) ), `1b`所以,一个简短的答复回答每一个决定. |
| `compact-reviews` | 实质性审查判决采用决定、证据和适用行动、核查和限制标签;所需审查格式保持不变,工作状况摘要不重复调查结果. |
| `compact-status` | 大量工作更新使用 Goal, Done, Next and Needs you, 可用时有一个直接结果链接; 常规的一行更新保持短时间 . |
| `compression-codecs` | 优先使用zstd,然后使用brotli,然后使用gzip来获取您所写的数据,在浏览器和gzip中,另一个工具必须读取文件;级别和测量在参考文献中. |
| `cross-session-relay` | 在会话之间的中继工作保持其源头和授权范围,向受影响的会话宣布一个授权的推动,即更改继承的指导或工具. |
| `effort-estimates` | 只有当一个被命名的可比较的完成运行支持它时,才会出现时间数字;没有,就说工作在等待什么,不给出数字。 工人、医生或其他模型的估算值以同样方式转换或下降. |
| `land-when-done` | 授权寄存器工作在远程默认分行内才能完成. |
| `low-quota-handoff` | 当目前的模型的使用津贴很低时,在停工前注销一笔转帐. |
| `maintainer-edits` | 启用 GitHub 上的维护者编辑从个人叉上拖取请求; 报告不支持的大小写 . |
| `model-default-questions` | 将询问方式留给您的主机和模型, 没有文本或问卡指令 . |
| `multi-agent` | 工作由受委托的工人和若干代理东道主分担;工人报告、审查标准和清理检查都由他们负责. |
| `no-attribution` | 提交、调取请求和评论没有代理或工具信用额度,除非目标存储库要求披露. |
| `periodic-updates` | 一份工作预计持续时间会超过10分钟, 默认情况下每5分钟发布一次短状态更新, 有进展, 时间过长, 等待结果和结果至今( 只有当一个被命名的相似的完成运行支持它时, 才能完成), 直至任务结束; 计划任务在运行时会说明,在闲置时会保持沉默并有结束. |
| `plan-files` | 多步骤工作保持一个可见的任务列表,与计划文件相映射,其中包含每个项目结果的分类账. |
| `question-cards` | 选择在主机支持完整文本报盘时,除完整文本报盘外的问卡;可用性和演示形式可以因主机,提供者和模型而异. |
| `release-batching` | 批次批准,兼容的发布更改和在发布或公告前审计事实索赔. |
| `scratch-on-disk` | 任务抓取生活在用户数据目录下的磁盘上, 从未在 RAM 备份中 `/tmp`。 。 。 . |
| `shared-host-load` | 只有基准和其他的性能测量等一个安静的宿主. 其他工作随负荷而定;虽然孤立的计量工作在进行,但相互竞争的工作遵循其隔离规则。 非常大的工作仍然在内存盖下运行. |
| `skill-routing` | 在每项任务开始时,选择最合适的技能以及任何明显适用的其他技能;留作后继,再次选取新任务,在不合适时不使用. |
| `solo-operator` | 对于拥有一个维护者的寄存器,用户的方向是审查;没有审查指定步骤. 检阅机器人的子弹被封了. |
| `squash-landing` | 将请求通过壁球合并 处理审查 - 机器人的发现, 和会话的检查 移出登陆分支. |
| `text-only-questions` | 在文本中询问每个问题,并拨打不问工具,即使主机曝光一个. |
| `upstream-contributions` | 第三方项目中发现的经衡量的优化、固定或缺陷,将通过自己的捐助途径提交该项目. |
| `web-image-formats` | 网络光栅图像在以可接受的质量保存字节时优先使用WebP,但格式例外和交付文件检查除外. |

默认的内规则并不禁止您主机自己的问题工具:核心 规则允许它被使用, 整个决定在名片上,和每一个决定 仍然得到一个完整的文本报价. `--questions core` 返回此状态 任何其他选择。 设置询问您想要问的问题 :

-   **模式默认**: 房屋规则没有给出指令, 所以您的模型和主机询问 通常的方式(`model-default-questions`) (中文(简体) ).
-   **只有文本**: 纯文本选项,有或没有简短的回复代码,例如 `1a` (单位:千美元)`text-only-questions`,或 `coded-offers` 代码)。 没有问题工具 被通知,即使主机暴露他们.
-   **可用时可点击选择**: 完整文本选项外加a 问题卡(`question-cards`) (中文(简体) ). 无法使用、跳过或显示卡片 出乎意料地在主机、供应商和模型之间;文本提议仍然可用 独自一人.

每种选择都有成本,列于 [每个选择的成本](https://npmcn.com/package/%40bompus/house-rules/docs/configuration.md#what-each-question-choice-costs)。 。 。 . 文本只是向显示待决问题的主机隐藏问题.

`hr-house-rules-setup` 问您想要什么 并解释这些限制之前 更改配置.

## 技能

| 技能 | 用它来 |
| --- | --- |
| `hr-agent-guidance-audit` | 审计代理人对呆滞或相冲突规则的指导,决定什么是退休或合并. |
| `hr-agent-guidance-refresh` | 重新阅读自会后变化的指南. |
| `hr-api-exposure-check` | 保持API对消费者阅读的字段的响应,呼叫者可能看到. |
| `hr-audit-choices` | 列出和检查在执行某项任务时作出的决定. |
| `hr-benchmarking` | 设计,运行和评估时间,CPU和内存比较;通过它们回答的问题选择工具. |
| `hr-better-accessibility` | 在web UI中构建并审查键盘访问,语义,形式,焦点,运动和回流. |
| `hr-better-colors` | 选择和检查调色板、语义符号、主题、游戏和制成对比. |
| `hr-better-layout` | 构建并审查分组,对齐,间隔,响应布局和剪接. |
| `hr-better-typography` | 样式和审查类型天平、包装、间隔、截取和字体加载. |
| `hr-better-writing` | 写和审查接口标签,出错,空状态和产品术语. |
| `hr-code-review` | 对照标准和要求审查diff,并检查它能突破什么界限. |
| `hr-design-exploration` | 比较一个构件的视觉方向或变体, 并精细地走向一个设计. |
| `hr-diagnosing-bugs` | 工作一个困难的bug 或回归到一个确认的原因. |
| `hr-explain-code` | 追踪现有代码是如何工作的,只读,然后更改它. |
| `hr-extract-shared-steps` | 将跨工作流程重复的操作移入共享功能. |
| `hr-forgotten-work-audit` | 审计过去会议、计划以及从每份清单中删除的承诺工作. |
| `hr-handoff` | 写新会话可以恢复. |
| `hr-house-rules-setup` | 选择修改器,创建您的图层并连接您的主机 . |
| `hr-issue-tracker-setup` | 配置项目跟踪器、域名术语和发展成果评估公约;只明确. |
| `hr-lean-plan` | 撰写或收紧实施计划,其中移动部件最少. |
| `hr-maintainability-review` | 严格审查一个diff或整个代码库,用于结构,过度工程和剩余脚手架. |
| `hr-manual-qa` | 报告物剂核查结果后,给予可再生人体检查. |
| `hr-navigation-retro` | 审计选定记录的导航故障,并提出经核实的可找到性修正. |
| `hr-ordering-tests` | 假设事件通过真实代码命令寻找种族错误. |
| `hr-plain-prose` | 使文字人读得简单而具体. |
| `hr-progress-report` | 报告当前的任务活动、里程碑的完成情况和剩余时钟时间. |
| `hr-pr-followup` | 处理公关、着陆权限、代码Rabbit和立方门的冲突、反馈和失效检查. |
| `hr-read-reddit` | 在支持的同时读取 Reddit feed 输出; RSS 支持于2026年11月13日结束. 部分网络搜索倒计时. |
| `hr-read-x-links` | 读取 X 帖子的全部内容. |
| `hr-research-shared-links` | 深入研究一个共享的链接或寄存器,将其与您的设置相比较,并评分每个想法. |
| `hr-sqlite` | 在 SQLite 代码中对照测量结果检查设置,锁定,查询和复制. |
| `hr-stock-ui-audit` | 在前端代码中查找并分解模板-默认样式 . |
| `hr-tdd` | 通过一次一个红绿片执行所要求的试验第一工作;审查期间简化. |
| `hr-test-audit` | 决定哪些新测试值得保留 哪些旧测试值得保留. |
| `hr-usage-report` | 按提供者、模型和角色衡量代理人使用情况,并绘制模型比较图. |
| `hr-what-next` | 协调剩余会议的工作,并在被问及下一步工作时建议优先事项. |
| `hr-writing-for-agents` | 写作技能,规则和其他文档代理阅读. |
| `hr-writing-pr` | 从最后的 diff 中写入一个拉取请求标题和正文;将工作分割成多个 PR. |

这个 `hr-navigation-retro` 在选中的工具调用中查找导航失败 记录,然后提出对照当前来源核实的修补. 任何代理人与 文件与 shell 访问可以运行它。 支持的投入包括克洛德代码,代码x, OpenCode导出, Cursor CLI流和ACP v1 其他代理的录音. 见其 [输入限制](https://npmcn.com/package/%40bompus/house-rules/skills/hr-navigation-retro/references/inputs.md)。 。 。 . 它需要Python 3.11+,并在当地保存报告.

## 对照模型检查规则

`evals/end-of-reply/` (在"GitHub"寄存器中,不是npm包)通过任何模型CLI运行了短假想. 成绩 无论代理人是否在合适的时间继续工作或以报价结束, 包括只读出前80行时. 2026-10-11 重播覆盖 其18种情景,每种2个,仅在Claude Code 2.1.296号上修订 `efd4d7b`· ; `rules/core.md` 从那时起,情况发生了变化。 规则得分了 在36份答复中,有22份与Opus 5.5, 有27份与Sonnet 5.5。 一罪不二审 指令分出18分和16分,没有规则分出17分和16分. 收益组 在后续行动、停放结果、堆放报价和附带利益方面 控制器得分为0。 每场两场比赛都是小样本 所以读一下计数, 没有百分比。 没有测量到其他制剂。 Eval的读取器有: 细分和限额.

## 发展

```bash
node --test test/*.test.mjs   # composer and eval grader
bun test test/                # the same under Bun
bun test skills/              # skill scripts
npm run check:package -- --bun   # npm tarball: packs, installs, runs the CLI
bun install && bun run check     # format, lint and type check
```

`npm run check` 运行 `bun fmt` (Bun 1.4.4或后),克林特, `bun --check`,粗鲁,shfmt和 检查外壳 除了两个 Bun 命令, JavaScript 工具都是被绑定的 dev 依赖性. Ruff 0.17.1, 外壳检查 0.11.0 和shfmt 3.14.1 来自您的 `PATH`· ; `scripts/install-check-tools.sh DIR` 和CI一样,在Linux x86 64上安装这些版本. 类型检查覆盖每个 文件夹除外 `node_modules` 和技能测试装置`tsconfig.check.json`) (中文(简体) ).

`npm run check` 运行 `bun fmt --no-script --check`,其内容如下: `.oxfmtrc.json`。旗帜保留 Bun's formatter 从运行一个 `package.json` `fmt` 脚本取而代之. 它检查了 Markdown, HTML, JSON, JSONC, YAML, TOML 和 CSS 的作者 作为JavaScript和TypeScript。 被钉住 `oxfmt` 为使用它的编辑器安装. 由于扫描仪测试取决于其准确的文本和行,所以测试固定装置被排除 数字。 软件包字段和依赖性地图进行排序;脚本顺序保留.

测试在每次测试后都会去除自己的固定目录,包括失败. 设定 `HOUSE_RULES_TEST_TMP` 以选择其抓取根; 否则,它们使用操作系统临时目录。 选择磁盘备份 当系统临时目录被内存备份时的位置.

CI对每个拉动请求 和推向 `main`,并运行测试和对Windows的柏油球检查。 见 [捐款额](https://npmcn.com/package/%40bompus/house-rules/CONTRIBUTING.md) 在打开一个之前.

本地引用门运行于 `test/guidance-links.test.mjs`. 审计另一个 退职 `bun guidance-links.mjs --root <checkout> --repository owner/repo=<local-checkout>`; 重复 `--repository` 其他可用来源. 它的JSON报告识别出要替换的GitHub文件指针. 当一个遥控器 链接故意引用当前来源,下载文件或刷新 上游指导,请使用这些评论中的一条。 每一个都需要一个理由:

-   `<!-- local-reference: source <reason> -->`
-   `<!-- local-reference: download <reason> -->`
-   `<!-- local-reference: remote-refresh <reason> -->`

固定的历史和图像是豁免的.

## 赞助

住房规则由一人建造和维护。 如果能节省你的时间,你可以 每月或一次赞助 [GitHub 赞助商](https://github.com/sponsors/bompus),或留下提示 [高飞](https://ko-fi.com/bompus)。 。 。 .

## 许可证

麻省理工学院. 一些技能适应麻省理工学院许可的工作,以及 `CODE_OF_CONDUCT.md` 这是 《公约》下的贡献者 `THIRD_PARTY_NOTICES.md`。 。 。 .

## 常见问题

### @bompus/house-rules 是什么？

AI编码代理商的可编译工作规则和技能

### 如何安装 @bompus/house-rules？

在项目目录运行 npm install @bompus/house-rules，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 house-rules，可以用 npx house-rules 直接运行。

### @bompus/house-rules 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bompus\_\_house-rules 是否存在。

### @bompus/house-rules 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @bompus/house-rules 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @bompus/house-rules 可以商用吗？

@bompus/house-rules 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @bompus/house-rules 的下载量有多少？

根据 npm 官方下载统计，@bompus/house-rules 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,551 次，日均约 85 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bompus/house-rules 还在维护吗？

最新版本 0\.21\.0 发布于 2026/11/07（1 天前）；至今共发布 15 个版本，其中过去 12 个月发布了 15 个；首次发布于 2026/10/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。