NAME

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

VERSION

This document describes version 0.552 of gen-inline-pericmd-script (from Perl distribution Perinci-CmdLine-Inline), released on 2021-08-29.

SYNOPSIS

Usage:

% gen-inline-pericmd-script [--actions=any] [(--allow-prereq=str)+] [--code-add-extra-log-outputs=str] [--code-after-enable-logging=str] [--code-after-end=str] [--code-after-shebang=str] [--code-before-enable-logging=str] [--code-before-parse-cmdline-options=str] [--common-opts=any] [--completion=any] [(--config-dir=str)+] [--config-filename=any] [--config-path=path|-c|--no-config|-C] [--config-profile=profile|-P] [--debug|--log-level=level|--quiet|--trace|--verbose] [--default-format=any] [--default-subcommand=str] [--description=any] [--env-name=str] [--exit=any] [--extra-urls-for-version=riap::url] [--format=name|--json] [--formats=any] [--get-subcommand-from-arg=any] [(--include=perl::modname)+] [--log|--no-log|--nolog] [--meta-is-normalized|--no-meta-is-normalized|--nometa-is-normalized] [--meta=s] [--(no)naked-res] [--no-env] [--output-file=filename] [--overwrite|--no-overwrite|--nooverwrite] [--pack-deps|--no-pack-deps|--nopack-deps] [--page-result[=program]|--view-result[=program]] [--pass-cmdline-object|--no-pass-cmdline-object|--nopass-cmdline-object] [--pod|--no-pod|--nopod] [--read-config|--no-read-config|--noread-config] [--read-env|--no-read-env|--noread-env] [--riap-client-args=any] [--riap-client=any] [--riap-version=any] [--script-name=str] [--script-summary=str] [--script-version-from-main-version|--no-script-version-from-main-version|--noscript-version-from-main-version] [--script-version=str] [--shebang=str] [--skip-format|--no-skip-format|--noskip-format] [--stripper|--no-stripper|--nostripper] [--sub-name=str] [--subcommands=s] [--tags=any] [--use-cleanser|--no-use-cleanser|--nouse-cleanser] [--use-utf8|--no-use-utf8|--nouse-utf8] [--validate-args|--no-validate-args|--novalidate-args] [--with-debug|--without-debug] [--actions-json=json] [--allow-prereq-json=json] [--common-opts-json=json] [--completion-json=json] [--config-dirs-json=json] [--config-filename-json=json] [--default-format-json=json] [--description-json=json] [--exit-json=json] [--extra-urls-for-version-json=json] [--formats-json=json] [--get-subcommand-from-arg-json=json] [--include-json=json|(-I=perl::modname)+] [--meta-json=json] [--riap-client-args-json=json] [--riap-client-json=json] [--riap-version-json=json] [--subcommands-json=json] [--tags-json=json] [-o=filename] -- [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 the one using Perinci::CmdLine::Lite.

So to reiterate, the goal of this module is to create a Perinci::CmdLine-based script which only requires core modules, and has as little startup overhead as possible.

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

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

As an alternative to this module, if you are looking to reduce dependencies, you might also want to try using depak to fatpack/datapack your Perinci::CmdLine::Lite-based script.

OPTIONS

* marks required options.

Main options

--allow-prereq-json=s

A list of modules that can be depended upon (JSON-encoded).

See --allow-prereq.

--allow-prereq=s@

A list of modules that can be depended upon.

By default, Perinci::CmdLine::Inline will strive to make the script freestanding and require core modules. A dependency to a non-core module will cause failure (unless `pack_deps` option is set to false). However, you can pass a list of modules that is allowed here.

Can be specified multiple times.

--config-dir=s@

Where to search for configuration files.

Can be specified multiple times.

--config-dirs-json=s

Where to search for configuration files (JSON-encoded).

See --config-dir.

--config-filename-json=s

Configuration file name(s) (JSON-encoded).

See --config-filename.

--config-filename=s

Configuration file name(s).

--env-name=s

Name of environment variable name that sets default options.

--include-json=s, -I

Include extra modules (JSON-encoded).

See --include.

--include=s@

Include an extra module.

Can be specified multiple times.

--log

Whether to enable logging.

--no-pack-deps

By default, Perinci::CmdLine::Inline will use datapacking technique (i.e. embed dependencies into DATA section and load it on-demand using require() hook) to make the script freestanding. However, in some situation this is unwanted, e.g. when we want to produce a script that can be packaged as a Debian package (Debian policy forbids embedding convenience copy of code, https://www.debian.org/doc/debian-policy/ch-source.html#s-embeddedfiles ).

--no-pod

--no-read-config

--no-validate-args

--read-env

Whether CLI script should read environment variable that sets default options.

--shebang=s

Set shebang line.

--stripper

Whether to strip code using Perl::Stripper.

Configuration options

--config-path=s, -c: Set path to configuration file.
--config-profile=s, -P: Set configuration profile to use.
--no-config, -C: 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.

Extra code options

--code-add-extra-log-outputs=s
--code-after-enable-logging=s
--code-after-end=s: Put at the very end of generated script.
--code-after-shebang=s: Put at the very beginning of generated script, after the shebang line.
--code-before-enable-logging=s
--code-before-parse-cmdline-options=s

Input options

--default-subcommand=s

--meta-is-normalized

--meta-json=s

An alternative to specifying `url` (JSON-encoded).

See --meta.

--meta=s

An alternative to specifying `url`.

--sub-name=s

--subcommands-json=s

See --subcommands.

--subcommands=s

Logging options

--debug: Shortcut for --log-level=debug.
--log-level=s: Set log level.
--quiet: Shortcut for --log-level=error.
--trace: Shortcut for --log-level=trace.
--verbose: Shortcut for --log-level=info.

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:

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=s, -o

Set output file, defaults to stdout.

--overwrite

--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Pericmd attribute options

--actions-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --actions.

--actions=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--common-opts-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --common-opts.

--common-opts=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--completion-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --completion.

--completion=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--default-format-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --default-format.

--default-format=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--description-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --description.

--description=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--exit-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --exit.

--exit=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--extra-urls-for-version-json=s

More URLs to show version for --version (JSON-encoded).

See --extra-urls-for-version.

--extra-urls-for-version=s

More URLs to show version for --version.

Currently not implemented in Perinci::CmdLine::Inline.

--formats-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --formats.

--formats=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--get-subcommand-from-arg-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --get-subcommand-from-arg.

--get-subcommand-from-arg=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--no-use-cleanser

When a function returns result, and the user wants to display the result as JSON, the result might need to be cleansed first (e.g. using <pm:Data::Clean>) before it can be encoded to JSON, for example it might contain Perl objects or scalar references or other stuffs. If you are sure that your function does not produce those kinds of data, you can set this to false to produce a more lightweight script.

--pass-cmdline-object

Whether to pass Perinci::CmdLine::Inline object.

--riap-client-args-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --riap-client-args.

--riap-client-args=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--riap-client-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --riap-client.

--riap-client=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--riap-version-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --riap-version.

--riap-version=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--script-name=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--script-summary=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--script-version-from-main-version

Use script's $main::VERSION for the version.

--script-version=s

Script version (otherwise will use version from url metadata).

--skip-format

Assume that function returns raw text that need no formatting, do not offer --format, --json, --naked-res.

--tags-json=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).

See --tags.

--tags=s

Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.

--url-json=s

Program URL (JSON-encoded).

See --url.

Can also be specified as the 1st command-line argument.

--url=s

Program URL.

Can also be specified as the 1st command-line argument.

--use-utf8

Whether to set utf8 flag on output.

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 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 modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

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.

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-inline-pericmd-script.conf, ~/gen-inline-pericmd-script.conf, or /etc/gen-inline-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.

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.

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:

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

List of available configuration parameters:

actions (see --actions)
allow_prereq (see --allow-prereq)
code_add_extra_log_outputs (see --code-add-extra-log-outputs)
code_after_enable_logging (see --code-after-enable-logging)
code_after_end (see --code-after-end)
code_after_shebang (see --code-after-shebang)
code_before_enable_logging (see --code-before-enable-logging)
code_before_parse_cmdline_options (see --code-before-parse-cmdline-options)
common_opts (see --common-opts)
completion (see --completion)
config_dirs (see --config-dir)
config_filename (see --config-filename)
default_format (see --default-format)
default_subcommand (see --default-subcommand)
description (see --description)
env_name (see --env-name)
exit (see --exit)
extra_urls_for_version (see --extra-urls-for-version)
format (see --format)
formats (see --formats)
get_subcommand_from_arg (see --get-subcommand-from-arg)
include (see --include)
log (see --log)
log_level (see --log-level)
meta (see --meta)
meta_is_normalized (see --meta-is-normalized)
naked_res (see --naked-res)
output_file (see --output-file)
overwrite (see --overwrite)
pack_deps (see --no-pack-deps)
pass_cmdline_object (see --pass-cmdline-object)
pod (see --no-pod)
read_config (see --no-read-config)
read_env (see --read-env)
riap_client (see --riap-client)
riap_client_args (see --riap-client-args)
riap_version (see --riap-version)
script_name (see --script-name)
script_summary (see --script-summary)
script_version (see --script-version)
script_version_from_main_version (see --script-version-from-main-version)
shebang (see --shebang)
skip_format (see --skip-format)
stripper (see --stripper)
sub_name (see --sub-name)
subcommands (see --subcommands)
tags (see --tags)
url (see --url)
use_cleanser (see --no-use-cleanser)
use_utf8 (see --use-utf8)
validate_args (see --no-validate-args)
with_debug (see --with-debug)

ENVIRONMENT

GEN_INLINE_PERICMD_SCRIPT_OPT => str

Specify additional command-line options.

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.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

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.

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

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.

To install Perinci::CmdLine::Inline, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Perinci::CmdLine::Inline

CPAN shell

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

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

OPTIONS

Main options

Configuration options

Debugging options

Environment options

Extra code options

Input options

Logging options

Output options

Pericmd attribute options

Other options

COMPLETION

bash

tcsh

other shells

CONFIGURATION FILE

ENVIRONMENT

GEN_INLINE_PERICMD_SCRIPT_OPT => str

FILES

HOMEPAGE

SOURCE

AUTHOR

CONTRIBUTING

COPYRIGHT AND LICENSE

BUGS

Module Install Instructions