快速入门

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下 prompt：

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

如果你更想手动设置，请运行以下命令安装插件，并按照下方各平台的说明操作：

npm install @capgo/capacitor-env
npx cap sync

导入

import { Env } from '@capgo/capacitor-env';

快速入门

import { Env } from '@capgo/capacitor-env';

const result = await Env.getKey({ key: 'API_URL' });
console.log(result.value); // 'https://api.example.com'

常见坑点

• 原生同步：运行 npx cap sync 在插件升级后。
• 唯一可信来源：信任 src/definitions.ts 在 GitHub 仓库中。

API 概览

getKey

根据 key 获取指定环境变量的值。

此方法用于获取在 Native Build 过程中设置的环境变量。这些变量必须先在原生项目中进行配置，才能在运行时进行访问。

import { Env } from '@capgo/capacitor-env';

const result = await Env.getKey({ key: 'API_URL' });
console.log(result.value); // 'https://api.example.com'

单一事实来源

本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时，请重新运行 sync。

从入门指南继续

如果你正在使用 快速入门 要规划 dashboard 和 API 操作，请将其连接到 使用 @capgo/capacitor-env 关于使用 @capgo/capacitor-env 时的原生能力， API 概览 关于 API Overview 中的实现细节， 简介 关于 Introduction 中的实现细节， API 密钥 有关 API Keys 的实现细节，以及 设备 有关 Devices 的实现细节。