diff options
author | Thomas Citharel <tcit@tcit.fr> | 2017-05-01 13:30:00 +0200 |
---|---|---|
committer | Thomas Citharel <tcit@tcit.fr> | 2017-05-01 13:30:00 +0200 |
commit | c613df0e25e9628a465758388c440da069623fd4 (patch) | |
tree | e87655358a2c826accf243d437c4a0859b9fa329 /docs/en | |
parent | 3d57d625f88203ca526adf7729b93237ecd13242 (diff) | |
download | wallabag-c613df0e25e9628a465758388c440da069623fd4.tar.gz wallabag-c613df0e25e9628a465758388c440da069623fd4.tar.zst wallabag-c613df0e25e9628a465758388c440da069623fd4.zip |
Add docs for cli commands
Signed-off-by: Thomas Citharel <tcit@tcit.fr>
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/console_commands.rst | 30 |
1 files changed, 30 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 @@ | |||
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. | ||