NAME

SYNOPSIS

    cpanm --local-lib ~/mylib App::local::lib::helper
    ~/mylib/bin/localenv bash

Customizing the helper creation (advanced use only)

    use App::local::lib::helper;
    App::local::lib::helper->run(%opts);

Note, if you don't have "cpanm" already installed you can use the web service version like so instead for all examples:

    curl -L http://cpanmin.us/ | perl - --local-lib ~/mylib App::local::lib::helper

DESCRIPTION

    cpanm --local-lib ~/mylib App::local::lib::helper

Note what is happening. First, you are telling cpanminus to install everything to a local::lib directory called "~/mylib" (cpanminus behind the scenes uses local::lib to do this for you) then you are telling cpanminus to install the distribution App::local::lib::helper into that created local::lib directory. When the "Makefile.PL" script for App::local::lib::helper runs, it notices the fact that it is being asked to install into a locally lib managed directory and will additionally generate a helper script into "~/mylib/bin" called "localenv".

Now, if you want to invoke a perl application and use libs installed into "~/mylib", you can do so like:

    ~/mylib/bin/localenv perl [SOME COMMAND]

The command "localenv" will make sure the same local::lib that was active when App::local::lib::helper was originally installed is again installed into the environment before executing the commands passed in @ARGV. Upon completing the command, the %ENV is restored so that you can use this to fire off an application against a specific local::lib without needing to deal with the details of how to activate the local::lib or how to make sure your %ENV stays clean.

The arguments given to "localenv" don't need to be a perl application. For example, I often like to open a sub shell under a particular local::lib managed directory.

    ~/mylib/bin/localenv bash

Now, if I do:

    perl -V

I'll see that i"~/mylib" has been added to @INC. Additionally, "~/mylib/bin" will have been added to $PATH, so that any command line perl applications installed into the local::lib (such as "ack" or "cpanm") can be accessed easily.

Another example usage would be when you want to install an application from CPAN, install it and all its dependencies to a single directory root and then run it without a lot of effort. For example:

    cpanm --local-lib ~/gitalyst-libs Gitalist App::local::lib::helper
    ~/gitalyst-libs/bin/localenv gitalyst-server.pl

And presto! Your cpan installed application is running, fully self-contained to one root directory all under regular user privileges.

local::lib does all the real work, but I find this to be the easiest way to run given code against a local::lib root.

    source $TARGET/bin/localenv-bashrc

OPTIONS

which_perl

This should be the path to the perl binary that the local::lib is built against. This defaults to the path of the perl binary under which we are currently running. You should probably leave this one alone :)

target

This is the target directory for the local::lib you want to build the helper script against. By default it will attempt to detect the currently running local::lib and use that. If we can't detect a running local::lib and this option is undef, we die with a message.

helper_name

This is the name of the helper utility script. It defaults to 'localenv'.

helper_permissions

These are the permissions the the helper utility script is set to. By default we set the equivilent of 'chmod 755 [HELPER SCRIPT]'

HELPERS

    ~/mylocallib/bin/localenv bash
    ~/mylocallib/bin/localenv screen

    ~/mylocallib/bin/localenv perl app.pl
    ~/mylocallib/bin/localenv plackup app.psgi

    #!/Users/johnn/perl5/perlbrew/perls/perl-5.14.1/bin/perl

    use strict;
    use warnings;

    use lib '/Users/johnn/locallib_5_14_1/lib/perl5';
    use local::lib '/Users/johnn/locallib_5_14_1';

    unless ( caller ) {
        if ( @ARGV ) {
            exec @ARGV;
        }
    }

    #!/usr/bin/env perl

    use strict;
    use warnings;

    use FindBin;
    use File::Spec;
    use lib File::Spec->catdir($FindBin::Bin, '..', 'lib', 'perl5');
    use local::lib File::Spec->catdir($FindBin::Bin, '..');

    unless ( caller ) {
        if ( @ARGV ) {
            exec @ARGV;
        }
    }

    source $HOME/mylocal/localenv-bashrc

AUTHOR

COPYRIGHT & LICENSE

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