cpanm - get, unpack build and install modules from CPAN
cpanm Test::More # install Test::More cpanm MIYAGAWA/Plack-0.99_05.tar.gz # full distribution path cpanm http://example.org/LDS/CGI.pm-3.20.tar.gz # install from URL cpanm ~/dists/MyCompany-Enterprise-1.00.tar.gz # install from a local file cpanm --interactive Task::Kensho # Configure interactively cpanm . # install from local directory cpanm --installdeps . # install all the deps for the current directory cpanm -L extlib Plack # install Plack and all non-core deps into extlib cpanm --mirror http://cpan.cpantesters.org/ DBI # use the fast-syncing mirror
Installs the modules. This is a default behavior and this is just a compatibility option to make it work like cpan or cpanp.
Upgrades itself. It's just an alias for:
cpanm App::cpanminus
Displays the distribution information in AUTHOR/Dist-Name-ver.tar.gz format in the standard out.
AUTHOR/Dist-Name-ver.tar.gz
Installs the dependencies of the target distribution but won't build itself. Handy if you want to try the application from a version controlled repository such as git.
cpanm --installdeps .
Download and unpack the distribution and then open the directory with your shell. Handy to poke around the source code or do the manual testing.
Displays the help message.
Displays the version number.
You can specify the default options in PERL_CPANM_OPT environment variable.
PERL_CPANM_OPT
Force install modules even when testing failed.
Skip the testing of modules. Use this only when you just want to save time for installing hundreds of distributions to the same perl and architecture you've already tested to make sure it builds fine.
Defaults to false, and you can say --no-notest to override when it is set in the default options in PERL_CPANM_OPT.
--no-notest
Switch to the root user with sudo when installing modules. Use this if you want to install modules to the system perl include path.
sudo
Defaults to false, and you can say --no-sudo to override when it is set in the default options in PERL_CPANM_OPT.
--no-sudo
Makes the output verbose. It also enables the interactive configuration. (See --interactive)
Makes the output even more quiet than the default. It doesn't print anything to the STDERR.
Sets the local::lib compatible path to install modules to. You don't need to set this if you already configure the shell environment variables using local::lib, but this can be used to override that as well.
Same with --local-lib but when examining the dependencies, it assumes no non-core modules are installed on the system. It's handy if you want to bundle application dependencies in one directory so you can distribute to other machines.
--local-lib
For instance,
cpanm -L extlib Plack
would install Plack and all of its non-core dependencies into the directory extlib, which can be loaded from your application with:
extlib
use local::lib '/path/to/extlib';
Specifies the base URL for the CPAN mirror to use, such as http://cpan.cpantesters.org/ (you can omit the trailing slash). You can specify multiple mirror URLs by repeating the command line option.
http://cpan.cpantesters.org/
Defaults to http://search.cpan.org/CPAN which is a geo location aware redirector.
http://search.cpan.org/CPAN
Download the mirror's 02packages.details.txt.gz index file instead of querying the CPAN Meta DB.
Select this option if you are using a local mirror of CPAN, such as minicpan when you're offline, or your own CPAN index (a.k.a darkpan).
Tip: It might be useful if you name these mirror options with your shell aliases, like:
alias minicpanm='cpanm --mirror ~/minicpan --mirror-only' alias darkpan='cpanm --mirror http://mycompany.example.com/DPAN --mirror-only'
Prompts when a test fails so that you can skip, force install, retry or look in the shell to see what's going wrong. It also prompts when one of the dependency failed if you want to proceed the installation.
Defaults to false, and you can say --no-prompt to override if it's set in the default options in PERL_CPANM_OPT.
--no-prompt
cpanm, when given a module name in the command line (i.e. cpanm Plack), checks the locally installed version first and skips if it is already installed. This option makes it skip the check, so:
cpanm Plack
cpanm --reinstall Plack
would reinstall Plack even if your locally installed version is latest, or even newer (which would happen if you install a developer release from version control repositories).
Defaults to false.
Makes the configuration (such as Makefile.PL and Build.PL) interactive, so you can answer questions in the distribution that requires custom configuration or Task:: distributions.
Makefile.PL
Build.PL
Defaults to false, and you can say --no-interactive to override when it's set in the default options in PERL_CPANM_OPT.
--no-interactive
Uninstalls the shadow files of the distribution that you're installing. This eliminates the confusion if you're trying to install core (dual-life) modules from CPAN against perl 5.10 or older, or modules that used to be XS-based but switched to pure perl at some version.
If you run cpanm as root and use INSTALL_BASE or equivalent to specify custom installation path, you SHOULD disable this option so you won't accidentally uninstall dual-life modules from the core include path.
INSTALL_BASE
Defaults to true if your perl version is smaller than 5.12, and you can disable that with --no-uninst-shadows.
--no-uninst-shadows
NOTE: Since version 1.3000 this flag is turned off by default for perl newer than 5.12, since with 5.12 @INC contains site_perl directory before the perl core library path, and uninstalling shadows is not necessary anymore and does more harm by deleting files from the core library path.
Specifies the number of days in whcih cpanm's work directories expire. Defaults to 7, which means old work directories will be cleaned up in one week.
You can set the value to 0 to make cpan never cleanup those directories.
0
Generates man pages for executables (man1) and libraries (man3).
Defaults to false (no man pages generated) if -L|--local-lib-contained option is supplied. Otherwise, defaults to true, and you can disable it with --no-man-pages.
-L|--local-lib-contained
--no-man-pages
Uses LWP module to download stuff over HTTP. Defaults to true, and you can say --no-lwp to disable using LWP, when you want to upgrade LWP from CPAN on some broken perl systems.
--no-lwp
Uses GNU Wget (if available) to download stuff. Defaults to true, and you can say --no-wget to disable using Wget (versions of Wget older than 1.9 don't support the --retry-connrefused option used by cpanm).
--no-wget
--retry-connrefused
Uses cURL (if available) to download stuff. Defaults to true, and you can say --no-curl to disable using cURL.
--no-curl
Normally with --lwp, --wget and --curl options set to true (which is the default) cpanm tries LWP, Wget, cURL and HTTP::Tiny (in that order) and uses the first one available.
--lwp
--wget
--curl
App::cpanminus
Copyright 2010 Tatsuhiko Miyagawa.
Tatsuhiko Miyagawa
To install App::cpanminus, copy and paste the appropriate command in to your terminal.
cpanm
CPAN shell
perl -MCPAN -e shell install App::cpanminus
For more information on module installation, please visit the detailed CPAN module installation guide.