/ 
App-GetoptLongDescriptiveUtils-0.001
River stage one • 1 direct dependent • 1 total dependent
/ detect-getopt-long-descriptive-script

NAME

detect-getopt-long-descriptive-script - Detect whether a file is a Getopt::Long::Descriptive-based CLI script

VERSION

This document describes version 0.001 of detect-getopt-long-descriptive-script (from Perl distribution App-GetoptLongDescriptiveUtils), released on 2016-10-27.

SYNOPSIS

Usage:

% detect-getopt-long-descriptive-script [options] [filename]

DESCRIPTION

The criteria are:

  • the file must exist and readable;

  • (optional, if include_noexec is false) file must have its executable mode bit set;

  • content must start with a shebang #!;

  • either: must be perl script (shebang line contains 'perl') and must contain something like use Getopt::Long::Descriptive;

OPTIONS

* marks required options.

Main options

--filename=s, -f

Path to file to be checked.

--no-include-noexec
--string-base64=s

Path to file to be checked (base64-encoded).

See --string.

--string=s

Path to file to be checked.

Either `file` or `string` must be specified.

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.

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.

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C detect-getopt-long-descriptive-script detect-getopt-long-descriptive-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 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 detect-getopt-long-descriptive-script 'p/*/`detect-getopt-long-descriptive-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).

other shells

For fish and zsh, install shcompgen as described above.

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/detect-getopt-long-descriptive-script.conf, ~/detect-getopt-long-descriptive-script.conf, or /etc/detect-getopt-long-descriptive-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:

filename (see --filename)
format (see --format)
include_noexec (see --no-include-noexec)
naked_res (see --naked-res)
string (see --string)

ENVIRONMENT

DETECT_GETOPT_LONG_DESCRIPTIVE_SCRIPT_OPT => str

Specify additional command-line options

FILES

~/.config/detect-getopt-long-descriptive-script.conf

~/detect-getopt-long-descriptive-script.conf

/etc/detect-getopt-long-descriptive-script.conf

HOMEPAGE

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

SOURCE

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

BUGS

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

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