list-scriptx-plugins - List locally installed ScriptX plugins
This document describes version 0.002 of list-scriptx-plugins (from Perl distribution App-ScriptXUtils), released on 2020-10-01.
Usage:
% list-scriptx-plugins [--detail] [--dist-contains=s] [--dist-in-json=s] [--dist-in=s+] [--dist-is=s] [--dist-isnt=s] [--dist-max=s] [--dist-min=s] [--dist-not-contains=s] [--dist-not-in-json=s] [--dist-not-in=s+] [--dist-xmax=s] [--dist-xmin=s] [--dist=s] [--exclude-field=s+] [--exclude-fields-json=s] [--field=s+] [--fields-json=s] [--format=name] [--json] [-l] [--(no)naked-res] [--no-detail] [--no-random] [--nodetail] [--norandom] [--page-result[=program]] [--plugin-contains=s] [--plugin-in-json=s] [--plugin-in=s+] [--plugin-is=s] [--plugin-isnt=s] [--plugin-max=s] [--plugin-min=s] [--plugin-not-contains=s] [--plugin-not-in-json=s] [--plugin-not-in=s+] [--plugin-xmax=s] [--plugin-xmin=s] [--plugin=s] [--random] [--result-limit=s] [--result-start=s] [--sort-json=s] [--sort=s+] [--summary-contains=s] [--summary-in-json=s] [--summary-in=s+] [--summary-is=s] [--summary-isnt=s] [--summary-max=s] [--summary-min=s] [--summary-not-contains=s] [--summary-not-in-json=s] [--summary-not-in=s+] [--summary-xmax=s] [--summary-xmin=s] [--summary=s] [--with-field-names] [--without-field-names] [query]
REPLACE ME
* marks required options.
*
Return array of full records instead of just ID fields.
By default, only the key (ID) field is returned per result entry.
Select fields to return.
Can be specified multiple times.
Select fields to return (JSON-encoded).
See --exclude-field.
--exclude-field
See --field.
--field
Return field names in each record (as hash/associative array).
When enabled, function will return each record as hash/associative array (field name => value pairs). Otherwise, function will return each record as list/array (field value, field value, ...).
Only return records where the 'dist' field contains specified text.
Only return records where the 'dist' field is in the specified values (JSON-encoded).
See --dist-in.
--dist-in
Only return records where the 'dist' field is in the specified values.
Only return records where the 'dist' field equals specified value.
Only return records where the 'dist' field does not equal specified value.
Only return records where the 'dist' field is less than or equal to specified value.
Only return records where the 'dist' field is greater than or equal to specified value.
Only return records where the 'dist' field does not contain specified text.
Only return records where the 'dist' field is not in the specified values (JSON-encoded).
See --dist-not-in.
--dist-not-in
Only return records where the 'dist' field is not in the specified values.
Only return records where the 'dist' field is less than specified value.
Only return records where the 'dist' field is greater than specified value.
Only return records where the 'plugin' field contains specified text.
Only return records where the 'plugin' field is in the specified values (JSON-encoded).
See --plugin-in.
--plugin-in
Only return records where the 'plugin' field is in the specified values.
Only return records where the 'plugin' field equals specified value.
Only return records where the 'plugin' field does not equal specified value.
Only return records where the 'plugin' field is less than or equal to specified value.
Only return records where the 'plugin' field is greater than or equal to specified value.
Only return records where the 'plugin' field does not contain specified text.
Only return records where the 'plugin' field is not in the specified values (JSON-encoded).
See --plugin-not-in.
--plugin-not-in
Only return records where the 'plugin' field is not in the specified values.
Only return records where the 'plugin' field is less than specified value.
Only return records where the 'plugin' field is greater than specified value.
Only return records where the 'summary' field contains specified text.
Only return records where the 'summary' field is in the specified values (JSON-encoded).
See --summary-in.
--summary-in
Only return records where the 'summary' field is in the specified values.
Only return records where the 'summary' field equals specified value.
Only return records where the 'summary' field does not equal specified value.
Only return records where the 'summary' field is less than or equal to specified value.
Only return records where the 'summary' field is greater than or equal to specified value.
Only return records where the 'summary' field does not contain specified text.
Only return records where the 'summary' field is not in the specified values (JSON-encoded).
See --summary-not-in.
--summary-not-in
Only return records where the 'summary' field is not in the specified values.
Only return records where the 'summary' field is less than specified value.
Only return records where the 'summary' field is greater than specified value.
Search.
Return records in random order.
Order records according to certain field(s) (JSON-encoded).
See --sort.
--sort
Order records according to certain field(s).
A list of field names separated by comma. Each field can be prefixed with '-' to specify descending order instead of the default ascending.
Choose output format, e.g. json, text.
Default value:
undef
Set output format to json.
When outputing as JSON, strip result envelope.
0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Filter output through a pager.
Only return a certain number of records.
Only return starting from the n'th record.
1
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C list-scriptx-plugins list-scriptx-plugins
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete list-scriptx-plugins 'p/*/`list-scriptx-plugins`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-ScriptXUtils.
Source repository is at https://github.com/perlancar/perl-App-ScriptXUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-ScriptXUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020, 2019 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::ScriptXUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::ScriptXUtils
CPAN shell
perl -MCPAN -e shell install App::ScriptXUtils
For more information on module installation, please visit the detailed CPAN module installation guide.