Skip to content


Subversion checkout URL

You can clone with
Download ZIP
A free, open API for everything you want to know about CPAN
Perl Perl6 Shell

Merge pull request #423 from CPAN-API/haarg/permalinks

Improve pod links to files in the same dist
latest commit c440a8c70c
@oalders oalders authored

Build Status Coverage Status

A Web Service for the CPAN

MetaCPAN aims to provide a free, open web service which provides metadata for CPAN modules.


MetaCPAN is based on Elasticsearch, so it provides a RESTful interface as well as the option to create complex queries. The wiki provides a good starting point for REST access to MetaCPAN.

Expanding Your Author Info

MetaCPAN allows authors to add custom metadata about themselves to the index. Log in to MetaCPAN to add more information about yourself.

Installing Your Own MetaCPAN:

If you want to run MetaCPAN locally, we encourage you to start with a VM: Metacpan Developer VM However, you may still find some info here:

Troubleshooting Elasticsearch

You can restart Elasticsearch (ES) manually if you need to troubleshoot.

sudo service elasticsearch restart

If you are unable to access [http://localhost:9200] you should kill the Elasticsearch process and run it in foreground to see the debug output

sudo service elasticsearch stop
cd /opt/elasticsearch
sudo bin/elasticsearch -f

If you get a "Can't start up: not enough memory" error when trying to start Elasticsearch, you likely need to update your JRE. On Ubuntu:

# fixes "not enough memory" errors
sudo apt-get install openjdk-6-jre

(Note: If you intend to try indexing a full MiniCPAN, you may find that Elasticsearch wants to use more open filehandles than your system allows by default. This script can be used to start ES with the appropriate ulimit adjustment).

Run the test suite

The test suite accesses Elasticsearch on port 9900. The developer VM should have a dedicated test instance running in the background already, but if you want to run it manually:

cd /opt/elasticsearch
sudo bin/elasticsearch -f -Des.http.port=9900

Then run the test suite:

cd /home/metacpan/
./bin/prove t

The test suite has to pass all tests.

Create the ElasticSearch Index

./bin/carton-exec bin/metacpan mapping --delete

--delete will drop all indices first to clear the index from test data.

Begin Indexing Your Modules

./bin/carton-exec bin/metacpan release /path/to/cpan/authors/id/

You should note that you can index either your CPAN mirror or a minicpan mirror. You can even index just parts of a mirror:

./bin/carton-exec bin/metacpan release /path/to/cpan/authors/id/{A,B}

Tag the Latest Releases

./bin/carton-exec bin/metacpan latest --cpan /path/to/cpan/

Index Author Data

./bin/carton-exec bin/metacpan author --cpan /path/to/cpan/

Note that minicpan doesn't provide the 00whois.xml file which is used to generate the index; you will have to download it manually (it is in the authors/ directory) in order to index authors.

wget -O /path/to/cpan/authors/00whois.xml

It also doesn't include author.json files, so that data will also be missing unless you get it from somewhere else.

Set Up Proxy in Front of ElasticSearch

Start API server on port 5000

./bin/carton-exec plackup -p 5000 -r

This will start a single-threaded test server. If you need extra performance, use Starman instead.


For a full list of options:

./bin/carton-exec bin/metacpan release --help


If you'd like to get involved, find us at #metacpan or or join our mailing list (see below) and let us know what you'd like to start working on.


You can find us at #metacpan on Access it via web interface:

IRC logs can be found here: (Thanks to Moritz Lenz for making this service available)

Mailing List

Our mailing list is open to all:

Something went wrong with that request. Please try again.