NAME

tracepm - Trace dependencies of your Perl script

VERSION

This document describes version 0.12 of tracepm (from Perl distribution App-tracepm), released on 2014-12-26.

SYNOPSIS

Usage:

 % tracepm [options] <script> [args]

OPTIONS

* marks required options.

Field-selection options

--detail

Whether to return records instead of just module names.

Filtering options

--core

Filter only modules that are in core.

--xs

Filter only modules that are XS modules.

General options

--args-json=s

Script arguments (JSON-encoded).

See --args.

--args=s@

Script arguments.

Can be specified multiple times.

--cache-prereqscanner

Whether cache Perl::PrereqScanner{,::Lite} result.

--config-path=s

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--debug

Set log level to debug.

--format=s

Choose output format, e.g. json, text.

--help, -h, -?

Display this help message.

--json

Set output format to json.

--log-level=s

Set log level.

--method=s

Tracing method to use.

Default value:

 "fatpacker"

Valid values:

 ["fatpacker", "require", "prereqscanner", "prereqscanner_lite", "prereqscanner_recurse", "prereqscanner_lite_recurse"]

There are several tracing methods that can be used:

* `fatpacker` (the default): This method uses the same method that `fatpacker trace` uses, which is running the script using `perl -c` then collect the populated `%INC`. Only modules loaded during compile time are detected.

* `require`: This method runs your script normally until it exits. At the start of program, it replaces `CORE::GLOBAL::require()` with a routine that logs the require() argument to the log file. Modules loaded during runtime is also logged by this method. But some modules might not work, specifically modules that also overrides require() (there should be only a handful of modules that do this though).

* `prereqscanner`: This method does not run your Perl program, but statically analyze it using `Perl::PrereqScanner`. Since it uses `PPI`, it can be rather slow.

* `prereqscanner_recurse`: Like `prereqscanner`, but will recurse into all non-core modules until they are exhausted. Modules that are not found will be skipped. It is recommended to use the various `recurse_exclude_*` options options to limit recursion.

* `prereqscanner_lite`: This method is like the `prereqscanner` method, but instead of `Perl::PrereqScanner` it uses `Perl::PrereqScanner::Lite`. The latter does not use `PPI` but use `Compiler::Lexer` which is significantly faster.

* `prereqscanner_lite_recurse`: Like `prereqscanner_lite`, but recurses.

--naked-res

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]

--no-config

Do not use any configuration file.

--perl-version=s, -V

Perl version, defaults to current running version.

This is for determining which module is core (the list differs from version to version. See Module::CoreList for more details.

--quiet

Set log level to quiet.

--recurse-exclude-core

When recursing, exclude core modules.

--recurse-exclude-json=s

When recursing, exclude some modules (JSON-encoded).

See --recurse-exclude.

--recurse-exclude-pattern-json=s

When recursing, exclude some module patterns (JSON-encoded).

See --recurse-exclude-pattern.

--recurse-exclude-pattern=s@

When recursing, exclude some module patterns.

Can be specified multiple times.

--recurse-exclude-xs

When recursing, exclude XS modules.

--recurse-exclude=s@

When recursing, exclude some modules.

Can be specified multiple times.

--script=s*

Path to script file (script to be packed).

--trace

Set log level to trace.

--use-json=s

Additional modules to "use" (JSON-encoded).

See --use.

--use=s@

Additional modules to "use".

This is like running:

    perl -MModule1 -MModule2 script.pl

Can be specified multiple times.

--verbose

Set log level to info.

--version, -v

FILES

/etc/tracepm.conf

~/tracepm.conf

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C tracepm tracepm

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 shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

tcsh

To activate tcsh completion for this script, put:

 complete tracepm 'p/*/`tracepm`/'

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).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-tracepm.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-tracepm.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-tracepm

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 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.

cpanm App::tracepm

perl -MCPAN -e shell
install App::tracepm