From c613df0e25e9628a465758388c440da069623fd4 Mon Sep 17 00:00:00 2001
From: Thomas Citharel <tcit@tcit.fr>
Date: Mon, 1 May 2017 13:30:00 +0200
Subject: [PATCH] Add docs for cli commands

Signed-off-by: Thomas Citharel <tcit@tcit.fr>
---
 docs/en/developer/console_commands.rst | 30 ++++++++++++++++++++++++++
 docs/fr/developer/console_commands.rst | 30 ++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)
 create mode 100644 docs/en/developer/console_commands.rst
 create mode 100644 docs/fr/developer/console_commands.rst

diff --git a/docs/en/developer/console_commands.rst b/docs/en/developer/console_commands.rst
new file mode 100644
index 000000000..85a8a092c
--- /dev/null
+++ b/docs/en/developer/console_commands.rst
@@ -0,0 +1,30 @@
+Console Commands
+================
+
+wallabag has a number of CLI commands to manage a number of tasks. You can list all the commands by executing `bin/console` in the wallabag folder.
+
+Each command has a help accessible through `bin/console help %command%`.
+
+.. note::
+
+    If you're in a production environment, remember to add `-e prod` to each command.
+
+Notable commands
+----------------
+
+* `assets:install`: May be helpful if assets are missing.
+* `cache:clear`: should be run after each update (included in `make update`).
+* `doctrine:migrations:status`: Output the status of your database migrations.
+* `fos:user:activate`: Manually activate an user.
+* `fos:user:change-password`: Change a password for an user.
+* `fos:user:create`: Create an user.
+* `fos:user:deactivate`: Deactivate an user (not deleted).
+* `fos:user:demote`: Removes a role from an user, typically admin rights.
+* `fos:user:promote`: Adds a role to an user, typically admin rights.
+* `rabbitmq:*`: May be useful if you're using RabbitMQ.
+* `wallabag:clean-duplicates`: Removes all entry duplicates for one user or all users
+* `wallabag:export`: Exports all entries for an user. You can choose the output path of the file.
+* `wallabag:import`: Import entries to different formats to an user account.
+* `wallabag:import:redis-worker`: Useful if you use Redis.
+* `wallabag:install`: (re)Install wallabag
+* `wallabag:tag:all`: Tag all entries for an user using his/her tagging rules.
diff --git a/docs/fr/developer/console_commands.rst b/docs/fr/developer/console_commands.rst
new file mode 100644
index 000000000..1b222b326
--- /dev/null
+++ b/docs/fr/developer/console_commands.rst
@@ -0,0 +1,30 @@
+Actions en ligne de commande
+============================
+
+wallabag a un certain nombre de commandes CLI pour effectuer des tâches. Vous pouvez lister toutes les commandes en exécutant `bin/console` dans le dossier d'installation de wallabag.
+
+Chaque commande a une aide correspondante accessible via `bin/console help %command%`.
+
+.. note::
+
+    Si vous êtes dans un environnement de production, souvenez-vous d'ajouter `-e prod` à chaque commande.
+
+Commandes notables
+------------------
+
+* `assets:install`: Peut-être utile si les *assets* sont manquants.
+* `cache:clear`: doit être exécuté après chaque mise à jour (appelé dans `make update`).
+* `doctrine:migrations:status`: Montre le statut de vos migrations de vos bases de données.
+* `fos:user:activate`: Activer manuellement un utilisateur.
+* `fos:user:change-password`: Changer le mot de passe pour un utilisateur.
+* `fos:user:create`: Créer un utilisateur.
+* `fos:user:deactivate`: Désactiver un utilisateur (non supprimé).
+* `fos:user:demote`: Supprimer un rôle d'un utilisateur, typiquement les droits d'administration.
+* `fos:user:promote`: Ajoute un rôle à un utilisateur, typiquement les droits d'administration.
+* `rabbitmq:*`: Peut-être utile si vous utilisez RabbitMQ.
+* `wallabag:clean-duplicates`: Supprime tous les articles dupliqués pour un utilisateur ou bien tous.
+* `wallabag:export`: Exporte tous les articles pour un utilisateur. Vous pouvez choisir le chemin du fichier exporté.
+* `wallabag:import`: Importe les articles en différents formats dans un compte utilisateur.
+* `wallabag:import:redis-worker`: Utile si vous utilisez Redis.
+* `wallabag:install`: (ré)Installer wallabag
+* `wallabag:tag:all`: Tagger tous les articles pour un utilisateur ou une utilisatrice en utilisant ses règles de tags automatiques.