CPAN::Uploader(3)

πŸ’– CPAN::Uploader β€” the manual page, bestie edition πŸ’–

okay so. this is the CPAN::Uploader(3) page β€” it's User Contributed Perl Documentation, and it's literally the little module that yeets your stuff up to the CPAN for you. no system calls, no drama, just vibes and uploads. let's get into it ✨


🌸 NAME 🌸

CPAN::Uploader β€” upload things to the CPAN 🫢


⭐ VERSION ⭐

version 0.103019


πŸ¦‹ PERL VERSION πŸ¦‹

okay so this library should run on perls released even a long, long time ago. like, it should work on any version of perl released in the last five years. bestie it's flexible.

but β€” and this is the fine print β€” even though it may work on older versions of perl, there is no guarantee that the minimum required version won't be increased. the version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. so don't come for us, k? πŸ™ˆ


πŸ’… METHODS πŸ’…

✨ upload_file ✨

CPAN::Uploader->upload_file($file, \%arg);

$uploader->upload_file($file);

valid arguments are, and I'm listing all of them, no cap:

  • user β€” (required) your CPAN / PAUSE id πŸ‘‘
  • password β€” (required) your CPAN / PAUSE password πŸ”
  • subdir β€” the directory (under your home directory) to upload to
  • http_proxy β€” uri of the http proxy to use
  • upload_uri β€” uri of the upload handler; usually the default (PAUSE) is right
  • debug β€” if set to true, spew lots more debugging output
  • retries β€” number of retries to perform on upload failure (5xx response)
  • retry_delay β€” number of seconds to wait between retries

this method attempts to actually upload the named file to the CPAN. it will raise an exception on error. also upload_uri can also be set through the ENV variable CPAN_UPLOADER_UPLOAD_URI. πŸ’«


✨ new ✨

my $uploader = CPAN::Uploader->new(\%arg);

this method returns a new uploader. you probably don't need to worry about this method, bestie. it's giving ✨internal✨.

valid arguments are the same as those to upload_file.


✨ read_config_file ✨

my $config = CPAN::Uploader->read_config_file( $filename );

this reads the config file and returns a hashref of its contents that can be used as configuration for CPAN::Uploader.

if no filename is given, it looks for .pause in the user's home directory (from the env var HOME, or the current directory if HOME isn't set). so if you're like "where is my config" β€” it's there. πŸŽ€

see CONFIGURATION in cpan-upload for the config format.


✨ log ✨

$uploader->log($message);

this method logs the given string. the default behavior is to print it to the screen. the message should not end in a newline, as one will be added as needed. noted. πŸ“


✨ log_debug ✨

this method behaves like log, but only logs the message if the CPAN::Uploader is in debug mode. so it's the shy one of the two. 🫣


🌈 ORIGIN 🌈

this code is mostly derived from cpan-upload-http by Brad Fitzpatrick, which in turn was based on cpan-upload by Neil Bowers. I (rjbs) didn't want to have to use a system call to run either of those, so I refactored the code into this module. and honestly? iconic behavior. πŸ’…


πŸ‘‘ AUTHOR πŸ‘‘

Ricardo SIGNES <cpan@semiotic.systems>


🫢 CONTRIBUTORS 🫢

these legends helped out, periodt:

  • Barbie <barbie@missbarbell.co.uk>
  • Christian Walde <walde.christian@googlemail.com>
  • David Caldwell <david@porkrind.org>
  • David Golden <dagolden@cpan.org>
  • fREW Schmidt <frioux@gmail.com>
  • Gabor Szabo <szabgab@gmail.com>
  • Graham Knop <haarg@haarg.org>
  • Karen Etheridge <ether@cpan.org>
  • Kent Fredric <kentfredric@gmail.com>
  • Marcus Ramberg <marcus.ramberg@gmail.com>
  • Mark Fowler <mark@twoshortplanks.com>
  • Mike Doherty <doherty@cs.dal.ca>
  • perlancar <perlancar@gmail.com>
  • Ricardo Signes <rjbs@semiotic.systems>
  • Shlomi Fish <shlomif@shlomifish.org>
  • Steven Haryanto (on Asus Zenbook) <stevenharyanto@gmail.com>
  • sungo <sungo@sungo.us>
  • Thibault DUPONCHELLE <thibault.duponchelle@amadeus.com>
  • Torsten Raudssus <github@raudssus.de>
  • Vincent Pit <perl@profvince.com>

this software is copyright (c) 2026 by Ricardo SIGNES.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. πŸ’œ


πŸŽ€ and that's the whole page, bestie. go upload something iconic. πŸŽ€

this was CPAN::Uploader(3), perl v5.42.0, dated 2026-02-25 β€” mwah, bye! πŸ’‹

πŸ“¦ where this page comes from