Getting Started

GitHub

Copiez une invite de commande de configuration avec les étapes d'installation et la guide markdown complet pour ce plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-env`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/env/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installez

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

bun add @capgo/capacitor-env
bunx cap sync

Importer

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

API Vue d'ensemble

`getKey`

Récupère la valeur d'une variable d'environnement spécifique par clé.

Cette méthode récupère les variables d'environnement qui ont été définies lors du processus de build natif. Les variables doivent être configurées dans le projet natif avant qu'elles puissent être accédées en temps de exécution.

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

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

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run le sync lorsque les modifications publiques API se produisent en amont.

Continuez de la section « Début de l'installation »

Si vous utilisez Démarrage pour planifier l'interface de tableau de bord et les opérations API, connectez-l’avec Utilisation de @capgo/capacitor-env pour la capacité native dans Utilisation de @capgo/capacitor-env, Vue d'ensemble de API pour le détail d'implémentation dans Vue d'ensemble de API, Introduction pour le détail d'implémentation dans Introduction, Clés de API pour le détail d'implémentation dans Clés de API, et Appareils pour le détail d'implémentation dans Appareils.