# Ligne de commande

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

    waarp-manager <commande>

## Commande `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`

Démarre l’application Waarp Manager.

Cette commande accepte les arguments suivants :

-c FILE, --config=FILE

  obligatoire Le chemin vers le fichier de configuration à utiliser

## Commande `waarp-manager conf`

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

Cette commande accepte les arguments suivants :

-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).

## Commande `waarp-manager push`

Déploie la configuration depuis la ligne de commande.

Cette commande accepte les arguments suivants :

-c FILE, --config=FILE

  Le chemin vers le fichier de configuration à utiliser

## Commande `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 :

-c FILE, --config=FILE

  Le chemin vers le fichier de configuration à utiliser

## Commande `waarp-manager db dump`

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

-c FILE, --config=FILE

  obligatoire Le chemin vers le fichier de configuration à utiliser

## Commande `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.

-c FILE, --config=FILE

  Le chemin vers le fichier de configuration à utiliser.

-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.

-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`

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.

-c FILE, --config=FILE

  Le chemin vers le fichier de configuration à utiliser

-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.

-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`

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 :

-c FILE, --config=FILE

  Le chemin vers le fichier de configuration à utiliser

-i FILE --imput=FILE

  Le chemin du fichier contenant le modèle de flux

-t TYPE --type=TYPE

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

-f FORMAT --format=FORMAT

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

--conflict=CONFLICT

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

--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`

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

Cette commande accepte les arguments suivants :

-c FILE, --config=FILE

  Le chemin vers le fichier de configuration à utiliser

-o FILE --output=FILE

  Le fichier de destination de l’export

-i INCLUDE --include=INCLUDE

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

-f FORMAT --format=FORMAT

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