# @capgo/capacitor-env 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-env/

版本：8\.1\.52
npm 元数据更新时间：2026-11-09T07:20:12.732Z
中文译文更新时间：2026-11-09T03:48:20.656Z
软件包许可：MPL-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-env
原文对照：https://npmcn.com/package/%40capgo/capacitor-env/?lang=original
项目主页：https://capgo.app/docs/plugins/env/
源码仓库：https://github.com/Cap-go/capacitor-env

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

- 包体积（解压后）：44.4 kB，25 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2025-10-08T11:57:00.321Z
- 最新版本发布：2026-11-09T07:20:12.430Z
- 近 30 天下载量：42186（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：64（近 12 个月 51 个）

## 中文简介

将 Env var 设置为 Capacitor 配置并在运行时读取

## 安装

```sh
npm install @capgo/capacitor-env
```

也可以使用：`pnpm add @capgo/capacitor-env`、`yarn add @capgo/capacitor-env`、`bun add @capgo/capacitor-env`

## README

# @ capgo/ 电容器- env

在运行时从您的 Capacitor 配置中读取环境值, 因此一个代码库可以传送尽可能多的具有不同设置的白色标签或多租位应用程序 .

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-env)](https://capgo.app/?ref=plugin_env)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_env)

14天无限自由审判. 不需要信用卡

> 🤖 **建筑与AI编码代理?** 安装 [Capgo 技能](https://capgo.app/skills/?ref=plugin_env) 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 `@capgo/capacitor-env` 在您的电容应用程序中: `npx skills add Cap-go/capgo-skills`。然后问你的经纪人: _添加@capgo/capor-env到我的Capacitor应用上,并把它接上_ [代理设置指南](https://capgo.app/agents/?ref=plugin_env) • 妇女 [主机磁共振](https://capgo.app/docs/ai/mcp/?ref=plugin_env)

![@capgo/capacitor-env for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-env/main/assets/github-social-preview.png)

## 主要特点

-   **运行时间配置**数字 : `getKey()` 返回您在插件区域设置的值 `capacitor.config`。 。 。 .
-   **白色标签友好**: 保留相同的网页代码, 只更改每个应用程序的本地配置 .
-   **原读**:值出自iOS和Android上的Capacitor插件配置.
-   **安全默认**: 缺少密钥返回空字符串.
-   **平台**: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-21. 网上, `getKey()` 返回空字符串.

## 文档

这里有最完整的医生: [https://capgo.app/docs/plugins/env/ 页面存档备份,存于互联网档案馆](https://capgo.app/docs/plugins/env/)

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| 联合国 | 联合国 | ✅ |
| 页:1 | 页:1 | 应要求 |
| 页:1 | 页:1 | ❌ |
| 页:1 | 页:1 | ❌ |

> **说明:** 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

## 安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

然后使用下列提示:

```text
Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-env` plugin in my project.
```

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
npm install @capgo/capacitor-env
npx cap sync
```

## API 密码

-   [`getKey(...)`](https://npmcn.com/package/%40capgo/capacitor-env/#readme-getkey)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-env/#readme-getpluginversion)

在本地代码中访问环境变量的电容插件.

此插件提供了一个安全的方式来访问当时的环境变量 在构建时编译为本地应用程序。 环境变量 可以在构建过程中配置,并在运行时访问,而不包含 在网络捆绑中曝光他们.

### 获取 Key(...)

```typescript
getKey(options: { key: string; }) => Promise<{ value: string; }>
```

按键获取特定环境变量的值.

这种方法可以获取本地环境变量 构建进程。 变量必须在本地工程中配置 在运行时间访问之前.

| 参数 | 类型 | 说明 |
| --- | --- | --- |
| **`options`** | `{ key: string; }` | \- 包含环境可变密钥的配置对象 |

**回返情况:** `Promise<{ value: string; }>`

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<{ version: string; }>
```

获取本地 Capacitor 插件的版本 .

这种方法返回电容- env 插件的当前版本 安装在本地应用程序中。 用于调试 并确保网络和本地组件之间的兼容性.

**回返情况:** `Promise<{ version: string; }>`

* * *

## 常见问题

### @capgo/capacitor-env 是什么？

将 Env var 设置为 Capacitor 配置并在运行时读取

### 如何安装 @capgo/capacitor-env？

在项目目录运行 npm install @capgo/capacitor-env，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-env 支持 TypeScript 吗？

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

### @capgo/capacitor-env 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-env 可以商用吗？

@capgo/capacitor-env 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-env 的下载量有多少？

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

### @capgo/capacitor-env 还在维护吗？

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