pmpath - Get path to locally installed Perl module
This document describes version 0.734 of pmpath (from Perl distribution App-PMUtils), released on 2020-06-12.
Basic usage:
% pmpath Some::Module
Find all modules (-a), return absolute paths (-P):
% pmpath -aP Some::Module Another::Mod
Pro-tip: install this bash function to be able to cd quickly to directory of Perl module/prefix (tab completion is also provided):
# function definition cdpm () { if [[ "$1" = "" ]]; then echo "Please specify a Perl module/prefix name"; return; fi local dir=`pmdir "$1"` if [[ "$dir" = "" ]]; then echo "Failed"; else cd "$dir"; fi } # tab completion _cdpm () { local cur=${COMP_WORDS[COMP_CWORD]} COMPREPLY=( `COMP_LINE="pmdir $cur" COMP_POINT=$[6+${#cur}] pmdir` ) } # activate tab completion complete -F _cdpm cdpm
Afterwards, you can:
% cdpm di/zi/pl<tab> % cdpm Dist/Zilla/Plugin/ _
* marks required options.
*
Absolutify each path.
Get all found files for each module instead of the first one.
Show directory instead of path.
Also, will return `.` if not found, so you can conveniently do this on a Unix shell:
% cd `pmpath -Pd Moose`
and it won't change directory if the module doesn't exist.
See --module.
--module
Can be specified multiple times.
Default value:
1
0
Choose output format, e.g. json, text.
undef
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Filter output through a pager.
View output using a viewer.
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C pmpath pmpath
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete pmpath 'p/*/`pmpath`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-PMUtils.
Source repository is at https://github.com/perlancar/perl-App-PMUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PMUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
pmdir
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020, 2019, 2018, 2017, 2016, 2015, 2014 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::PMUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::PMUtils
CPAN shell
perl -MCPAN -e shell install App::PMUtils
For more information on module installation, please visit the detailed CPAN module installation guide.