App-pause-Unpacked

 view release on metacpan or  search on metacpan

script/pause-unpacked  view on Meta::CPAN

#!perl

our $DATE = '2021-05-26'; # DATE
our $DIST = 'App-pause-Unpacked'; # DIST
our $VERSION = '0.491'; # VERSION

use 5.010001;
use strict;
use warnings;

use App::pause;
use Perinci::CmdLine::pause;

Perinci::CmdLine::pause->new(
    %App::pause::cli_attrs,
)->run;

# ABSTRACT: A CLI for PAUSE (unpacked version)
# PODNAME: pause-unpacked

__END__

=pod

=encoding UTF-8

=head1 NAME

pause-unpacked - A CLI for PAUSE (unpacked version)

=head1 VERSION

This document describes version 0.491 of pause-unpacked (from Perl distribution App-pause-Unpacked), released on 2021-05-26.

=head1 SYNOPSIS

Use like you would use L<pause>:

 % pause upload Foo-Bar-1.23.tar.gz
 ...

=head1 DESCRIPTION

This is an unpacked version of L<pause>, for development/testing only. Normal
users should just use L<pause>.

=head1 SUBCOMMANDS

=head2 B<cleanup>

Delete older versions of distributions.

Currently does not look for releases in subdirectories.

By default does not include developer (trial) releases. To include that, use
C<--include-dev>.

To only cleanup developer releases, you can use C<--include-dev> and
C<--exclude-nondev>.


=head2 B<ls>

List files.

=head2 B<ls-dists>

List distributions.

Distribution names will be extracted from tarball/zip filenames.

Unknown/unparseable filenames will be skipped.


=head2 B<ls-mods>

List modules (permissions).

=head2 B<reindex>

Force reindexing.

=head2 B<rm>

Delete files.

When a file is deleted, it is not immediately deleted but has
scheduled_for_deletion status for 72 hours, then deleted. During that time, the
file can be undeleted.


=head2 B<undelete>

Undelete files.

When a file is deleted, it is not immediately deleted but has
scheduled_for_deletion status for 72 hours, then deleted. During that time, the
file can be undeleted.


=head2 B<upload>

Upload file(s).

=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:

script/pause-unpacked  view on Meta::CPAN

Can also be specified as the 1st command-line argument and onwards.

=back

=head2 Options for subcommand rm

=over

=item B<--file>=I<s@>*

File name/wildcard pattern.

Can also be specified as the 1st command-line argument and onwards.

Can be specified multiple times.

=item B<--files-json>=I<s>

File names/wildcard patterns (JSON-encoded).

See C<--file>.

Can also be specified as the 1st command-line argument and onwards.

=item B<--protect-file>=I<s@>

Protect some files/wildcard patterns from delete/cleanup.

Can be specified multiple times.

=item B<--protect-files-json>=I<s>

Protect some files/wildcard patterns from delete/cleanup (JSON-encoded).

See C<--protect-file>.

=back

=head2 Options for subcommand undelete

=over

=item B<--file>=I<s@>*

File name/wildcard pattern.

Can also be specified as the 1st command-line argument and onwards.

Can be specified multiple times.

=item B<--files-json>=I<s>

File names/wildcard patterns (JSON-encoded).

See C<--file>.

Can also be specified as the 1st command-line argument and onwards.

=back

=head2 Options for subcommand upload

=over

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

Pause a number of seconds between files.

If you upload a lot of files (e.g. 7-10 or more) at a time, the PAUSE indexer
currently might choke with SQLite database locking problem and thus fail to
index your releases. Giving a delay of say 2-3 minutes (120-180 seconds) between
files will alleviate this problem.


=item B<--file>=I<s@>*

File name/wildcard pattern.

Can also be specified as the 1st command-line argument and onwards.

Can be specified multiple times.

=item B<--files-json>=I<s>

File names/wildcard patterns (JSON-encoded).

See C<--file>.

Can also be specified as the 1st command-line argument and onwards.

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

Subdirectory to put the file(s) into.

Default value:

 ""

=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 pause-unpacked pause-unpacked

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 pause-unpacked 'p/*/`pause-unpacked`/'

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

script/pause-unpacked  view on Meta::CPAN

 

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:

=head2 Common for all subcommands

 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)
 password (see --password)
 retries (see --retries)
 username (see --username)

=head2 Configuration for subcommand cleanup

 detail (see --detail)
 include_dev (see --include-dev)
 include_nondev (see --exclude-nondev)
 num_keep (see --num-keep)
 protect_files (see --protect-file)

=head2 Configuration for subcommand ls

 del (see --del)
 detail (see --detail)
 files (see --file)
 mtime_max (see --mtime-max)
 mtime_min (see --mtime-min)
 size_max (see --size-max)
 size_min (see --size-min)

=head2 Configuration for subcommand ls-dists

 detail (see --detail)
 include_dev (see --include-dev)
 include_nondev (see --exclude-nondev)
 newest (see --newest)
 newest_n (see --newest-n)

=head2 Configuration for subcommand ls-mods

 detail (see --detail)
 modules (see --module)
 type (see --type)

=head2 Configuration for subcommand reindex

 files (see --file)

=head2 Configuration for subcommand rm

 files (see --file)
 protect_files (see --protect-file)

=head2 Configuration for subcommand undelete

 files (see --file)

=head2 Configuration for subcommand upload

 delay (see --delay)
 files (see --file)
 subdir (see --subdir)

=head1 ENVIRONMENT

=head2 PAUSE_UNPACKED_OPT => str

Specify additional command-line options.

=head1 FILES

F<~/.config/pause.conf>

F<~/pause.conf>

F</etc/pause.conf>

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/App-pause-Unpacked>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-pause-Unpacked>.

=head1 BUGS

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

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 SEE ALSO

L<pause> from L<App::pause>.

=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