37 lines
13 KiB
Markdown
37 lines
13 KiB
Markdown
---
|
|
gitea: none
|
|
include_toc: true
|
|
---
|
|
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)
|
|
|
|
## Exporte la configuration dans des variables d'environnement
|
|
|
|
> [!NOTE]
|
|
>
|
|
> L'exportation de la configuration sous forme de variables d'environnement la rend accessible aux applications nécessitant ce type de variable (scripts, applications Twelve-Factor, etc.).\
|
|
> \
|
|
> Vous pouvez l'utiliser, avec le fichier .rougailconf.yaml approprié, en exécutant : "source <(rougail)".\
|
|
> \
|
|
> Note : une variable dans un "sequence" qui serait désactivée pour un index particulier sera remplacé par une chaine vide.\
|
|
> **Chemin** : environment\
|
|
> *`désactivé`*\
|
|
> **Désactivé** : lorsque la variable "[sélection pour sortie](#step.output)" est accessible et n'a pas la valeur "environment".
|
|
|
|
### Configuration pour la sortie type environment
|
|
|
|
> [!NOTE]
|
|
>
|
|
> **Chemin** : environment.output\
|
|
> *`désactivé`*\
|
|
> **Désactivé** : lorsque la variable "[sélection pour sortie](#step.output)" est accessible et n'a pas la valeur "environment".
|
|
|
|
| Variable | Description | Valeur par défaut | Type | Contrôle des accès | Validateur |
|
|
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
|
|
| **<a id="environment.output.prefix" name="environment.output.prefix">environment.output.prefix</a>**<br/>**Ligne de commande** : <br/>--environment.output.prefix<br/>**Variable d'environnement** : ROUGAILCLI_ENVIRONMENT.OUTPUT.PREFIX | Ajouter un préfixe aux variables d'environnement. | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | | |
|
|
| **<a id="environment.output.boolean_type" name="environment.output.boolean_type">environment.output.boolean_type</a>**<br/>**Ligne de commande** : <br/>--environment.output.boolean_type<br/>**Variable d'environnement** : ROUGAILCLI_ENVIRONMENT.OUTPUT.BOOLEAN_TYPE | Les booléens sont convertis en.<br/>Il n'y a pas de booléen dans le shell, nous devons donc le convertir<br/><br/>"string" signifie les chaînes de caractères "true" ou "false"<br/><br/>"number" signifie les nombres "1" ou "0". | string | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | **Choix** : <br/>• string<br/>• number |
|
|
| **<a id="environment.output.upper" name="environment.output.upper">environment.output.upper</a>**<br/>**Ligne de commande** : <br/>• --environment.output.upper<br/>• --environment.output.no-upper<br/>**Variable d'environnement** : ROUGAILCLI_ENVIRONMENT.OUTPUT.UPPER | Le nom des variables sont en majuscule. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
|
| **<a id="environment.output.path_is_variable_name" name="environment.output.path_is_variable_name">environment.output.path_is_variable_name</a>**<br/>**Ligne de commande** : <br/>• --environment.output.path_is_variable_name<br/>• --environment.output.no-path_is_variable_name<br/>**Variable d'environnement** : ROUGAILCLI_ENVIRONMENT.OUTPUT.PATH_IS_VARIABLE_NAME | Le nom des variables est, en fait, un chemin. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
|
| **<a id="environment.output.custom_separator" name="environment.output.custom_separator">environment.output.custom_separator</a>**<br/>**Ligne de commande** : <br/>--environment.output.custom_separator<br/>**Variable d'environnement** : ROUGAILCLI_ENVIRONMENT.OUTPUT.CUSTOM_SEPARATOR | Remplace le caractère de séparateur "." dans le chemin par un autre.<br/>Le caractère point (".") peut ne pas être autoriser dans le nom des variables d'environnement. | _ | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | *`désactivé`*<br/>**Désactivé** : lorsque la variable "[Le nom des variables est, en fait, un chemin](#environment.output.path_is_variable_name)" a la valeur "false". | |
|
|
| **<a id="environment.output.multi_in_array" name="environment.output.multi_in_array">environment.output.multi_in_array</a>**<br/>**Ligne de commande** : <br/>• --environment.output.multi_in_array<br/>• --environment.output.no-multi_in_array<br/>**Variable d'environnement** : ROUGAILCLI_ENVIRONMENT.OUTPUT.MULTI_IN_ARRAY | Variables a multiple valeurs vont être chargé dans un array.<br/>Tous les shells ne prennent pas en charge les arrays. Cette fonctionnalité n'est pas compatible POSIX, elle est spécifique à Bash (d'autres shells, comme zsh ou ksh, prennent également en charge les arrays).<br/><br/>Si votre shell prend en charge les arrays, il est préférable de les utiliser pour parcourir les valeurs de la liste. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|
|
| **<a id="environment.output.multi_separator" name="environment.output.multi_separator">environment.output.multi_separator</a>**<br/>**Ligne de commande** : <br/>--environment.output.multi_separator<br/>**Variable d'environnement** : ROUGAILCLI_ENVIRONMENT.OUTPUT.MULTI_SEPARATOR | Le séparateur pour les variables à valeurs multiples. | ; | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | *`désactivé`*<br/>**Désactivé** : lorsque la variable "[Variables a multiple valeurs vont être chargé dans un array](#environment.output.multi_in_array)" a la valeur "true". | |
|
|
| **<a id="environment.output.submulti_separator" name="environment.output.submulti_separator">environment.output.submulti_separator</a>**<br/>**Ligne de commande** : <br/>--environment.output.submulti_separator<br/>**Variable d'environnement** : ROUGAILCLI_ENVIRONMENT.OUTPUT.SUBMULTI_SEPARATOR | Le séparateur pour les variables à sous valeurs multiples. | si "[Variables a multiple valeurs vont être chargé dans un array](#environment.output.multi_in_array)" la valeur est ";" sinon la valeur est ",". | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | | |
|