The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

#!perl
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2020-10-10'; # DATE
our $DIST = 'App-reposdb'; # DIST
our $VERSION = '0.007'; # VERSION
use 5.010001;
use strict;
my $prefix = '/App/reposdb/';
Perinci::CmdLine::Any->new(
url => $prefix,
subcommands => {
ls => {url => "${prefix}list_repos"},
touch => {url => "${prefix}touch_repo"},
tag => {url => "${prefix}add_repo_tag"},
'remove-tag' => {url => "${prefix}remove_repo_tag"},
'remove-all-tags' => {url => "${prefix}remove_all_repo_tags"},
get => {url => "${prefix}get_repo_metadata"},
},
log => 1,
)->run;
1;
# ABSTRACT: Manipulate repos.db
# PODNAME: reposdb
__END__
=pod
=encoding UTF-8
=head1 NAME
reposdb - Manipulate repos.db
=head1 VERSION
This document describes version 0.007 of reposdb (from Perl distribution App-reposdb), released on 2020-10-10.
=head1 SYNOPSIS
Usage:
% reposdb get [--config-path=path | -c] [--config-profile=profile | -P]
[--debug] [--format=name] [--json] [--log-level=level]
[--(no)naked-res] [--no-config | -C] [--no-env]
[--page-result[=program]] [--quiet] [--reposdb-path=s] [--trace]
[--verbose] [--view-result[=program]] [repo]
% reposdb ls [--config-path=path | -c] [--config-profile=profile | -P]
[--debug] [--detail] [--format=name] [--has-tag=s+]
[--has-tags-json=s] [--json] [-l] [--lacks-tag=s+]
[--lacks-tags-json=s] [--log-level=level] [--(no)naked-res]
[--no-config | -C] [--no-detail] [--no-env] [--nodetail]
[--page-result[=program]] [--quiet] [--reposdb-path=s] [--sort=s+]
[--sorts-json=s] [--trace] [--verbose] [--view-result[=program]]
% reposdb remove-all-tags [--config-path=path | -c]
[--config-profile=profile | -P] [--debug] [--format=name] [--json]
[--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
[--page-result[=program]] [--quiet] [--reposdb-path=s] [--trace]
[--verbose] [--view-result[=program]] [repo]
% reposdb remove-tag [--config-path=path | -c] [--config-profile=profile |
-P] [--debug] [--format=name] [--json] [--log-level=level]
[--(no)naked-res] [--no-config | -C] [--no-env]
[--page-result[=program]] [--quiet] [--reposdb-path=s] [--trace]
[--verbose] [--view-result[=program]] [repo] <tags> ...
% reposdb tag [--config-path=path | -c] [--config-profile=profile | -P]
[--debug] [--format=name] [--json] [--log-level=level]
[--(no)naked-res] [--no-config | -C] [--no-env]
[--page-result[=program]] [--quiet] [--reposdb-path=s] [--trace]
[--verbose] [--view-result[=program]] [repo] <tags> ...
% reposdb touch [--commit-time] [--config-path=path | -c]
[--config-profile=profile | -P] [--debug] [--format=name] [--json]
[--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env]
[--page-result[=program]] [--pull-time] [--quiet] [--reposdb-path=s]
[--status-time] [--to=s] [--trace] [--verbose]
[--view-result[=program]] [repo]
=head1 DESCRIPTION
=head1 SUBCOMMANDS
=head2 B<get>
Get metadata for a repo (by default the current repo).
=head2 B<ls>
List repositories registered in repos.db.
=head2 B<remove-all-tags>
Remove all tags from a repo (by default the current repo).
=head2 B<remove-tag>
Remove tag from a repo (by default the current repo).
=head2 B<tag>
Add a tag to a repo (by default the current repo).
=head2 B<touch>
Touch the timestamp(s) of a repo (by default current repo).
=head1 OPTIONS
C<*> marks required options.
=head2 Common 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<--debug>
Shortcut for --log-level=debug.
=item B<--format>=I<s>
Choose output format, e.g. json, text.
Default value:
undef
=item B<--help>, B<-h>, B<-?>
Display help message and exit.
=item B<--json>
Set output format to json.
=item B<--log-level>=I<s>
Set log level.
=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<--no-config>, B<-C>
Do not use any configuration file.
=item B<--no-env>
Do not read environment for default options.
=item B<--page-result>
Filter output through a pager.
=item B<--quiet>
Shortcut for --log-level=error.
=item B<--reposdb-path>=I<s>*
=item B<--subcommands>
List available subcommands.
=item B<--trace>
Shortcut for --log-level=trace.
=item B<--verbose>
Shortcut for --log-level=info.
=item B<--version>, B<-v>
Display program's version and exit.
=item B<--view-result>
View output using a viewer.
=back
=head2 Options for subcommand get
=over
=item B<--repo>=I<s>
=back
=head2 Options for subcommand ls
=over
=item B<--detail>, B<-l>
=item B<--has-tag>=I<s@>
Can be specified multiple times.
=item B<--has-tags-json>=I<s>
See C<--has-tag>.
=item B<--lacks-tag>=I<s@>
Can be specified multiple times.
=item B<--lacks-tags-json>=I<s>
See C<--lacks-tag>.
=item B<--sort>=I<s@>
Default value:
["name"]
Can be specified multiple times.
=item B<--sorts-json>=I<s>
See C<--sort>.
=back
=head2 Options for subcommand remove-all-tags
=over
=item B<--repo>=I<s>
=back
=head2 Options for subcommand remove-tag
=over
=item B<--repo>=I<s>
=item B<--tag>=I<s@>*
Can be specified multiple times.
=item B<--tags-json>=I<s>
See C<--tag>.
=back
=head2 Options for subcommand tag
=over
=item B<--repo>=I<s>
=item B<--tag>=I<s@>*
Can be specified multiple times.
=item B<--tags-json>=I<s>
See C<--tag>.
=back
=head2 Options for subcommand touch
=over
=item B<--commit-time>
=item B<--pull-time>
=item B<--repo>=I<s>
=item B<--status-time>
=item B<--to>=I<s>
=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 reposdb reposdb
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 reposdb 'p/*/`reposdb`/'
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/reposdb.conf>, F<~/reposdb.conf>, or F</etc/reposdb.conf>.
All found files will be read and merged.
To disable searching for configuration files, pass C<--no-config>.
To put configuration for a certain subcommand only, use a section name like C<[subcommand=NAME]> or C<[SOMESECTION subcommand=NAME]>.
You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]> or C<[subcommand=SUBCOMMAND_NAME profile=SOMENAME]> or C<[SOMESECTION subcommand=SUBCOMMAND_NAME 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.
Finally, you can 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 has value equals something: 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 something: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: 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.
List of available configuration parameters:
=head2 Common for all subcommands
format (see --format)
log_level (see --log-level)
naked_res (see --naked-res)
reposdb_path (see --reposdb-path)
=head2 Configuration for subcommand get
repo (see --repo)
=head2 Configuration for subcommand ls
detail (see --detail)
has_tags (see --has-tag)
lacks_tags (see --lacks-tag)
sorts (see --sort)
=head2 Configuration for subcommand remove-all-tags
repo (see --repo)
=head2 Configuration for subcommand remove-tag
repo (see --repo)
tags (see --tag)
=head2 Configuration for subcommand tag
repo (see --repo)
tags (see --tag)
=head2 Configuration for subcommand touch
commit_time (see --commit-time)
pull_time (see --pull-time)
repo (see --repo)
status_time (see --status-time)
to (see --to)
=head1 ENVIRONMENT
=head2 REPOSDB_OPT => str
Specify additional command-line options.
=head1 FILES
F<~/.config/reposdb.conf>
F<~/reposdb.conf>
F</etc/reposdb.conf>
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-reposdb>.
=head1 SOURCE
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=App-reposdb>
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) 2020, 2017, 2016 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