NAME

mcpani-client - Command-line client for CPAN::Mini::Inject::REST

SYNOPSYS

Add a distribution to a remote CPAN::Mini mirror:

mcpani-client add --host mycpan.local MyDist-0.04.tar.gz

Install it with cpanm:

cpanm --mirror http://mycpan.local --mirror-only MyDist

DESCRIPTION

mcpani-client enables distributions to be remotely uploaded to a CPAN::Mini mirror which is running the CPAN::Mini::Inject::REST API.

Usage

mcpani-client <command> [options] <arguments>

Commands

help

mcpani-client help
mcpani-client help <command_name>

Displays general help, or help for a specific command.

add

mcpani-client add [options] <filename>

Adds a new file into the repository and injects it into the mirror.

dist

mcpani-client dist [options] <dist_name>

Shows files held in the mirror and the repository for the specified distribution.

all_dists

mcpani-client all_dists [options]

Lists all distributions which have been added to the mirror.

file

mcpani-client file [options] <filename>

Checks to see if filename has been added to the mirror, and if so lists the module names (and versions) that the file provides.

all_files

mcpani-client all_files [options]

Lists all files which have been added to the mirror.

download

mcpani-client [options] [--stdout] <filename>

Downloads filename from the repository.

By default, the file will be saved to disk. However, if the --stdout option is given, the file will be streamed to STDOUT.

Options

All commands accept the following options:

--host

Hostname or IP address of the CPAN::Mini server (defaults to 127.0.0.1).

--port

Port number of the CPAN::Mini server (defaults to 80).

--protocol

Protocol used by the CPAN::Mini server (http or https, defaults to http).

--username

--password

Username and password to use if the CPAN::Mini server requires HTTP basic authentication.

Configuration

Options to mcpani-client may be defined in a configuration file

File pointed to by $ENV{MCPANI_CLIENT_CONFIG}
<user's home directory>/.mcpani-client
/usr/local/etc/mcpani-client
/etc/mcpani-client

mcpani-client uses the Config::General configuration file format, e.g.

# mcpani-client config file
server cpan.local
protocol http
port 8080

SEE ALSO

CPAN::Mini::Inject::REST, CPAN::Mini::Inject

AUTHOR

Jon Allen (JJ) <jj@jonallen.info>

LICENSE

This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself.