dump-pericmd-script - Run a Perinci::CmdLine-based script but only to dump the object
This document describes version 0.054 of dump-pericmd-script (from Perl distribution App-PericmdUtils), released on 2022-05-27.
% dump-pericmd-script [--config-path=path|-c|--no-config|-C] [--config-profile=profile|-P] [--format=name|--json] [(--lib=str)+] [--method=str] [--(no)naked-res] [--no-env] [--page-result[=program]|--view-result[=program]] [--skip-detect|-D] [--libs-json=json|(-I=str)+] -- <filename>
This function runs a CLI script that uses Perinci::CmdLine (or its variant Perinci::CmdLine::Lite or Perinci::CmdLine::Any) but monkey-patches Perinci::CmdLine::Base beforehand so that run() will dump the object and then exit. The goal is to get the object without actually running the script.
Perinci::CmdLine
Perinci::CmdLine::Lite
Perinci::CmdLine::Any
Perinci::CmdLine::Base
run()
This can be used to gather information about the script and then generate documentation about it (e.g. Pod::Weaver::Plugin::Rinci to insert POD sections based on information from the Rinci metadata of the function used by the script) or do other things (e.g. App::shcompgen to generate a completion script for the original script).
Pod::Weaver::Plugin::Rinci
App::shcompgen
CLI script needs to use Perinci::CmdLine. This is detected currently by a simple regex. If script is not detected as using Perinci::CmdLine, status 412 is returned.
Will return the Perinci::CmdLine object dump. In addition to that, if detected that script refers to function URL /main (which might mean that function metadata is embedded in the script itself and not in a separate module), will also dump the target function's metadata in func.meta in this function's result metadata.
/main
func.meta
* marks required options.
*
Path to the script.
Can also be specified as the 1st command-line argument.
Libraries to unshift to @INC when running script.
Can be specified multiple times.
Libraries to unshift to @INC when running script (JSON-encoded).
See --lib.
--lib
Valid values:
["patch","self-dump"]
The `patch` method is using monkey-patching to replace run() with a routine that dumps the object and exit. This has a disadvantage of exiting too early, for example some attributes like `common_opts` is filled during run(). Another method is `self-dump` that requires <pm:Perinci::CmdLine::Lite> version 1.73 or later.
The default is to use `self-dump`, but `patch` for /main/.
Set path to configuration file.
Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).
Set configuration profile to use.
A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:
[profile=dev] username=foo pass=beaver [profile=production] username=bar pass=honey
When you specify `--config-profile=dev`, `username` will be set to `foo` and `password` to `beaver`. When you specify `--config-profile=production`, `username` will be set to `bar` and `password` to `honey`.
Do not use any configuration file.
If you specify `--no-config`, the application will not read any configuration file.
Do not read environment for default options.
If you specify `--no-env`, the application wil not read any environment variable.
Choose output format, e.g. json, text.
Default value:
undef
Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.
Set output format to json.
When outputing as JSON, strip result envelope.
0
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.
This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. `less` is chosen.
View output using a viewer.
This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.
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 dump-pericmd-script dump-pericmd-script
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 dump-pericmd-script 'p/*/`dump-pericmd-script`/'
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.
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): /home/u1/.config/dump-pericmd-script.conf, /home/u1/dump-pericmd-script.conf, or /etc/dump-pericmd-script.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--no-config
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
--config-profile SOMENAME
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [SOMESECTION env=HOSTNAME!*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
[env=HOSTNAME!*=server ...]
[SOMESECTION env=HOSTNAME!*=server ...]
To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:
-plugins
-plugins=DumpArgs
-plugins=DumpArgs@before_validate_args
[plugin=NAME ...]
[plugin=DumpArgs] -event=before_validate_args -prio=99 [plugin=Foo] -event=after_validate_args arg1=val1 arg2=val2
which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.
-plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2
List of available configuration parameters:
filename (see --filename) format (see --format) libs (see --lib) method (see --method) naked_res (see --naked-res) skip_detect (see --skip-detect)
Specify additional command-line options.
/home/u1/.config/dump-pericmd-script.conf
/home/u1/dump-pericmd-script.conf
/etc/dump-pericmd-script.conf
Please visit the project's homepage at https://metacpan.org/release/App-PericmdUtils.
Source repository is at https://github.com/perlancar/perl-App-PericmdUtils.
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2021, 2017, 2016, 2015 by perlancar <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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PericmdUtils
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.
To install App::PericmdUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::PericmdUtils
CPAN shell
perl -MCPAN -e shell install App::PericmdUtils
For more information on module installation, please visit the detailed CPAN module installation guide.