# @chriscode/hush 中文文档

规范地址：https://npmcn.com/package/%40chriscode/hush/

版本：7\.5\.0
npm 元数据更新时间：2026-06-15T20:03:35.796Z
中文译文更新时间：2026-11-09T19:02:40.368Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：583 kB，232 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：2 个
- 首次发布：2026-01-14T16:27:05.628Z
- 最新版本发布：2026-06-15T20:03:35.462Z
- 近 30 天下载量：1831（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：57（近 12 个月 57 个）

## 中文简介

AI-本土机密经理. 保密在休息时保持加密;AI代理帮助而不看到值.

## 安装

```sh
npm install @chriscode/hush
```

也可以使用：`pnpm add @chriscode/hush`、`yarn add @chriscode/hush`、`bun add @chriscode/hush`

## README

# @chriscode/ 嘘声

> **AI本地机密经理.** 秘密会保密的 AI可以帮助而不看到价值.

[![npm](https://img.shields.io/npm/v/@chriscode/hush)](https://www.npmjs.com/package/@chriscode/hush) [![Documentation](https://img.shields.io/badge/docs-hush--docs.pages.dev-blue)](https://hush.ch5.me/)

![Hush - AI-native secrets manager](https://npmcn.com/package/%40chriscode/hush/hero.webp)

Hush将项目权限存储在加密的v3仓库文件中. 目前的模式很简单:

-   `.hush/manifest.encrypted` 定义身份、捆绑、目标和进口
-   `.hush/files/**.encrypted` 存储实际的秘密条目和文件级阅读器
-   `hush run -- <command>` 是正常运行时路径

没有纯文本的秘密文件可以教一个AI助手避免. Hush 解密只针对活性过程或已实现的目标,然后清理.

**[读取全部文件](https://hush.ch5.me/)**

## 安装

```bash
pnpm add -D @chriscode/hush
# or
npm install -D @chriscode/hush
```

### 先决条件

```bash
brew install sops age
```

## 快开始

### 1\. 启动 v3 存储器

```bash
npx hush bootstrap
```

创建加密寄存器 shell, 设置密钥, 并写入第一个 v3 文件 :

```text
.hush/manifest.encrypted
.hush/files/env/project/shared.encrypted
```

### 2\. 检查目前的配置

```bash
npx hush config show
npx hush config active-identity
```

使用 `hush config` 检查仓库状态并更新文件阅读器.

### 3\. 安全添加秘密

```bash
npx hush set DATABASE_URL
npx hush set API_KEY --gui
```

`hush set` 需要时提示值,所以助手永远看不到.

### 4\. 运行您的应用程序

```bash
npx hush run -- npm start
npx hush run -e prod -- npm build
```

这是正常的运行时间路径 。 安静地解密内存,并将值传递给命令.

## 当前 v3 寄存器模式

Hush v3 保留加密 YAML 文档中的存储权限 `.hush/`。 。 。 .

| 文件 | 目的 |
| --- | --- |
| `.hush/manifest.encrypted` | 仓库元数据、身份、捆绑、目标和进口 |
| `.hush/files/**.encrypted` | 每个加密文件的秘密条目加阅读器 |
| `.sops.yaml` | 带有项目公钥的 SOPS 创建规则 |

`hush bootstrap` 创建外壳. `hush config` 检查或更新. `hush run` 这是你如何每天使用它.

## 核心命令

| 命令 | 它会做什么 |
| --- | --- |
| `hush bootstrap` | 创建 v3 寄存器 shell 和初始活动身份 |
| `hush config show [section]` | 显示清单、文件、身份、目标、导入或状态 |
| `hush config active-identity [name]` | 显示或更改活动身份 |
| `hush config readers <file-path> --roles <csv>` | 更新文件阅读器 |
| `hush set <KEY>` | 安全添加或更新一个秘密 |
| `hush inspect` | 列出带有遮盖值的秘密名称 |
| `hush has <KEY>` | 检查是否有秘密 |
| `hush run -- <command>` | 在记忆中带着秘密运行 |
| `hush push` | 向Cloudflare推进目标 |
| `hush keys setup` | 校验本地工程密钥 |
| `hush skill` | 安装 AI 技能 |

## 遗产 v2 迁移

如果一个寄存器仍然使用旧的 v2 版式, 请使用迁移桥 :

```bash
npx hush migrate --from v2
npx hush migrate --from v2 --cleanup
```

这是从遗留的寄存器到当前v3模型的支持桥.

## AI-安全工作流程

对于AI助手来说,安全回路是:

```bash
npx hush inspect
npx hush has DATABASE_URL
npx hush set DATABASE_URL
npx hush run -- npm start
```

您也可以安装运出的技能 :

```bash
npx hush skill
npx hush skill --global
npx hush skill --local
```

## 工作流程示例

```bash
# bootstrap the repo once
hush bootstrap

# inspect config and identities
hush config show
hush config active-identity owner-local

# add secrets
hush set DATABASE_URL
hush set STRIPE_SECRET_KEY

# run the app
hush run -- npm start
```

## 团队设置

将工程年龄键复制到 `~/.config/sops/age/keys/{project}.txt`,然后用:

```bash
hush config show state
```

## 解决问题

### 缺少 OPS 或年龄

```bash
brew install sops age
```

### 密钥不匹配此寄存器

运行 :

```bash
hush keys setup
```

### 你需要转换遗产的回购

运行 :

```bash
hush migrate --from v2
```

添加 `--cleanup` 在验证迁移状态后.

## 许可证

麻省理工学院

## 常见问题

### @chriscode/hush 是什么？

AI-本土机密经理\. 保密在休息时保持加密;AI代理帮助而不看到值\.

### 如何安装 @chriscode/hush？

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

### @chriscode/hush 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @chriscode/hush 支持 ESM 还是 CommonJS？

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

### @chriscode/hush 需要什么版本的 Node\.js？

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

### @chriscode/hush 可以商用吗？

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

### @chriscode/hush 的下载量有多少？

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

### @chriscode/hush 还在维护吗？

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