NAME

gen-inline-pericmd-script - Generate inline Perinci::CmdLine CLI script

VERSION

This document describes version 0.02 of gen-inline-pericmd-script (from Perl distribution Perinci-CmdLine-Inline), released on 2015-05-25.

SYNOPSIS

Usage:

 % gen-inline-pericmd-script [options] [url]

DESCRIPTION

The goal of this module is to let you create a CLI script from a Riap function/metadata. This is like what Perinci::CmdLine::Lite or Perinci::CmdLine::Classic does, except that the generated CLI script will have the functionalities inlined so it only need core Perl modules and not any of the Perinci::CmdLine::* or other modules to run (excluding what modules the Riap function itself requires).

It's useful if you want a CLI script that is even more lightweight (in terms of startup overhead or dependencies) than one using Perinci::CmdLine::Lite.

Currently it only supports a subset of features compared to other Perinci::CmdLine::* implementations:

• Only support local Riap URL (e.g. /Foo/bar, not http://example.org/Foo/bar);

• No tab completion;

• No subcommands support yet;

• No support for streaming input or output;

• No support for cmdline_src argument specification property;

• No support for per_arg_yaml (not used as often as per_arg_json, no core module for parsing YAML).

• and so on.

TODO:

• Option to validate argument (using periswrap).

• Support per_arg_json.

OPTIONS

* marks required options.

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.

Debugging options

--with-debug

Generate script with debugging outputs.

Environment options

--no-env

Do not read environment for default options.

Input options

--meta-is-normalized

--meta-json=s

See --meta.

--meta=s

--sub-name=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]

--output-file=filename, -o

Set output file, defaults to stdout.

--overwrite

Other options

--help, -h, -?

Display help message and exit.

--no-validate-args

--program-name=s

--shebang=s

Set shebang line.

--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 gen-inline-pericmd-script gen-inline-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 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 gen-inline-pericmd-script 'p/*/`gen-inline-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).

other shells

For fish and zsh, install shcompgen as described above.

ENVIRONMENT

• GEN_INLINE_PERICMD_SCRIPT_OPT

  Specify additional command-line options

CONFIGURATION FILE

This script can read configuration file, which by default is searched at ~/.config/gen-inline-pericmd-script.conf, ~/gen-inline-pericmd-script.conf or /etc/gen-inline-pericmd-script.conf (can be changed by specifying --config-path). All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

Configuration file is in the format of IOD, which is basically INI with some extra features.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

List of available configuration parameters:

 format (see --format)
 meta (see --meta)
 meta_is_normalized (see --meta-is-normalized)
 naked_res (see --naked-res)
 output_file (see --output-file)
 overwrite (see --overwrite)
 program_name (see --program-name)
 shebang (see --shebang)
 sub_name (see --sub-name)
 url (see --url)
 validate_args (see --no-validate-args)
 with_debug (see --with-debug)

FILES

~/.config/gen-inline-pericmd-script.conf

~/gen-inline-pericmd-script.conf

/etc/gen-inline-pericmd-script.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-CmdLine-Inline.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-CmdLine-Inline.

BUGS

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

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) 2015 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 Perinci::CmdLine::Inline

perl -MCPAN -e shell
install Perinci::CmdLine::Inline