# @gitpagedocs/tools 中文文档

规范地址：https://npmcn.com/package/%40gitpagedocs/tools/

版本：0\.0\.26
npm 元数据更新时间：2026-11-09T11:28:30.586Z
中文译文更新时间：2026-11-16T14:50:15.463Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40gitpagedocs/tools
原文对照：https://npmcn.com/package/%40gitpagedocs/tools/?lang=original
项目主页：https://github.com/Vidigal-code/git-page-docs#readme
源码仓库：https://github.com/Vidigal-code/git-page-docs

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

- 包体积（解压后）：147 kB，63 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-06-14T23:41:08.249Z
- 最新版本发布：2026-11-09T11:28:30.335Z
- 近 30 天下载量：4288（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：50（近 12 个月 50 个）

## 中文简介

Git Page Docs的共享商业-逻辑核心(由前端,cli和mcp所消费). 船舶类型Script源;通过tsx或有TS意识的捆绑器来消耗.

## 安装

```sh
npm install @gitpagedocs/tools
```

也可以使用：`pnpm add @gitpagedocs/tools`、`yarn add @gitpagedocs/tools`、`bun add @gitpagedocs/tools`

## README

# @ gitpagedocs/ 工具

这个 **共享商业记录核心** 会 议 日 程 和 议 程 [Git 页面文档](https://npmcn.com/package/%40gitpagedocs/README.md) monorepo——由前端所消耗的域逻辑,CLI,和MCP服务器的单一主机. 飞船 **类型脚本源** 并且通过 `tsx` (CLI/MCP)或有TS意识的捆绑机(下) `transpilePackages`) (中文(简体) ).

## 模块`src/`(中文(简体) )

| 模块 | 责任 |
| --- | --- |
| `ai/` | 14个提供者AI系统——数据驱动 `PROVIDER_CATALOG`,注册+工厂(没有开关链),5个家庭适配器(OpenAI兼容器,Anthropic,双子座,Ollama,Cohere),SSE/NDJSON流线,遗留-Catalog id映射 |
| `security/` | `EncryptedCredentialVault` (AES-256-GCM、PBKDF2-HMAC-SHA-256关键衍生), `SessionPasswordGate`· ; `WebStorageVaultStorage` (现场) `localStorage` 保险库)+ `FileVaultStorage` (国家行动倡议) `.gitpagedocsvault` 文件)适配器 |
| `crypto/` | `NodeCryptoService` + 键 `WebCryptoService` (SHA-256、PBKDF2、AES-256-GCM、口罩、安全擦拭); `deriveDocAccessKeys` 编号 : `verifyDocAccess` (双层文件密码门由CLI共享) `password` 命令和前端门) |
| `cache/` | `MemoryCache`, (中文(简体) ), `FileCache`, (中文(简体) ), `WebStorageCache` (一个以上的战略) `Cache` 端口) |
| `config/` | `GitPageDocsConfigLoader` (单位:千美元)`.json` 编号 : `.js` 编号 : `.ts`(中文(简体) ) |
| `config-format/` | 浏览器安全 `compactSiteIcons` 编号 : `expandSiteIcons` 财务报告和审定财务报表 `applyRouteDefaults` 编号 : `factorRouteDefaults` 紧凑配置和继承的路由值 |
| `logger/` | 水平过滤日志 **秘密编辑** |
| `errors/` | `AppError` + 键入子类 |
| `filesystem/` | `FileService` (列表/已读/已写入/ 已写入 list/ archive with lexical and canonical root 封存; 在创建文件前验证已有的家长, 并拒绝写上的目标符号链接; 同时替换路径仍然需要信任的文件系统边界) |
| `documentation/` | `DocumentationService`, (中文(简体) ), `patchManagedRegion`, (中文(简体) ), `DocUpdater` |
| `i18n/` | 语言捆绑( E)`site.languages` 切换到 `config.json` + 键 `langs/<lang>.json`: `loadConfigLanguageBundles`, (中文(简体) ), `applyLanguageBundles` (单位:千美元) `site.langmenu` 编号 : `translations`, (中文(简体) ), `filterEnabledLanguages`, (中文(简体) ), `splitLanguageBundles` (生成方); 浏览器安全 |
| `ports/` | 只类型合同( 跳鼠、 缓存、 加密、 安全、 配置、 ai) |

## 入境点`exports`(中文(简体) )

`.` · (满管) `./ai` • 妇女 `./errors` • 妇女 `./i18n` • 妇女 `./config-format` • 妇女 `./ports` • 妇女 `./crypto/web` • 妇女 `./security/web` • 妇女 `./cache/web` - 那个 `web` 子路径, `./i18n` 财务报告和审定财务报表 `./config-format` 浏览器安全( 无) `node:` 用于下个.js捆绑.

## 使用量

```ts
import { createDefaultFactory, PROVIDER_CATALOG } from "@gitpagedocs/tools/ai";
import { EncryptedCredentialVault } from "@gitpagedocs/tools/security/web";
```

## 测试

单位+集成+E2E `tools/tests/**` (Vites);自测试 `tools/smoke/**`从 repo 根中运行 : `npx vitest run` 财务报告和审定财务报表 `npm run smoke:all`。 。 。 .

## 常见问题

### @gitpagedocs/tools 是什么？

Git Page Docs的共享商业-逻辑核心\(由前端,cli和mcp所消费\)\. 船舶类型Script源;通过tsx或有TS意识的捆绑器来消耗\.

### 如何安装 @gitpagedocs/tools？

在项目目录运行 npm install @gitpagedocs/tools，或使用 pnpm add / yarn add / bun add。

### @gitpagedocs/tools 支持 TypeScript 吗？

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

### @gitpagedocs/tools 支持 ESM 还是 CommonJS？

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

### @gitpagedocs/tools 需要什么版本的 Node\.js？

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

### @gitpagedocs/tools 可以商用吗？

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

### @gitpagedocs/tools 的下载量有多少？

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

### @gitpagedocs/tools 还在维护吗？

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

