add console command docs

This commit is contained in:
Antonio Ramirez
2017-06-13 10:56:06 +02:00
parent d4882ad2fa
commit 2d6d6d968b
5 changed files with 82 additions and 3 deletions

View File

@ -1 +1,7 @@
Separate Frontend and Backend Sessions
======================================
- TODO
© [2amigos](http://www.2amigos.us/) 2013-2017

View File

@ -0,0 +1,62 @@
Console Commands
================
The module comes with a set of console commands to facilitate some of the most common actions during development time:
- `user/create` to create a new user
- `user/confirm` to confirm a user
- `user/delete` to delete a user
- `user/password` to update a user's password
Configuration
-------------
To enable the commands add the following configuration details to your console config of your application:
```php
// ...
'modules' => [
'user' => Da\User\Module::class,
]
```
How to Use Them
---------------
#### user/create
If password is not set, it will automatically generate it. The newly created user will receive an email message with its
new credentials.
```php
./yii user/create <email> <username> [password]
```
#### user/confirm
You can confirm a user whether by using its email or username.
```php
./yii user/confirm <email|username>
```
#### user/delete
You can delete a user whether by using its email or username.
```php
./yii user/delete <email|username>
```
#### user/delete
You can update a user's password whether by using its email or username.
```php
./yii user/password <email|username> <password>
```
© [2amigos](http://www.2amigos.us/) 2013-2017