aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/en/developer/console_commands.rst30
-rw-r--r--docs/fr/developer/console_commands.rst30
2 files changed, 60 insertions, 0 deletions
diff --git a/docs/en/developer/console_commands.rst b/docs/en/developer/console_commands.rst
new file mode 100644
index 00000000..85a8a092
--- /dev/null
+++ b/docs/en/developer/console_commands.rst
@@ -0,0 +1,30 @@
1Console Commands
2================
3
4wallabag 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.
5
6Each command has a help accessible through `bin/console help %command%`.
7
8.. note::
9
10 If you're in a production environment, remember to add `-e prod` to each command.
11
12Notable commands
13----------------
14
15* `assets:install`: May be helpful if assets are missing.
16* `cache:clear`: should be run after each update (included in `make update`).
17* `doctrine:migrations:status`: Output the status of your database migrations.
18* `fos:user:activate`: Manually activate an user.
19* `fos:user:change-password`: Change a password for an user.
20* `fos:user:create`: Create an user.
21* `fos:user:deactivate`: Deactivate an user (not deleted).
22* `fos:user:demote`: Removes a role from an user, typically admin rights.
23* `fos:user:promote`: Adds a role to an user, typically admin rights.
24* `rabbitmq:*`: May be useful if you're using RabbitMQ.
25* `wallabag:clean-duplicates`: Removes all entry duplicates for one user or all users
26* `wallabag:export`: Exports all entries for an user. You can choose the output path of the file.
27* `wallabag:import`: Import entries to different formats to an user account.
28* `wallabag:import:redis-worker`: Useful if you use Redis.
29* `wallabag:install`: (re)Install wallabag
30* `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 00000000..1b222b32
--- /dev/null
+++ b/docs/fr/developer/console_commands.rst
@@ -0,0 +1,30 @@
1Actions en ligne de commande
2============================
3
4wallabag 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.
5
6Chaque commande a une aide correspondante accessible via `bin/console help %command%`.
7
8.. note::
9
10 Si vous êtes dans un environnement de production, souvenez-vous d'ajouter `-e prod` à chaque commande.
11
12Commandes notables
13------------------
14
15* `assets:install`: Peut-être utile si les *assets* sont manquants.
16* `cache:clear`: doit être exécuté après chaque mise à jour (appelé dans `make update`).
17* `doctrine:migrations:status`: Montre le statut de vos migrations de vos bases de données.
18* `fos:user:activate`: Activer manuellement un utilisateur.
19* `fos:user:change-password`: Changer le mot de passe pour un utilisateur.
20* `fos:user:create`: Créer un utilisateur.
21* `fos:user:deactivate`: Désactiver un utilisateur (non supprimé).
22* `fos:user:demote`: Supprimer un rôle d'un utilisateur, typiquement les droits d'administration.
23* `fos:user:promote`: Ajoute un rôle à un utilisateur, typiquement les droits d'administration.
24* `rabbitmq:*`: Peut-être utile si vous utilisez RabbitMQ.
25* `wallabag:clean-duplicates`: Supprime tous les articles dupliqués pour un utilisateur ou bien tous.
26* `wallabag:export`: Exporte tous les articles pour un utilisateur. Vous pouvez choisir le chemin du fichier exporté.
27* `wallabag:import`: Importe les articles en différents formats dans un compte utilisateur.
28* `wallabag:import:redis-worker`: Utile si vous utilisez Redis.
29* `wallabag:install`: (ré)Installer wallabag
30* `wallabag:tag:all`: Tagger tous les articles pour un utilisateur ou une utilisatrice en utilisant ses règles de tags automatiques.