rougail-output-json/README.fr.md

22 lines
3.3 KiB
Markdown
Raw Normal View History

2025-12-23 21:38:51 +01:00
---
gitea: none
include_toc: true
---
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)
## Export de la configuration au format JSON
> [!NOTE]
>
> Exporter la configuration au format JSON permet de traiter plus facilement la configuration dans un outil exterieur par exemple.\
> **Chemin** : json\
> *`désactivé`*\
> **Désactivé** : si json n'est pas présent dans "[Sélection pour sortie](#step.output)"
| Variable | Description | Valeur par défaut | Type |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| **<a id="json.mandatory" name="json.mandatory">json.mandatory</a>**<br/>**Ligne de commande** : <br/>&nbsp;--json.mandatory<br/>&nbsp;--json.no-mandatory<br/>**Variable d'environnement** : JSON.MANDATORY | Tester les variables obligatoires avant de l&#x27;afficher en JSON.<br/>La configuration doit être valide avant d&#x27;exporter les données au format JSON. C&#x27;est mieux de valider les valeurs au début du processus. | true si "[La configuration dans l&#x27;état de sortie est dans mode lecture-écriture](#cli.read_write)" est false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="json.get" name="json.get">json.get</a>**<br/>**Ligne de commande** : <br/>--json.get<br/>**Variable d'environnement** : JSON.GET | Récupère la valeur pour une variable ou une famille.<br/>Par défaut toute la configuration est exporté en JSON. Il est possible de récupérer les valeurs de variable dans une famille défini ou directement la valeur d&#x27;une variable.<br/>**Exemples** : <br/>&nbsp;family<br/>&nbsp;family.variable | | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) |