NAME
App::ScriptXUtils - Collection of CLI utilities for ScriptX
VERSION
This document describes version 0.002 of App::ScriptXUtils (from Perl
distribution App-ScriptXUtils), released on 2020-10-01.
SYNOPSIS
This distribution provides the following command-line utilities related
to ScriptX:
* detect-scriptx-script
* dump-scriptx-script
* list-scriptx-plugins
FUNCTIONS
list_scriptx_plugins
Usage:
list_scriptx_plugins(%args) -> [status, msg, payload, meta]
List locally installed ScriptX plugins.
REPLACE ME
This function is not exported.
Arguments ('*' denotes required arguments):
* detail => *bool* (default: 0)
Return array of full records instead of just ID fields.
By default, only the key (ID) field is returned per result entry.
* dist => *str*
Only return records where the 'dist' field equals specified value.
* dist.contains => *str*
Only return records where the 'dist' field contains specified text.
* dist.in => *array[str]*
Only return records where the 'dist' field is in the specified
values.
* dist.is => *str*
Only return records where the 'dist' field equals specified value.
* dist.isnt => *str*
Only return records where the 'dist' field does not equal specified
value.
* dist.max => *str*
Only return records where the 'dist' field is less than or equal to
specified value.
* dist.min => *str*
Only return records where the 'dist' field is greater than or equal
to specified value.
* dist.not_contains => *str*
Only return records where the 'dist' field does not contain
specified text.
* dist.not_in => *array[str]*
Only return records where the 'dist' field is not in the specified
values.
* dist.xmax => *str*
Only return records where the 'dist' field is less than specified
value.
* dist.xmin => *str*
Only return records where the 'dist' field is greater than specified
value.
* exclude_fields => *array[str]*
Select fields to return.
* fields => *array[str]*
Select fields to return.
* plugin => *str*
Only return records where the 'plugin' field equals specified value.
* plugin.contains => *str*
Only return records where the 'plugin' field contains specified
text.
* plugin.in => *array[str]*
Only return records where the 'plugin' field is in the specified
values.
* plugin.is => *str*
Only return records where the 'plugin' field equals specified value.
* plugin.isnt => *str*
Only return records where the 'plugin' field does not equal
specified value.
* plugin.max => *str*
Only return records where the 'plugin' field is less than or equal
to specified value.
* plugin.min => *str*
Only return records where the 'plugin' field is greater than or
equal to specified value.
* plugin.not_contains => *str*
Only return records where the 'plugin' field does not contain
specified text.
* plugin.not_in => *array[str]*
Only return records where the 'plugin' field is not in the specified
values.
* plugin.xmax => *str*
Only return records where the 'plugin' field is less than specified
value.
* plugin.xmin => *str*
Only return records where the 'plugin' field is greater than
specified value.
* query => *str*
Search.
* random => *bool* (default: 0)
Return records in random order.
* result_limit => *int*
Only return a certain number of records.
* result_start => *int* (default: 1)
Only return starting from the n'th record.
* sort => *array[str]*
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.
* summary => *str*
Only return records where the 'summary' field equals specified
value.
* summary.contains => *str*
Only return records where the 'summary' field contains specified
text.
* summary.in => *array[str]*
Only return records where the 'summary' field is in the specified
values.
* summary.is => *str*
Only return records where the 'summary' field equals specified
value.
* summary.isnt => *str*
Only return records where the 'summary' field does not equal
specified value.
* summary.max => *str*
Only return records where the 'summary' field is less than or equal
to specified value.
* summary.min => *str*
Only return records where the 'summary' field is greater than or
equal to specified value.
* summary.not_contains => *str*
Only return records where the 'summary' field does not contain
specified text.
* summary.not_in => *array[str]*
Only return records where the 'summary' field is not in the
specified values.
* summary.xmax => *str*
Only return records where the 'summary' field is less than specified
value.
* summary.xmin => *str*
Only return records where the 'summary' field is greater than
specified value.
* with_field_names => *bool*
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, ...).
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200
means OK, 4xx caller error, 5xx function error). Second element (msg) is
a string containing error message, or 'OK' if status is 200. Third
element (payload) is optional, the actual result. Fourth element (meta)
is called result metadata and is optional, a hash that contains extra
information.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at
SOURCE
Source repository is at
BUGS
Please report any bugs or feature requests on the bugtracker website
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.
SEE ALSO
ScriptX
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
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.