The Perl Advent Calendar needs more articles for 2022. Submit your idea today!

NAME

pause - A CLI for PAUSE

VERSION

This document describes version 0.659 of main (from Perl distribution App-pause), released on 2022-11-02.

SYNOPSIS

First create a config file ~/pause.conf containing:

 username=<Your PAUSE ID>
 password=<Your PAUSE password>

or if you have ~/.pause from cpan-upload, pause can read it too (encrypted .pause is currently not supported).

Then:

 # upload one or more files
 % pause upload Foo-Bar-0.12.tar.gz Baz-2.24.tar.gz
 % pause upload Foo-Bar-0.12.tar.gz --subdir old/2014; # upload to a subdir

 # list your files
 % pause ls
 % pause ls 'App-*'; # accept filenames/wildcard patterns, note: quote first
 % pause ls -l     ; # see file sizes/mtimes/etc instead of just names

 # list your dists
 % pause ls-dists

 # delete files
 % pause rm Foo-Bar-0.12.tar.gz Foo-Bar-0.12.readme Foo-Bar-0.12.meta
 % pause rm 'Foo-Bar-*'; # accept wildcard patterns, but quote first

 # undelete files scheduled for deletion (but not actually deleted yet)
 % pause undelete Foo-Bar-0.12.tar.gz Foo-Bar-0.12.readme Foo-Bar-0.12.meta
 % pause undelete 'Foo-Bar-*'; # accept wildcard patterns, but quote first

 # force reindexing
 % pause reindex Foo-Bar-0.12.tar.gz Foo-Bar-0.12.meta
 % pause reindex 'Foo-Bar-*'; # accept wildcard patterns, but quote first

 # clean old releases, by default will only leave the newest non-dev version
 % pause cleanup
 % pause cleanup -n 3 ; # keep 3 versions (newest + previous two)

To view permissions:

 # list all modules that you have permissions of
 % pause ls-mods
 % pause ls-mods -l ; # show detail

 # list all modules matching a wildcard
 % pause ls-mods -l 'Unix*'

 # list all modules you have co-maint of
 % pause ls-mods -l --type co-maint

To change permissions (not yet implemented):

 ...

To change your password (not yet implemented):

 ...

To view your account info (not yet implemented):

 ...

To change your email forwarding (not yet implemented):

 ...

SUBCOMMANDS

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 --include-dev.

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

ls

List files.

ls-dists

List distributions.

Distribution names will be extracted from tarball/zip filenames.

Unknown/unparseable filenames will be skipped.

ls-mods

List modules (permissions).

reindex

Force reindexing.

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.

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.

upload

Upload file(s).

OPTIONS

* marks required options.

Common options

--config-path=s

Set path to configuration file.

Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:

 [profile=dev]
 username=foo
 pass=beaver
 
 [profile=production]
 username=bar
 pass=honey

When you specify --config-profile=dev, username will be set to foo and password to beaver. When you specify --config-profile=production, username will be set to bar and password to honey.

--debug

Shortcut for --log-level=debug.

--format=s

Choose output format, e.g. json, text.

Default value:

 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.

--help, -h, -?

Display help message and exit.

--json

Set output format to json.

--log-level=s

Set log level.

By default, these log levels are available (in order of increasing level of importance, from least important to most): trace, debug, info, warn/warning, error, fatal. By default, the level is usually set to warn, which means that log statements with level info and less important levels will not be shown. To increase verbosity, choose info, debug, or trace.

For more details on log level and logging, as well as how new logging levels can be defined or existing ones modified, see Log::ger.

--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]
--no-config

Do not use any configuration file.

If you specify --no-config, the application will not read any configuration file.

--no-env

Do not read environment for default options.

If you specify --no-env, the application wil not read any environment variable.

--page-result

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.

--password=s

PAUSE password.

If unset, default value will be searched from ~/.pause. Encrypted .pause is not yet supported.

--quiet

Shortcut for --log-level=error.

--retries=s

Number of retries when received 5xx HTTP error from server.

Default value:

 5

The retry uses an exponential backoff strategy of delaying 3, 6, 12, 24, ..., 3600, 3600, ... seconds.

--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--username=s

PAUSE ID.

If unset, default value will be searched from ~/.pause. Encrypted .pause is not yet supported.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

--view-result

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.

Options for subcommand cleanup

--detail, -l

Whether to return detailed records.

--exclude-dist=s@

Exclude specified distributions.

Can be specified multiple times.

--exclude-dists-json=s

Exclude specified distributions (JSON-encoded).

See --exclude-dist.

--exclude-nondev

(No description)

--include-dev

Whether to include cleaning up non-dev releases.

--include-dist=s@

Only include specified distributions.

Can be specified multiple times.

--include-dists-json=s

Only include specified distributions (JSON-encoded).

See --include-dist.

--num-keep=s, -n

Number of new versions (including newest) to keep.

Default value:

 1

1 means to only keep the newest version, 2 means to keep the newest and the second newest, and so on.

--protect-file=s@

Protect some files/wildcard patterns from delete/cleanup.

Can be specified multiple times.

--protect-files-json=s

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

See --protect-file.

Options for subcommand ls

--del

Only list files which are scheduled for deletion.

--detail, -l

Whether to return detailed records.

--file=s@

File name/wildcard pattern.

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

Can be specified multiple times.

--files-json=s

File names/wildcard patterns (JSON-encoded).

See --file.

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

--mtime-max=s

(No description)

--mtime-min=s

(No description)

--size-max=s

(No description)

--size-min=s

(No description)

Options for subcommand ls-dists

--detail, -l

Whether to return detailed records.

--exclude-dist=s@

Exclude specified distributions.

Can be specified multiple times.

--exclude-dists-json=s

Exclude specified distributions (JSON-encoded).

See --exclude-dist.

--exclude-nondev

(No description)

--include-dev

Whether to include cleaning up non-dev releases.

--include-dist=s@

Only include specified distributions.

Can be specified multiple times.

--include-dists-json=s

Only include specified distributions (JSON-encoded).

See --include-dist.

--newest

Only show newest non-dev version.

Dev versions will be skipped.

--newest-n=s

Only show this number of newest versions.

Dev versions will be skipped.

Options for subcommand ls-mods

--detail, -l

Whether to return detailed records.

--module=s@

Module name/wildcard pattern.

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

Can be specified multiple times.

--modules-json=s

Module names/wildcard patterns (JSON-encoded).

See --module.

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

--type=s

Only list modules matching certain type.

Options for subcommand reindex

--file=s@*

File name/wildcard pattern.

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

Can be specified multiple times.

--files-json=s

File names/wildcard patterns (JSON-encoded).

See --file.

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

Options for subcommand rm

--file=s@*

File name/wildcard pattern.

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

Can be specified multiple times.

--files-json=s

File names/wildcard patterns (JSON-encoded).

See --file.

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

--protect-file=s@

Protect some files/wildcard patterns from delete/cleanup.

Can be specified multiple times.

--protect-files-json=s

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

See --protect-file.

Options for subcommand undelete

--file=s@*

File name/wildcard pattern.

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

Can be specified multiple times.

--files-json=s

File names/wildcard patterns (JSON-encoded).

See --file.

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

Options for subcommand upload

--delay=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.

--file=s@*

File name/wildcard pattern.

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

Can be specified multiple times.

--files-json=s

File names/wildcard patterns (JSON-encoded).

See --file.

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

--subdir=s

Subdirectory to put the file(s) into.

Default value:

 ""

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C pause pause

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.

tcsh

To activate tcsh completion for this script, put:

 complete pause 'p/*/`pause`/'

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

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): /home/u1/.config/pause.conf, /home/u1/pause.conf, or /etc/pause.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [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 env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [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: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [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: [env=HOSTNAME!*=server ...] or [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 -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [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 -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

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)

Configuration for subcommand cleanup

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

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)

Configuration for subcommand ls-dists

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

Configuration for subcommand ls-mods

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

Configuration for subcommand reindex

 files (see --file)

Configuration for subcommand rm

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

Configuration for subcommand undelete

 files (see --file)

Configuration for subcommand upload

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

ENVIRONMENT

PAUSE_OPT

String. Specify additional command-line options.

FILES

/home/u1/.config/pause.conf

/home/u1/pause.conf

/etc/pause.conf

~/.pause

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-App-pause.

SEE ALSO

To clean up, there are also: pause-cleanup (from App::PAUSE::cleanup), WWW::PAUSE::CleanUpHomeDir (CLI in example).

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

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.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2021, 2020, 2017, 2016, 2015 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.

BUGS

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

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.