NAME
pause - An API for PAUSE
VERSION
This document describes version 0.03 of pause (from Perl distribution WWW-PAUSE-Simple), released on 2015-02-19.
SYNOPSIS
First create a config file ~/pause.conf
containing:
username=<Your PAUSE ID>
password=<Your PAUSE password>
and then:
# upload a file
% pause upload Foo-Bar-0.12.tar.gz
% pause upload Foo-Bar-0.12.tar.gz --subdir old/2014; # upload to a subdir
# list your files
% pause list
% pause list App- 1.0; # filter by strings/keywords
% pause list --detail; # see file sizes/mtimes/etc instead of just names
# delete files
% pause delete Foo-Bar-0.12.tar.gz Foo-Bar-0.12.readme Foo-Bar-0.12.meta
% pause delete --all; # caution
# 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 --all
# force reindexing
% pause reindex Foo-Bar-0.12.tar.gz Foo-Bar-0.12.meta
% pause reindex --all
# change your password
...
# view your account info
...
# change your email forwarding
...
SUBCOMMANDS
delete
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.
list
List files on your PAUSE account.
ls
List files on your PAUSE account.
password
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 a file to your PAUSE account.
OPTIONS
*
marks required options.
Common options
- --config-path=s
-
Set path to configuration file.
Can be specified multiple times.
- --config-profile=s
-
Set configuration profile to use.
- --format=s
-
Choose output format, e.g. json, text.
- --help, -h, -?
-
Display this help message.
- --json
-
Set output format to json.
- --naked-res
-
When outputing as JSON, strip result envelope.
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.
- --password=s*
-
PAUSE password.
- --subcommands
-
List available subcommands.
- --username=s*
-
PAUSE ID.
- --version, -v
Options for subcommand delete
- --all
-
Apply to all files.
- --file-json=s
-
File name (JSON-encoded).
See
--file
. - --file=s@
-
File name.
Can be specified multiple times.
Options for subcommand list
- --del
-
Only list files which are scheduled for deletion.
- --detail
-
Whether to return detailed records.
- --query-json=s
-
Filter result by keywords/string (JSON-encoded).
See
--query
. - --query=s@
-
Filter result by keywords/string.
Can be specified multiple times.
Options for subcommand ls
- --del
-
Only list files which are scheduled for deletion.
- --detail
-
Whether to return detailed records.
- --query-json=s
-
Filter result by keywords/string (JSON-encoded).
See
--query
. - --query=s@
-
Filter result by keywords/string.
Can be specified multiple times.
Options for subcommand password
Options for subcommand reindex
- --all
-
Apply to all files.
- --file-json=s
-
File name (JSON-encoded).
See
--file
. - --file=s@
-
File name.
Can be specified multiple times.
Options for subcommand rm
- --all
-
Apply to all files.
- --file-json=s
-
File name (JSON-encoded).
See
--file
. - --file=s@
-
File name.
Can be specified multiple times.
Options for subcommand undelete
- --all
-
Apply to all files.
- --file-json=s
-
File name (JSON-encoded).
See
--file
. - --file=s@
-
File name.
Can be specified multiple times.
Options for subcommand upload
ENVIRONMENT
PAUSE_OPT
FILES
~/pause.conf
/etc/pause.conf
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 shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen
) at installation time, so you can immadiately have tab completion.
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.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/WWW-PAUSE-Simple.
SOURCE
Source repository is at https://github.com/perlancar/perl-WWW-PAUSE-Simple.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=WWW-PAUSE-Simple
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.
AUTHOR
perlancar <perlancar@cpan.org>
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.