CakeDC / users

Users Plugin for CakePHP
https://www.cakedc.com
Other
520 stars 296 forks source link

User Console/Shell Commands Not Documented #1036

Closed ravage84 closed 1 year ago

ravage84 commented 1 year ago

While researching the Users plugin, I just noticedd that the various console/shell commnands the plugin provides are not documented at all.

This should be improved. At least by mentioning them and may be listing the available commands by showing the output of the CLI.

/path/to/app> php bin/cake.php 
No command provided. Choose one of the available commands.

Current Paths:

* app:  src\
* root: /path/to/app
* core: /path/to/app/vendor/cakephp/cakephp/

Available Commands:

[...]

CakeDC/Users:
 - users

[...]

To run a command, type `cake command_name [args|options]`
To get help on a specific command, type `cake command_name --help`
/path/to/app> php bin/cake.php users --help
Utilities for CakeDC Users Plugin

Usage:
cake users [subcommand] [options]

Subcommands:

activate_user        Einen spezifischen Benutzer aktivieren
add_superuser        Neuen Superadministrator zu Testzwecken erstellen
add_user             Neuen Benutzer hinzufügen
change_api_token     Ändere den Api Token für ein spezifischen Benutzers
change_role          Rolle für einen spezifischen Benutzer ändern
deactivate_user      Spezifischen Benutzer deaktivieren
delete_user          Spezifischen Benutzer löschen
password_email       Passwort via E-Mail zurücksetzen
reset_all_passwords  Passwort für alle Benutzer zurücksetzen
reset_password       Passwort für einen spezifischen Benutzer
                     zurücksetzen

To see help on a subcommand use `cake users [subcommand] --help`

Options:

--email, -e     The email for the new user
--help, -h      Display this help.
--password, -p  The password for the new user
--quiet, -q     Enable quiet output.
--role, -r      The role for the new user
--username, -u  The username for the new user
--verbose, -v   Enable verbose output.
rochamarcelo commented 1 year ago

The documentation was updated on branch 12.next-cake5 https://github.com/CakeDC/users/blob/12.next-cake5/Docs/Documentation/Commands.md

ravage84 commented 1 year ago

@rochamarcelo thank you for the documentation.