Skip to content

Latest commit

 

History

History
133 lines (88 loc) · 4.82 KB

README.md

File metadata and controls

133 lines (88 loc) · 4.82 KB
Raw

GetPAN

GetPAN is an alternative to Carton.

It has some differences to Carton, but essentially does the same job of installing Perl dependencies from a cpanfile.

Features

  • Supports basic cpanfile syntax
  • Builds a full dependency tree
  • Downloads CPAN archives to local cache
  • Resolves dependency installation order
  • Supports SmartPAN for accurate dependency resolution
  • Supports multiple CPAN mirrors
  • Supports BackPAN for old module versions
  • Per-module notest and dependency fixes
  • Should work on most platforms (requires cpanm!)
  • Carton compatible - run carton install after getpan

Getting started

Run GetPAN from the command line to install Perl dependencies:

getpan

This will use the default CPAN source and will install dependencies found in ./cpanfile.

You can provide alternative mirrors to install from:

getpan -cpan http://your.darkpan:1234

If you have a SmartPAN, pass in the URL with -smart:

getpan -smart http://your.smartpan:7050

Use only your SmartPAN and MetaCPAN to install dependencies

getpan -metacpan -nocpan -nobackpan -smart http://your.smartpan:7050

You can also install modules from the command line:

getpan Some::Module Another::Module

Use getpan exec to configure your environment:

getpan exec perl ./your_app.pl

Sources

GetPAN supports CPAN, BackPAN and SmartPAN sources.

You specify these with the -cpan, -backpan and -smart command line options.

If you want to replace the default CPAN and BackPAN sources, also pass in -nocpan and -nobackpan.

Source priority

Each source is assigned a priority - this is 1000 by default. Lower numbers are higher priority.

You can override this in the source URL. For example, this will attempt to resolve dependencies using SmartPAN before CPAN or BackPAN:

getpan -smart 1:https://your.smartpan:7050

The priority can range from 1 to int on your platform.

Command line options

Option Example Description
-h -h Display usage information
-backpan -backpan http://backpan.perl.org A BackPAN mirror to use (can be specified multiple times)
-cpan -cpan http://www.cpan.org A CPAN mirror to use (can be specified multiple times)
-smart -smart http://localhost:7050 A SmartPAN mirror to use (can be specified multiple times)
-cpanfile -cpanfile app.cpanfile The cpanfile to install from
-cpus -cpus 4 Number of CPUs to use
-cachedir -cachedir ./cache Cache directory for CPAN modules (default is './.gopancache')
-installdir -installdir ./modules Installation directory for CPAN modules (default is './local')
-loglayout -loglayout="[%d] %m" A github.com/ian-kent/go-log compatible pattern layout
-loglevel -loglevel=TRACE Set log output level (ERROR, INFO, WARN, DEBUG, TRACE)
-tests -tests Enables all installation tests
-metacpan -metacpan Resolve dependency via 'cpanm --info'
-nocpan -nocpan Disables the default CPAN source
-nobackpan -nobackpan Disables the default BackPAN source
-noinstall -noinstall Skips the installation phase
-nodepdump -nodepdump Skips the resolved dependency dump
-test -test AnyCache Enables tests for a specific module

Exit status

Exit status Description
1 Error loading CPAN/BackPAN/DarkPAN sources
2 Error parsing input cpanfile
3 Error resolving dependencies
4 Error installing dependencies
10 Error executing command (with getpan exec)

cpanfile support

GetPAN supports basic cpanfile syntax.

Basic syntax

# Latest version
requires 'Module::Name';

# Minimum version
requires 'Module::Name', '1.02';
requires 'Module::Name', '>= 1.02';

# Exact version
requires 'Module::Name', '== 1.02';

# Maximum version
requires 'Module::Name', '<= 1.02';

Additional syntax

GetPAN also extends cpanfile syntax to fix missed dependencies in CPAN modules:

requires 'Broken::Module', '== 1.24'; # REQS: Missing::Dep-3.12; Another::Missing::Dep-1.82

Licence

Copyright ©‎ 2014, Ian Kent (http://www.iankent.eu).

Released under MIT license, see LICENSE for details.