CPAN::...Inject(3pm)

💖 CPAN::...Inject(3pm) — the tea on CPAN::Mini::Inject 💖

okay bestie, sit down, grab a boba, because we're about to talk about CPAN::Mini::Inject — a whole Perl module that lets you inject your own distributions into a CPAN::Mini mirror. it's giving "I made my own CPAN and you're not invited" and honestly? iconic. 💅

---

✨ NAME ✨

CPAN::Mini::Inject — inject modules into a CPAN::Mini mirror. fr fr that's the whole vibe. 🎀

---

🌸 SYNOPSIS 🌸

so like, if you're not planning to customize the way CPAN::Mini::Inject works, you probably want to go look at the mcpani command instead. just saying. 🙈

use CPAN::Mini::Inject;

$mcpi=CPAN::Mini::Inject->new;
$mcpi->parsecfg('t/.mcpani/config');

$mcpi->add(
  module   => 'CPAN::Mini::Inject',
authorid => 'SSORICHE',
version  => ' 0.01',
file     => 'mymodules/CPAN-Mini-Inject-0.01.tar.gz'
);

$mcpi->writelist;
$mcpi->update_mirror;
$mcpi->inject;

(yes the indentation is cursed, no we are not fixing it, it's canon. 💀)

---

🦋 DESCRIPTION 🦋

CPAN::Mini::Inject uses CPAN::Mini to build or update a local CPAN mirror from a remote one. and then it adds two extra features on top, because why not:

1. an additional repository of distribution files and related information (author and module versions), separate from the local and remote mirrors, to which you can add your own distribution files. 👑
2. the ability to inject the distribution files from your repository into a local CPAN mirror. 💥

---

🎀 METHODS 🎀

each method in CPAN::Mini::Inject returns a CPAN::Mini::Inject object, which means you can do that cute little method chaining thing. like so:

my $mcpi=CPAN::Mini::Inject->new;
$mcpi->parsecfg
     ->update_mirror
     ->inject;

a CPAN::Mini::Inject ISA CPAN::Mini. so if you wanna know about the interface that CPAN::Mini::Inject inherits from it, go read the docs for that module. iykyk. 📚

• "new" — create a new CPAN::Mini::Inject object. baby's first mcpi, slay. ✨
• config_class( [CLASS] ) — returns the name of the class used to handle the configuration. also see "default_config_class". 🧚
• config( [HASHREF] ) — with a hashref argument, it sets the config data. returns the current configuration hash. two jobs, one method, main character energy. 👑
• "default_config_class" — yes bestie, it's right there in the list. 🫶
• loadcfg( [FILENAME] ) — this is a bridge to CPAN::Mini::Inject::Config's loadconfig. it sets the filename for the configuration, or uses one of the defaults. 🌈
• parsecfg() — this is a bridge to CPAN::Mini::Inject::Config's parseconfig. 🍓
• site( [SITE] ) — with an argument, set the site to use to contact CPAN. returns the site setting, or, if the site has not be set (or was set to undef), returns the empty string. (yes, "has not be set" — we're quoting, don't @ us. 💀)
• "testremote" — test each site listed in the remote parameter of the config file by performing a get on each site in order for authors/01mailrc.txt.gz. the first site to respond successfully is set as the instance variable site. 🌟

print "$mcpi->{site}\n"; # ftp://ftp.cpan.org/pub/CPAN

"testremote" accepts an optional parameter to enable verbose mode. 🔊

• "update_mirror" — this is a subclass of CPAN::Mini. 💖
• "add" — add a new distribution to the repository. the add method copies the distribution file into the repository with the same structure as a CPAN site. for example, CPAN-Mini-Inject-0.01.tar.gz with author "SSORICHE" is copied to MYCPAN/authors/id/S/SS/SSORICHE. add creates the required directory structure below the repository. 🌸

packages found in the distribution will be added to the module list. for example both CPAN::Mini::Inject and CPAN::Mini::Inject::Config will be added to the modulelist file in the repository. 🗂️

packages will be looked for in the "provides" key of the META file if present, otherwise the files in the dist will be searched. see Dist::Metadata for more information. 👀

• module — (optional) the package name of the module to add. the distribution file will be searched for modules but you can specify the main one explicitly. 💫
• authorid — (required) the CPAN ID of the module's author. since this isn't actually CPAN, the ID does not need to exist on CPAN. typically, this ID uses "[A-Z]" and is three to ten letters. this is not enforced, but other CPAN tools may not like other sorts of names. 🚨
• version — (optional) the module's version number. if you don't specify this. "add" will try to extract it from the distribution. (yes, that period is in the original. it's part of the lore. 💀)
• file — (required) the path to the distribution file. 📁

$mcpani->add(
  module   => 'Module::Name',
authorid => 'SOMEAUTHOR',
version  => 0.01,
file     => './Module-Name-0.01.tar.gz'
);

• "added_modules" — returns a list of hash references describing the modules added by this instance. each hashref will contain "file", "authorid", and "modules". the "modules" entry is a hashref of module names and versions included in the "file". 🧾

the list is cumulative. there will be one entry for each time "add" was called. 📈

this functionality is mostly provided for the included mcpani script to be able to verbosely print all the modules added. 🗣️

• "inject" — insert modules from the repository into the local CPAN::Mini mirror. inject copies each module into the appropriate directory in the CPAN::Mini mirror and updates the CHECKSUMS file. 🧬

passing a value to "inject" enables verbose mode, which lists each module as it's injected. 📢

• "updpackages" — update the CPAN::Mini mirror's modules/02packages.details.txt.gz with the injected module information. 📦
• "updauthors" — update the CPAN::Mini mirror's authors/01mailrc.txt.gz with stub information should the author not actually exist on CPAN. 👤
• "readlist" — load the repository's modulelist. 📖
• "writelist" — write to the repository modulelist. ✍️

---

👀 SEE ALSO 👀

CPAN::Mini — the blueprint, the blueprint's blueprint. go read it bestie.

---

🫶 Original Author 🫶

Shawn Sorichetti, "<ssoriche@cpan.org>" — the original icon, the blueprint author, periodt. 👑

---

💜 ACKNOWLEDGEMENTS 💜

special thanks to David Bartle, for bringing this module up to date, and resolving the reported bugs. 🛠️✨

thanks to Jozef Kutej <jozef@kutej.net> for numerous patches. 🩹💖

---

🐛 BUGS 🐛

report issues to the GitHub queue at

https://github.com/briandfoy/cpan-mini-inject/issues

bestie, please actually use the queue and not, like, vague-posting about it. 🙏

---

📜 COPYRIGHT AND LICENSE 📜

Copyright 2008-2009 Shawn Sorichetti, Andy Armstrong, All Rights Reserved.

this program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. 🎉

---

and that's the whole page, bestie!! this doc was served up by perl v5.40.1 and dated 2025-04-12, so you know it's fresh-ish. mwah. 💋 go inject something cute into your mirror. 🦋✨🎀