list-currencies - List currencies
This document describes version 0.004 of list-currencies (from Perl distribution App-LocaleCodesUtils), released on 2023-08-06.
list-currencies --help (or -h, -?)
list-currencies --version (or -v)
list-currencies [--code-contains=str] [(--code-in=str)+|--code-in-json=json] [--code-is=str] [--code-isnt=str] [--code-max=str] [--code-min=str] [--code-not-contains=str] [(--code-not-in=str)+|--code-not-in-json=json] [--code-xmax=str] [--code-xmin=str] [--code=str] [--detail|-l|--no-detail|--nodetail] [(--exclude-field=str)+|--exclude-fields-json=json] [(--field=str)+|--fields-json=json] [--format=name|--json] [--(no)naked-res] [--name-contains=str] [(--name-in=str)+|--name-in-json=json] [--name-is=str] [--name-isnt=str] [--name-max=str] [--name-min=str] [--name-not-contains=str] [(--name-not-in=str)+|--name-not-in-json=json] [--name-xmax=str] [--name-xmin=str] [--name=str] [--page-result[=program]|--view-result[=program]] [--query-boolean=str|--and|--or] [(--query=str)+|--queries-json=json|(-q=str)+] [--random|--no-random|--norandom] [--result-limit=int] [--result-start=int] [(--sort=str)+|--sort-json=json] [--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 'code' field contains specified text.
Only return records where the 'code' field is in the specified values (JSON-encoded).
See --code-in.
--code-in
Only return records where the 'code' field is in the specified values.
Only return records where the 'code' field equals specified value.
Only return records where the 'code' field does not equal specified value.
Only return records where the 'code' field is less than or equal to specified value.
Only return records where the 'code' field is greater than or equal to specified value.
Only return records where the 'code' field does not contain specified text.
Only return records where the 'code' field is not in the specified values (JSON-encoded).
See --code-not-in.
--code-not-in
Only return records where the 'code' field is not in the specified values.
Only return records where the 'code' field is less than specified value.
Only return records where the 'code' field is greater than specified value.
Only return records where the 'name' field contains specified text.
Only return records where the 'name' field is in the specified values (JSON-encoded).
See --name-in.
--name-in
Only return records where the 'name' field is in the specified values.
Only return records where the 'name' field equals specified value.
Only return records where the 'name' field does not equal specified value.
Only return records where the 'name' field is less than or equal to specified value.
Only return records where the 'name' field is greater than or equal to specified value.
Only return records where the 'name' field does not contain specified text.
Only return records where the 'name' field is not in the specified values (JSON-encoded).
See --name-not-in.
--name-not-in
Only return records where the 'name' field is not in the specified values.
Only return records where the 'name' field is less than specified value.
Only return records where the 'name' field is greater than specified value.
Shortcut for --query-boolean=and.
See --query-boolean.
--query-boolean
Shortcut for --query-boolean=or.
Search (JSON-encoded).
See --query.
--query
Can also be specified as the 1st command-line argument and onwards.
Whether records must match all search queries ('and') or just one ('or').
Default value:
"and"
Valid values:
["and","or"]
If set to and, all queries must match; if set to or, only one query should match. See the queries option for more details on searching.
and
or
queries
Search.
This will search all searchable fields with one or more specified queries. Each query can be in the form of -FOO (dash prefix notation) to require that the fields do not contain specified string, or /FOO/ to use regular expression. All queries must match if the query_boolean option is set to and; only one query should match if the query_boolean option is set to or.
-FOO
/FOO/
query_boolean
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.
undef
Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.
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:
--naked-res
[1,2,3]
Filter output through a pager.
This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.
less
View output using a viewer.
This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.
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-currencies list-currencies
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-currencies 'p/*/`list-currencies`/'
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-LocaleCodesUtils.
Source repository is at https://github.com/perlancar/perl-App-LocaleCodesUtils.
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2023, 2020, 2018 by perlancar <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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-LocaleCodesUtils
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.
To install App::LocaleCodesUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::LocaleCodesUtils
CPAN shell
perl -MCPAN -e shell install App::LocaleCodesUtils
For more information on module installation, please visit the detailed CPAN module installation guide.