#!perl

our $DATE = '2015-01-10'; # DATE
our $VERSION = '0.06'; # VERSION

use 5.010;
use strict;
use warnings;

#use CPAN::SQLite::Meta;
use Perinci::CmdLine::Any -prefer_lite=>1;

Perinci::CmdLine::Any->new(
    url => "/CPAN/SQLite/CPANMeta/index_cpan_meta",
    log => 1,
)->run;

# ABSTRACT: Index CPAN Meta information in CPAN::SQLite database
# PODNAME: cpandb-cpanmeta

__END__

=pod

=encoding UTF-8

=head1 NAME

cpandb-cpanmeta - Index CPAN Meta information in CPAN::SQLite database

=head1 VERSION

This document describes version 0.06 of cpandb-cpanmeta (from Perl distribution CPAN-SQLite-CPANMeta), released on 2015-01-10.

=head1 SYNOPSIS

=head2 Indexing data

Before you use C<cpandb-cpanmeta>, you must already install CPAN::SQLite and
create its index, to do so:

 % cpanm CPAN::SQLite
 % cpandb --CPAN /path/to/cpan --db_dir /path/to/cpan --db_name cpandb.sql --setup

Then put this in C<~/cpandb-cpanmeta.conf> or C</etc/cpandb-cpanmeta.conf> to
avoid specifying repeatedly on command-line. Replace with actual path of your
local CPAN mirror:

 cpan=/path/to/cpan

Afterwards, index information from CPAN Meta by doing this:

 % cpandb-cpanmeta

If you want to see debugging information:

 % cpandb-cpanmeta --trace

Everytime you update your CPAN mirror, update the CPAN::SQLite index and also
the CPAN Meta information:

 % cpandb --CPAN /path/to/cpan --db_dir /path/to/cpan --db_name cpandb.sql --update
 % cpandb-cpanmeta

=head2 Querying

Install L<App::CPANSQLiteUtils> and see the provided CLI scripts.

=head1 DESCRIPTION

=head1 OPTIONS

C<*> marks required options.

=over

=item B<--config-path>=I<s>

{en_US Set path to configuration file}.

Can be specified multiple times.

=item B<--config-profile>=I<s>

{en_US Set configuration profile to use}.

=item B<--cpan>=I<s>*

{en_US Location of your local CPAN mirror, e.g. /path/to/cpan}.

=item B<--db-dir>=I<s>

{en_US Database directory, defaults to your CPAN home}.

=item B<--db-name>=I<s>

{en_US Database name}.

Default value:

 "cpandb.sql"

=item B<--debug>

{en_US Set log level to debug}.

=item B<--format>=I<s>

{en_US Choose output format, e.g. json, text}.

=item B<--help>, B<-h>, B<-?>

{en_US Display this help message}.

=item B<--json>

{en_US Set output format to json}.

=item B<--log-level>=I<s>

{en_US Set log level}.

=item B<--naked-res>

{en_US When outputing as JSON, strip result envelope}.

{en_US 
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>

{en_US Do not use any configuration file}.

=item B<--quiet>

{en_US Set log level to quiet}.

=item B<--trace>

{en_US Set log level to trace}.

=item B<--verbose>

{en_US Set log level to info}.

=item B<--version>, B<-v>

=back

=head1 FILES

B</etc/cpandb-cpanmeta.conf>

B<~/cpandb-cpanmeta.conf>

=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 cpandb-cpanmeta cpandb-cpanmeta

in your bash startup (e.g. C<~/.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 L<shcompgen> which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with L<Dist::Zilla::Plugin::GenShellCompletion>) will even automatically enable shell completion for their included scripts (using C<shcompgen>) at installation time, so you can immadiately have tab completion.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete cpandb-cpanmeta 'p/*/`cpandb-cpanmeta`/'

in your tcsh startup (e.g. C<~/.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 C<shcompgen> (see above).

=head2 other shells

For fish and zsh, install C<shcompgen> as described above.

=head1 ENVIRONMENT

CPANDB_CPANMETA_OPT

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/CPAN-SQLite-CPANMeta>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-CPAN-SQLite-CPANMeta>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=CPAN-SQLite-CPANMeta>

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) 2015 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
