gen-inline-pericmd-script - Generate inline Perinci::CmdLine CLI script
This document describes version 0.31 of gen-inline-pericmd-script (from Perl distribution Perinci-CmdLine-Inline), released on 2015-11-28.
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::Lite
Perinci::CmdLine::Classic
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 http://example.org/Foo/bar);
/Foo/bar
http://example.org/Foo/bar
No subcommands support yet;
No support for per_arg_yaml (not used as often as per_arg_json, no core module for parsing YAML).
and so on.
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
TODO:
Option to validate argument (embedding code generated by periswrap).
* marks required options.
*
Set path to configuration file.
Can be specified multiple times.
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`.
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 --config-dirs.
--config-dirs
See --config-filename.
--config-filename
See --default-subcommand.
--default-subcommand
See --description.
--description
See --env-name.
--env-name
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 --read-config.
--read-config
See --read-env.
--read-env
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 --subcommands.
--subcommands
See --tags.
--tags
Program URL.
Display help message and exit.
Include extra modules (JSON-encoded).
See --include.
--include
Include an extra module.
Set shebang line.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
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.
~/.bashrc
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.
shcompgen
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.
~/.tcshrc
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Specify additional command-line options
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.
~/.config/gen-inline-pericmd-script.conf
~/gen-inline-pericmd-script.conf
/etc/gen-inline-pericmd-script.conf
--config-path
To disable searching for configuration files, pass --no-config.
--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.
[profile=SOMENAME]
--config-profile SOMENAME
List of available configuration parameters:
actions (see --actions) 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-dirs) config_filename (see --config-filename) 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) meta (see --meta) meta_is_normalized (see --meta-is-normalized) naked_res (see --naked-res) output_file (see --output-file) overwrite (see --overwrite) pass_cmdline_object (see --pass-cmdline-object) read_config (see --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) validate_args (see --no-validate-args) with_debug (see --with-debug)
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) 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.
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.