#################
Ligne de commande
#################


Les opérations gérées par ``waarp-manager`` utilisent des commandes de
la forme :

.. code-block:: bash

  waarp-manager <commande>


Commande ``waarp-manager version``
----------------------------------

.. program:: waarp-manager version

Écrit la version de l’application sur la sortie standard et rend la
main.

Codes de retour :

==== =================================
Code Signification
==== =================================
0    Succès
==== =================================


Commande ``waarp-manager server``
---------------------------------

.. program:: waarp-manager server

Démarre l’application Waarp Manager.

Cette commande accepte les arguments suivants :

.. option:: -c FILE, --config=FILE

   **obligatoire**
   Le chemin vers le fichier de configuration à utiliser


.. _ref_cli_wm-conf:

Commande ``waarp-manager conf``
-------------------------------

.. program:: waarp-manager conf

Écrit un fichier de configuration vide sur la sortie standard.

Cette commande accepte les arguments suivants :

.. option:: -u FILE, --update=FILE

   Le chemin du fichier à mettre à jour

   Si cet argument est donné, et que FILE est le chemin d’un fichier de
   configuration valide, ce fichier est mis à jour (les nouvelles
   options de configuration sont ajoutées et celles qui n’existent plus
   sont supprimées).

.. program:: foo


Commande ``waarp-manager push``
-------------------------------

.. program:: waarp-manager push

Déploie la configuration depuis la ligne de commande.

Cette commande accepte les arguments suivants :

.. option:: -c FILE, --config=FILE

   Le chemin vers le fichier de configuration à utiliser


.. _command-wm-db-sync:

Commande ``waarp-manager db sync``
----------------------------------

.. program:: waarp-manager db sync

Synchronise la base de données interne de Waarp Manager avec un
référentiel externe.

Cette commande accepte les arguments suivants :

.. option:: -c FILE, --config=FILE

   Le chemin vers le fichier de configuration à utiliser


Commande ``waarp-manager db dump``
----------------------------------

.. program:: waarp-manager db dump

Écrit le script SQL d’initialisation de la base de données sur la sortie
standard.

.. option:: -c FILE, --config=FILE

   **obligatoire**
   Le chemin vers le fichier de configuration à utiliser


Commande ``waarp-manager db migrate up``
----------------------------------------

.. program:: waarp-manager db migrate up

Met à jour la base de données en exécutant les différentes migrations
nécessaires pour atteindre la version voulue.


.. option:: -c FILE, --config=FILE

   Le chemin vers le fichier de configuration à utiliser.

.. option:: -t, --target=VERSION

   Permet de renseigner la version cible de la migration. Si la version cible
   est inférieure à la version actuelle de la base de données, rien n'est fait.

   Par défaut, la version cible est la dernière possible.

.. option:: -d, --dry-run

   Exécute les migrations en mode simulation, Rien n'est réellement fait.
   Cette commande permet de tester si les migrations peuvent se fire sans erreur
   avant de les exécuter réellement.


Commande ``waarp-manager db migrate down``
------------------------------------------

.. program:: waarp-manager db migrate down

Modifie la base de données en exécutant les différentes opérations nécessaires
pour ramener la base de données à une version antérieure.


.. option:: -c FILE, --config=FILE

   Le chemin vers le fichier de configuration à utiliser

.. option:: -t, --target=VERSION

   Permet de renseigner la version cible de la migration. Si la version cible
   est supérieure à la version actuelle de la base de données, rien n'est fait.

   Par défaut, Toutes les migrations sont défaites.

.. option:: -d, --dry-run

   Exécute les migrations en mode simulation, Rien n'est réellement fait.
   Cette commande permet de tester si les migrations peuvent se fire sans erreur
   avant de les exécuter réellement.


Commande ``waarp-manager backup import``
----------------------------------------

.. program:: waarp-manager backup import

Ajoute le modèle de flux décrit dans le fichier passé en paramètre à la
base de données.

Cette commande accepte les arguments suivants :

.. option:: -c FILE, --config=FILE

   Le chemin vers le fichier de configuration à utiliser

.. option:: -i FILE --imput=FILE

   Le chemin du fichier contenant le modèle de flux

.. option:: -t TYPE --type=TYPE

   Le type de donnée à importé (seul les modèle de flux sont supportés
   actuellement)

.. option:: -f FORMAT --format=FORMAT

   Le format du fichier source (seul YAML est supporté actuellement)

.. option:: --conflict=CONFLICT

   Le comportement à adopter si un conflit est détecté (error, ignore,
   overwrite)

.. option:: --UpdateRules

   Si le modèle de flux est mis à jour les règles des flux qui lui sont
   liés seront recalculées

Commande ``waarp-manager backup export``
----------------------------------------

.. program:: waarp-manager backup export

Ecrit dans un fichier passé en argument la description des modèle de
flux.

Cette commande accepte les arguments suivants :

.. option:: -c FILE, --config=FILE

   Le chemin vers le fichier de configuration à utiliser

.. option:: -o FILE --output=FILE

   Le fichier de destination de l'export

.. option:: -i INCLUDE --include=INCLUDE

   Le type de données à exporter (seul les modèle de flux sont supportés actuellement)

.. option:: -f FORMAT --format=FORMAT

   Le format du fichier de destination (seul YAML est supporté actuellement)
