/ 
App-PericmdUtils-0.04
River stage one • 1 direct dependent • 1 total dependent
/ gen-pod-for-pericmd-script

NAME

gen-pod-for-pericmd-script - Generate POD for Perinci::CmdLine-based CLI script

VERSION

This document describes version 0.04 of gen-pod-for-pericmd-script (from Perl distribution App-PericmdUtils), released on 2017-01-13.

SYNOPSIS

Usage:

% gen-pod-for-pericmd-script [options]

DESCRIPTION

This utility can accept either a path to a Perinci::CmdLine-based CLI script, upon which the arguments to Perinci::CmdLine constructor will be extracted using a script dumper (Perinci::CmdLine::Dump), or a set of arguments to specify Perinci::CmdLine constructor arguments directly (e.g. url, summary, subcommands, etc).

OPTIONS

* marks required options.

Main options

--completer-script=s

Script name for shell completion.

A special value of `:self` means this script can complete itself.

Configuration options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--no-config

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Input options

--common-opts-json=s

See --common-opts.

--common-opts=s
--config-dirs-json=s

See --config-dirs.

--config-dirs=s@

Can be specified multiple times.

--config-filename-json=s

See --config-filename.

--config-filename=s
--default-subcommand=s
--env-name=s
--per-arg-json
--per-arg-yaml
--program-name=s
--read-config
--read-env
--script=s

Path to script.

--subcommands-json=s

See --subcommands.

--subcommands=s
--summary=s
--url=s

Output options

--format=s

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

Default value:

undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

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]

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

CONFIGURATION FILE

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): ~/.config/gen-pod-for-pericmd-script.conf, ~/gen-pod-for-pericmd-script.conf, or /etc/gen-pod-for-pericmd-script.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --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.

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.

Finally, you can 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 has value equals something: [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 something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [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.

List of available configuration parameters:

common_opts (see --common-opts)
completer_script (see --completer-script)
config_dirs (see --config-dirs)
config_filename (see --config-filename)
default_subcommand (see --default-subcommand)
env_name (see --env-name)
format (see --format)
naked_res (see --naked-res)
per_arg_json (see --per-arg-json)
per_arg_yaml (see --per-arg-yaml)
program_name (see --program-name)
read_config (see --read-config)
read_env (see --read-env)
script (see --script)
subcommands (see --subcommands)
summary (see --summary)
url (see --url)

ENVIRONMENT

GEN_POD_FOR_PERICMD_SCRIPT_OPT => str

Specify additional command-line options

FILES

~/.config/gen-pod-for-pericmd-script.conf

~/gen-pod-for-pericmd-script.conf

/etc/gen-pod-for-pericmd-script.conf

HOMEPAGE

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

SOURCE

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

BUGS

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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