Commit 9c51ca64 authored by Kristina Hoeppner's avatar Kristina Hoeppner

admin/cli: Add details on how to find help on the scripts

parent d599fcc1
......@@ -10,6 +10,11 @@ Command-line interfaces (CLI)
Command-line interfaces (CLI) allow advanced users to interact with Mahara through the command line or terminal rather than through a graphical interface. That can speed up certain actions or make them easier to execute.
.. note::
You can view help information on the individual commands that are available for each script:
``sudo -u www-data php htdocs/admin/cli/[file name of the script].php -h``
.. index::
single: CLI; Delete certain groups in bulk
single: New in Mahara 18.10; Delete certain groups in bulk via CLI
......@@ -25,7 +30,7 @@ If you have a large site and deleted a lot of users, you may also wish to clean
* and delete all groups that have only site administrators as members;
* and / or delete only groups associated with a certain institution.
Execute the script with the following command:
Execute the script with the following command. A dry run is made by default so that no data is deleted by accident.
``sudo -u www-data php htdocs/admin/cli/delete_inactive_groups.php``
......@@ -43,11 +48,9 @@ If you want to delete users in bulk from the site without needing to go to the a
* delete all users that have never logged in, i.e. that were created manually, via CSV file, or an automated process;
* and / or delete all users that have not logged in since a certain date;
* and / or delete only those users from a specific institution;
* delete users that are members of a spefic group.
You can conduct a dry run first to ensure that only the correct people would be deleted.
* delete users that are members of a specific group.
Execute the script with the following command:
Execute the script with the following command. A dry run is made by default so that no data is deleted by accident.
``sudo -u www-data php htdocs/admin/cli/delete_inactive_users.php``
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment