CPANPL...mSource(3pm)

💖 CPANPLUS::Shell::Default::Plugins::CustomSource 💖

okay bestie, so this is the CustomSource plugin for CPANPLUS::Shell::Default — it's the lil guy that lets you add custom sources to your CPANPLUS setup. it lives in the CPANPLUS::Shell::Default::Plugins::CustomSource family of things, and honestly? it's giving "I can have my own module index, actually." ✨

---

🌸 SYNOPSIS 🌸

### elaborate help text
CPAN Terminal> /? cs

### add a new custom source
CPAN Terminal> /cs --add file:///path/to/releases

### list all your custom sources by
CPAN Terminal> /cs --list

### display the contents of a custom source by URI or ID
CPAN Terminal> /cs --contents file:///path/to/releases
CPAN Terminal> /cs --contents 1

### Update a custom source by URI or ID
CPAN Terminal> /cs --update file:///path/to/releases
CPAN Terminal> /cs --update 1

### Remove a custom source by URI or ID
CPAN Terminal> /cs --remove file:///path/to/releases
CPAN Terminal> /cs --remove 1

### Write an index file for a custom source, to share
### with 3rd parties or remote users
CPAN Terminal> /cs --write file:///path/to/releases

### Make sure to save your sources when adding/removing
### sources, so your changes are reflected in the cache:
CPAN Terminal> x

---

🎀 DESCRIPTION 🎀

so like, this is a CPANPLUS::Shell::Default plugin whose whole job is adding custom sources to your CPANPLUS installation. it's a wrapper around the "custom module sources" code — the stuff laid out in "CUSTOM MODULE SOURCES" in CPANPLUS::Backend, if you wanna go read the source material (iykyk 🫶).

what that means for you: your index of available modules can go way beyond what's chillin' on "CPAN". your own local distributions? yes. distributions from third parties? also yes. extend the index, bestie 💅

lowkey important: when you're adding or removing sources, make sure to save them so your changes actually land in the cache. the synopsis literally says it — run x. no cap. 😭

---

and that's the whole page, bestie!! 🌈 this one's from perl v5.40.1, dated 2025-03-01 — User Contributed Perl Documentation doing the lord's work, and you read the whole thing like the icon you are. mwah 💖🎀🦋