—

              
#!perl
# Note: This script is a CLI for Riap function /IOD/Counter/Simple/get_iod_counter
# and generated automatically using Perinci::CmdLine::Gen version 0.498
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2021-06-22'; # DATE
our $DIST = 'App-IODCounterSimpleUtils'; # DIST
our $VERSION = '0.001'; # VERSION
use 5.010001;
use strict;
use warnings;
use Perinci::CmdLine::Any;
my $cmdline = Perinci::CmdLine::Any->new(
    url => "/IOD/Counter/Simple/get_iod_counter",
    program_name => "get-iod-counter",
);
$cmdline->run;
# ABSTRACT: Get the current value of a counter in an IOD/INI file
# PODNAME: get-iod-counter
__END__
HideShow 280 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
get-iod-counter - Get the current value of a counter in an IOD/INI file
=head1 VERSION
This document describes version 0.001 of get-iod-counter (from Perl distribution App-IODCounterSimpleUtils), released on 2021-06-22.
=head1 SYNOPSIS
Usage:
 % get-iod-counter [--config-path=path | -c] [--config-profile=profile |
     -P] [--dry-run | -n] [--format=name] [--json] [--(no)naked-res]
     [--no-config | -C] [--no-env] [--page-result[=program]] [--section=s]
     [--view-result[=program]] [counter] [path]
=head1 DESCRIPTION
Undef (exit code 1 in CLI) can be returned if counter does not exist.
=head1 OPTIONS
C<*> marks required options.
=head2 Main options
=over
=item B<--counter>=I<s>
Counter name, defaults to "default" if not specified.
Note that counter name must be valid IOD/INI parameter name.
Can also be specified as the 1st command-line argument.
=item B<--path>=I<s>
IOD/INI file.
If not specified, will default to $HOME/counter.iod. If file does not exist,
will be created.
Can also be specified as the 2nd command-line argument.
=item B<--section>=I<s>
INI section name where the counters are put.
Default value:
 "counter"
Counters are put as parameters in a specific section in the IOD/INI file, e.g.:
    [counter]
    counter1=1
    counter2=5
This argument customizes the section name.
=back
=head2 Configuration options
=over
=item B<--config-path>=I<s>, B<-c>
Set path to configuration file.
=item B<--config-profile>=I<s>, B<-P>
Set configuration profile to use.
=item B<--no-config>, B<-C>
Do not use any configuration file.
=back
=head2 Environment options
=over
=item B<--no-env>
Do not read environment for default options.
=back
=head2 Output options
=over
=item B<--format>=I<s>
Choose output format, e.g. json, text.
Default value:
 undef
=item B<--json>
Set output format to json.
=item B<--naked-res>
When outputing as JSON, strip result envelope.
Default value:
 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]
=item B<--page-result>
Filter output through a pager.
=item B<--view-result>
View output using a viewer.
=back
=head2 Other options
=over
=item B<--dry-run>, B<-n>
Run in simulation mode (also via DRY_RUN=1).
=item B<--help>, B<-h>, B<-?>
Display help message and exit.
=item B<--version>, B<-v>
Display program's version and exit.
=back
=head1 COMPLETION
This script has shell tab completion capability with support for several
shells.
=head2 bash
To activate bash completion for this script, put:
 complete -C get-iod-counter get-iod-counter
in your bash startup (e.g. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.
=head2 tcsh
To activate tcsh completion for this script, put:
 complete get-iod-counter 'p/*/`get-iod-counter`/'
in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).
=head2 other shells
For fish and zsh, install L<shcompgen> as described above.
=head1 CONFIGURATION FILE
This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F<~/.config/get-iod-counter.conf>, F<~/get-iod-counter.conf>, or F</etc/get-iod-counter.conf>.
All found files will be read and merged.
To disable searching for configuration files, pass C<--no-config>.
You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.
You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program matches.
You can also filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...]>. If you only want a section to be read when the value of an environment variable equals some string: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal some string: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when the value of an environment variable includes some string: C<[env=HOSTNAME*=server ...]> or C<[SOMESECTION env=HOSTNAME*=server ...]>. If you only want a section to be read when the value of an environment variable does not include some string: C<[env=HOSTNAME!*=server ...]> or C<[SOMESECTION env=HOSTNAME!*=server ...]>. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:
 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
  
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2
  
which is equivalent to setting C<< -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2 >>.
List of available configuration parameters:
 counter (see --counter)
 format (see --format)
 naked_res (see --naked-res)
 path (see --path)
 section (see --section)
=head1 ENVIRONMENT
=head2 GET_IOD_COUNTER_OPT => str
Specify additional command-line options.
=head1 FILES
F<~/.config/get-iod-counter.conf>
F<~/get-iod-counter.conf>
F</etc/get-iod-counter.conf>
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-IODCounterSimpleUtils>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-IODCounterSimpleUtils>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-IODCounterSimpleUtils>
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.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2021 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.
=cut