From 5cd9aa4eca47ce51cb94f9a8bc5f3dbe2bb1700a Mon Sep 17 00:00:00 2001 From: Tomasz Muras Date: Sat, 23 Mar 2024 12:00:11 +0100 Subject: [PATCH] Documentation update with course-last-visited --- www/_site/commands/index.html | 111 +++++++++++++++++++++++++++++++++- 1 file changed, 108 insertions(+), 3 deletions(-) diff --git a/www/_site/commands/index.html b/www/_site/commands/index.html index 84ac3212..5124220e 100755 --- a/www/_site/commands/index.html +++ b/www/_site/commands/index.html @@ -990,6 +990,16 @@

course-info

moosh course-info -c 2  
 
+ +

course-last-visited

+ +

Shows how many hours ago any user has last visited the course.

+ +

Example 1: How many hours ago course ID 2 was visited.

+ +
moosh course-last-visited 2
+
+

course-list

@@ -1015,6 +1025,21 @@

course-list

moosh course-list -c 1 -e yes
 
+ +

course-move

+ +

Moves one or more courses into a given category.

+ +

Example 1: Move the course with ID 5 into the category with ID 2.

+ +
moosh course-move 5 2
+
+ +

Example 2: Move courses with IDs 5, 6, 7, and 10 into the category with ID 2.

+ +
moosh course-move 5,6,7,10 2
+
+

course-reset

@@ -1993,7 +2018,8 @@

plugin-download

Download plugin for a given Moodle version to current directory. Requires plugin short name, and optional Moodle version. -You can obtain avalible plugins names by using `plugin-list -n' command

+You can obtain avalible plugins names by using `plugin-list -n' command. +You may specify proxy server with command line option or define ENV variable http_proxy.

Example 1: Download block_fastnav for moodle 3.9 into ./block_fastnav.zip

@@ -2013,7 +2039,8 @@

plugin-download

plugin-install

-

Download and install plugin. Requires plugin short name, and optional version. You can obtain those data by using `plugin-list -v' command.

+

Download and install plugin. Requires plugin short name, and optional version. You can obtain those data by using `plugin-list -v' command. +You may specify proxy server with command line option or define ENV variable http_proxy.

Example 1: install a specific version

@@ -2028,7 +2055,8 @@

plugin-install

plugin-list

-

List Moodle plugins filtered on given query. Returns plugin full name, short name, available Moodle versions and short description.

+

List Moodle plugins filtered on given query. Returns plugin full name, short name, available Moodle versions and short description. +You may specify proxy server with command line option or define ENV variable http_proxy.

Example 1: list all plugins available on https://moodle.org/plugins

@@ -2201,6 +2229,46 @@

role-delete

moosh role-delete -i 10
 
+ +

role-export

+ +

Export role data, including permissions, role overrides, allow view settings and other related data.

+ +

Example 1: Export specific role data to a an output XML file.

+ +
moosh role-export -f target_file.xml ROLENAME
+
+ +

Example 2: Export specific role data, generate output XML export and print to stdout.

+ +
moosh role-export ROLENAME
+
+ +

Example 3: Format XML with whitespaces (pretty format) and output XML contents to stdout.

+ +
moosh role-export --pretty ROLENAME
+
+ + +

role-import

+ +

Import role data from an XML file that was produced either by role-export command or Moodle permissions UI.

+ +

Example 1: Import role from a specific XML file.

+ +
moosh role-import -f source_file.xml
+
+ +

Example 2: Import role by reading XML data from STDIN.

+ +
moosh role-import --stdin < source_file.xml
+
+ +

You can either load XML data from a file or from STDIN. +If XML defines an existing rolename then this command will sync changes to an existing role. +If role does not exist and archetype is defined this command will create a new role with archetype defaults and xml permissions. +If neither role nor archetype exist the new role will be created with INHERITED permissions defaults.

+

role-list

@@ -2389,6 +2457,43 @@

top

watch moosh top
 
+ +

user-online

+ +

Display currently online users in a simple table. In a contrast to TOP command this command uses Fetcher API and queries user table instead of standard log store. +Available options:

+ + + + + + + + + + + + + + + + + + + + + + +
Option Description
-t, --time Show users online in last N seconds. Default 15 sec.
-l, --limit Show maximum number of users. If empty all users are fetched.
-e, --hideheader Print header with table column names.
+ + +

Use linux "watch" command to refresh screen periodically.

+ +

Example: Show online users in last 5 minutes and refresh list every 5 seconds.

+ +
watch moosh user-online -t 300
+
+

user-assign-system-role