gen-inline-pericmd-script - Generate inline Perinci::CmdLine CLI script
This document describes version 0.46 of gen-inline-pericmd-script (from Perl distribution Perinci-CmdLine-Inline), released on 2017-01-12.
Usage:
% gen-inline-pericmd-script [options] [url]
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).
Perinci::CmdLine::*
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);
/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.
depak
* marks required options.
*
A list of modules that can be depended upon (JSON-encoded).
See --allow-prereq.
--allow-prereq
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.
Where to search for configuration files.
Where to search for configuration files (JSON-encoded).
See --config-dir.
--config-dir
Configuration file name(s) (JSON-encoded).
See --config-filename.
--config-filename
Configuration file name(s).
Name of environment variable name that sets default options.
Include extra modules (JSON-encoded).
See --include.
--include
Include an extra module.
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 ).
Whether CLI script should read environment variable that sets default options.
Set shebang line.
Set path to configuration file.
Set configuration profile to use.
Do not use any configuration file.
Generate script with debugging outputs.
Do not read environment for default options.
An alternative to specifying `url` (JSON-encoded).
See --meta.
--meta
An alternative to specifying `url`.
See --subcommands.
--subcommands
Set log level to debug (note: you also need to set LOG=1 to enable logging, or use DEBUG=1).
Set log level (note: you also need to set LOG=1 to enable logging).
Set log level to quiet (note: you also need to set LOG=1 to enable logging, or use QUIET=1).
Set log level to trace (note: you also need to set LOG=1 to enable logging, or use TRACE=1).
Set log level to info (note: you also need to set LOG=1 to enable logging, or use VERBOSE=1).
Choose output format, e.g. json, text.
Default value:
undef
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]
Set output file, defaults to stdout.
Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base (JSON-encoded).
See --actions.
--actions
Currently does nothing, provided only for compatibility with Perinci::CmdLine::Base.
See --common-opts.
--common-opts
See --completion.
--completion
See --default-format.
--default-format
See --description.
--description
See --exit.
--exit
More URLs to show version for --version (JSON-encoded).
See --extra-urls-for-version.
--extra-urls-for-version
More URLs to show version for --version.
Currently not implemented in Perinci::CmdLine::Inline.
See --formats.
--formats
See --get-subcommand-from-arg.
--get-subcommand-from-arg
See --log.
--log
Whether to pass Perinci::CmdLine::Inline object.
See --riap-client-args.
--riap-client-args
See --riap-client.
--riap-client
See --riap-version.
--riap-version
Script version (otherwise will use version from url metadata).
Assume that function returns raw text that need no formatting, do not offer --format, --json, --naked-res.
See --tags.
--tags
Program URL.
Whether to set utf8 flag on output.
Display help message and exit.
Display program's version and exit.
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.
--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]
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.
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 ...]
List of available configuration parameters:
actions (see --actions) allow_prereq (see --allow-prereq) code_after_end (see --code-after-end) code_after_shebang (see --code-after-shebang) 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) shebang (see --shebang) skip_format (see --skip-format) sub_name (see --sub-name) subcommands (see --subcommands) tags (see --tags) url (see --url) use_utf8 (see --use-utf8) validate_args (see --no-validate-args) with_debug (see --with-debug)
Specify additional command-line options
~/.config/gen-inline-pericmd-script.conf
~/gen-inline-pericmd-script.conf
/etc/gen-inline-pericmd-script.conf
Please visit the project's homepage at https://metacpan.org/release/Perinci-CmdLine-Inline.
Source repository is at https://github.com/perlancar/perl-Perinci-CmdLine-Inline.
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.
perlancar <perlancar@cpan.org>
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.
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.