Display the list of OL Hub modules
The ol list modules command lists the name and description of the modules you have in your OL Hub account. You have the option to display additional properties such as module ID and the number of assets in the module.
The command is useful when you have to populate the value of the --module option in the ol clone module command. You can also find the command handy when you execute the ol create project command, and you want to know what modules are available for your new project.
By default, when you execute the ol list modules command, all modules in your account will be listed. However, if you have many modules, the list may be too long. To avoid that, you can paginate through the module list by using the --offset and the --limit options. In the --limit option, you set the number of modules included in the list, and in the --offset option the list starting point.
For example, if your account contains approximately 40 modules and you want your list to start from the 21st module, type the following command: ol list modules --offset 20. If you want to limit this list to only 10 projects, type ol list modules --offset 20 --limit 10. See more examples in the Examples section below.
Rules
- Login to the OL Hub
Syntax
ol list modules [OPTIONS]
Options
--additional, -a
Display additional properties for each module in the list (module id, modified by, last modified, number of assets).
--limit, -l
Limit the number of modules listed in the module list.
--offset, -o
Set the module list starting point.
--filter, -f
The regular expression to filter the list by module name
Examples
Listing the modules
temp> ol list modules
temp$ ol list modules
Listing the first 10 modules
temp> ol list modules --limit 10
temp$ ol list modules --limit 10
Listing the modules from the 11th module onwards
temp> ol list modules --offset 10
temp$ ol list modules --offset 10
Listing the 11th to the 20th module
temp> ol list modules --offset 10 --limit 10
temp$ ol list modules --offset 10 --limit 10