快速入门

安装

你可以使用我们的 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

通过键名获取特定环境变量的值。

此方法用于获取在 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 概览中的实现细节， 简介 了解简介中的实现细节， API 密钥 了解 API Keys 中的实现细节，以及 设备 了解 Devices 中的实现细节。