# @b12k/gitleaks 中文文档

规范地址：https://npmcn.com/package/%40b12k/gitleaks/

版本：8\.30\.1-v\.72
npm 元数据更新时间：2026-10-31T14:05:35.807Z
中文译文更新时间：2026-10-31T15:36:32.008Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40b12k/gitleaks
原文对照：https://npmcn.com/package/%40b12k/gitleaks/?lang=original
源码仓库：https://github.com/b12k/gitleaks

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

- 包体积（解压后）：15.3 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=24
- 运行依赖：4 个
- 首次发布：2026-07-07T20:24:41.384Z
- 最新版本发布：2026-10-31T14:05:35.500Z
- 已发布版本数：73（近 12 个月 73 个）

## 中文简介

Gitleaks缺失的NPM包装器

## 安装

```sh
npm install @b12k/gitleaks
```

也可以使用：`pnpm add @b12k/gitleaks`、`yarn add @b12k/gitleaks`、`bun add @b12k/gitleaks`

## README

# 缺少的npm包装器 [Gitleaks](https://github.com/gitleaks/gitleaks)

[Gitleaks](https://github.com/gitleaks/gitleaks) 是一个快速、轻量级的git库秘密扫描器。

这个库只是一个瘦包装器，它在安装时自动下载正确的gitleaks二进制文件，并将其作为CLI命令公开。

## 安装

通常作为开发依赖项安装：

**本地(项目)**

```bash
npm install --save-dev @b12k/gitleaks
```

最近的npm版本需要批准依赖项安装脚本。批准这个包，以便它的postinstall脚本可以下载gitleaks二进制文件：

```bash
npm approve-scripts @b12k/gitleaks
```

```bash
pnpm add -D --allow-build=@b12k/gitleaks @b12k/gitleaks
```

PNPM 11需要 `--allow-build` 标记这个包的postinstall脚本可以下载gitleaks二进制文件。

```bash
yarn add --dev @b12k/gitleaks
```

**全球**

```bash
npm install -g --allow-scripts=@b12k/gitleaks @b12k/gitleaks
```

全局npm安装不能使用 `npm approve-scripts`;使用 `--allow-scripts` 代替。

```bash
pnpm add -g --allow-build=@b12k/gitleaks @b12k/gitleaks
```

PNPM 11需要 `--allow-build` 全局安装期间的标志。

```bash
yarn global add @b12k/gitleaks
```

postinstall脚本从GitHub官方发布版本中为您的平台下载gitleaks二进制文件。

如果你已经安装了npm或pnpm，而构建被阻止了，批准并重新构建它：

```bash
npm approve-scripts @b12k/gitleaks
npm rebuild @b12k/gitleaks
```

```bash
pnpm approve-builds @b12k/gitleaks
pnpm rebuild @b12k/gitleaks
```

## 使用

看到 [gitleaks文档](https://github.com/gitleaks/gitleaks) 获取命令和标志的完整列表。

**本地安装**

```bash
npx gitleaks <command>
```

```bash
pnpm exec gitleaks <command>
```

```bash
yarn gitleaks <command>
```

**全球安装**

```bash
gitleaks <command>
```

**`package.json` 脚本**

```json
{ "scripts": { "secrets": "gitleaks <command>" } }
```

## 故障排除

如果二进制文件安装失败，请重新运行 `--foreground-scripts` 查看安装后的输出：

```bash
npm install --save-dev @b12k/gitleaks --foreground-scripts
```

```bash
pnpm add -D --allow-build=@b12k/gitleaks @b12k/gitleaks --foreground-scripts
```

```bash
yarn add --dev @b12k/gitleaks --foreground-scripts
```

## 支持的平台上

-   Linux - x64, arm64
-   macOS - x64, arm64
-   Windows - x64, arm64

## 版本

npm包的版本是gitleaks发布版本的镜像。

要安装不同的gitleaks版本，请在 `.gitleaks-version` 作为 `v1.2.3` 或者 `1.2.3` 安装软件包前。

如果您添加或更改 `.gitleaks-version` 安装完成后，运行：

```bash
gitleaks-install
```

## 常见问题

### @b12k/gitleaks 是什么？

Gitleaks缺失的NPM包装器

### 如何安装 @b12k/gitleaks？

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

### @b12k/gitleaks 支持 TypeScript 吗？

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

### @b12k/gitleaks 支持 ESM 还是 CommonJS？

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

### @b12k/gitleaks 需要什么版本的 Node\.js？

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

### @b12k/gitleaks 可以商用吗？

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

### @b12k/gitleaks 还在维护吗？

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