[github/wallabag/wallabag.git] / docs / en / developer / console_commands.rst

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.
Commit	Line	Data
c613df0e TC	1	Console Commands
	2	================
	3
	4	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.
	5
	6	Each 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
	12	Notable 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.