stove/rougail
3
0
Fork 0
Code Issues 5 Pull requests 1 Projects Releases Wiki Activity

docs(cli): there was some french, translated now

Browse source
This commit is contained in:
gwen 2026-06-01 18:15:25 +02:00
parent 647eb7c45d
commit 4039e01769
1 changed files with 21 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
docs/cli.rst
View file

@ -1,7 +1,7 @@
The Rougail Command Line Interface
========================================
Les help
help
------------
::
@ -70,11 +70,10 @@ CLI root
┣━━ 📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/01/config.yml" (⏳ https.proxy.net ◀ loaded from the YAML file "config/01/config.yml" ⏳ http.proxy.net)
┗━━ 📓 HTTPS port: 3128
---
sortie normale:
.. FIXME: sortie normale:
sortie pour n'afficher qu'une family:
.. FIXME: sortie pour n'afficher qu'une family:
::
@ -100,13 +99,13 @@ on a:
┗━━ 📓 SOCKS host version used by proxy: v5
sortie plus précise:
for a more precise output:
::
rougail -m firefox/ -u yaml -yf config/01/config.yml --cli.root manual.https_proxy
on a:
we have
::
@ -125,15 +124,14 @@ Invalid user data error
Unknown user data error
-----------------------------
l'option "`--cli.unknown_user_data_error`", ca ressemble à "`--cli.invalid_user_data_error`" mais ca concerne là les variables inconnues (ou ici désactivé ou hidden mais ca reviens au meme pour moi) chargés dans des user data.
The option "`--cli.unknown_user_data_error`" looks like "`--cli.invalid_user_data_error`" but here it concerns unknown variables (or here disabled or hidden but it amounts to the same thing) loaded into user data.
https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_050/README.md#output-when-unknown-user-data-is-an-error
.. note:: The `--cli.unknown_user_data_error` option changes the behaviour of the Rougail CLI's standard output:
when an unknown (or disabled or hidden) variable is declared in the :term:`user data file <user data>`
then it appears in the output as an error instead of a warning.
Le output doc
The output doc
----------------
::
@ -160,15 +158,14 @@ Le output doc
--doc.no-document_a_type
Le formatter
The formatter
----------------
::
<gnunux> on va maintenant vérifier le formatage du fichier
<gnunux> rougail -o formatter -m structure.yml > a.yml; mv a.yml structure.yml
rougail -o formatter -m structure.yml > a.yml; mv a.yml structure.yml
Les namespaces
The namespaces
-----------------
::
@ -180,17 +177,25 @@ Les namespaces
rougail -m structure.yml -u yaml -yf userdata.yml -s intranet -xn hosts orem srem prom -xd 0 hosts.yml -xd 1 packages/OREM -xd 2 packages/SREM -xd 3 packages/SREP
L'export ansible
Commandline user data
----------------------------
Commandline user data can be used:
::
rougail -m mon_fichier.yml -u commandline --family.variable pouet
Ansible export
-------------------
rougail -m structure.yml -u yaml -yf userdata.yml -s intranet -xn hosts -xd 0 hosts.yml -o ansible > ansible.json
::
ansible-inventory -i $(which rougail) --list
<gnunux> voir si ansible liste bien ton inventaire :)
Ansible lists your inventory
::