gen-pericmd-completer - Generate Perinci::CmdLine completer script
This document describes version 0.126 of gen-pericmd-completer (from Perl distribution App-GenPericmdCompleterScript), released on 2023-07-11.
gen-pericmd-completer --help (or -h, -?)
gen-pericmd-completer --version (or -v)
gen-pericmd-completer [--completion=code|--completion-json=json] [--config-path=path|-c|--no-config|-C] [--config-profile=profile|-P] [--default-subcommand=str] [--exclude-package-functions-match=re] [--format=name|--json] [--get-subcommand-from-arg=int] [--include-package-functions-match=re] [--interpreter-path=str] [(--load-module=str)+|--load-module-json=json] [--(no)naked-res] [--no-env] [--output-file=filename|-o=filename] [--overwrite|--no-overwrite|--nooverwrite] [--page-result[=program]|--view-result[=program]] [--per-arg-json|--no-per-arg-json|--noper-arg-json] [--per-arg-yaml|--no-per-arg-yaml|--noper-arg-yaml] [--read-config|--no-read-config|--noread-config] [--read-env|--no-read-env|--noread-env] [--skip-format|--no-skip-format|--noskip-format] [--strip|--no-strip|--nostrip] [--subcommands-from-package-functions] [--subcommands=any*|--subcommands-json=json|-s=any*] -- <program_name> <url>
* marks required options.
*
Exclude package functions matching this pattern.
Only include package functions matching this pattern.
What to put on shebang line.
Load extra modules (JSON-encoded).
See --load-module.
--load-module
Load extra modules.
Can be specified multiple times.
Program name that is being completed.
Can also be specified as the 1st command-line argument.
Whether to strip source code using Perl::Stripper.
Form subcommands from functions under package's URL.
This is an alternative to the subcommand option. Instead of specifying each subcommand's name and URL, you can also specify that subcommand names are from functions under the package URL in url. So for example if url is /My/App/, hen all functions under /My/App are listed first. If the functions are:
subcommand
url
/My/App/
/My/App
foo bar baz_qux
then the subcommands become:
foo => /My/App/foo bar => /My/App/bar "baz-qux" => /My/App/baz_qux
Set path to configuration file.
Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).
Set configuration profile to use.
A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:
[profile=dev] username=foo pass=beaver [profile=production] username=bar pass=honey
When you specify --config-profile=dev, username will be set to foo and password to beaver. When you specify --config-profile=production, username will be set to bar and password to honey.
--config-profile=dev
username
foo
password
beaver
--config-profile=production
bar
honey
Do not use any configuration file.
If you specify --no-config, the application will not read any configuration file.
--no-config
Do not read environment for default options.
If you specify --no-env, the application wil not read any environment variable.
--no-env
Choose output format, e.g. json, text.
Default value:
undef
Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.
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:
--naked-res
[1,2,3]
Path to output file.
"-"
Whether to overwrite output if previously exists.
Filter output through a pager.
This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.
less
View output using a viewer.
This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.
See --completion.
--completion
(No description)
1
Valid values:
[0,1,2]
Hash of subcommand names and function URLs (JSON-encoded).
See --subcommands.
--subcommands
Hash of subcommand names and function URLs.
Optionally, it can be additionally followed by a summary, so:
URL[:SUMMARY]
Example (on CLI):
--subcommand "delete=/My/App/delete_item:Delete an item"
URL to function (or package, if you have subcommands) (JSON-encoded).
See --url.
--url
Can also be specified as the 2nd command-line argument.
URL to function (or package, if you have subcommands).
Display help message and exit.
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-pericmd-completer gen-pericmd-completer
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.
To activate tcsh completion for this script, put:
complete gen-pericmd-completer 'p/*/`gen-pericmd-completer`/'
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).
For fish and zsh, install shcompgen as described above.
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): /home/u1/.config/gen-pericmd-completer.conf, /home/u1/gen-pericmd-completer.conf, or /etc/gen-pericmd-completer.conf.
--config-path
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.
[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]
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.
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 ...]
[env=HOSTNAME!*=server ...]
[SOMESECTION env=HOSTNAME!*=server ...]
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:
-plugins
-plugins=DumpArgs
-plugins=DumpArgs@before_validate_args
[plugin=NAME ...]
[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.
-plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2
List of available configuration parameters:
completion (see --completion) default_subcommand (see --default-subcommand) exclude_package_functions_match (see --exclude-package-functions-match) format (see --format) get_subcommand_from_arg (see --get-subcommand-from-arg) include_package_functions_match (see --include-package-functions-match) interpreter_path (see --interpreter-path) load_module (see --load-module) naked_res (see --naked-res) output_file (see --output-file) overwrite (see --overwrite) per_arg_json (see --per-arg-json) per_arg_yaml (see --per-arg-yaml) program_name (see --program-name) read_config (see --read-config) read_env (see --read-env) skip_format (see --skip-format) strip (see --strip) subcommands (see --subcommands) subcommands_from_package_functions (see --subcommands-from-package-functions) url (see --url)
String. Specify additional command-line options.
Please visit the project's homepage at https://metacpan.org/release/App-GenPericmdCompleterScript.
Source repository is at https://github.com/perlancar/perl-App-GenPericmdCompleterScript.
perlancar <perlancar@cpan.org>
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, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2023, 2022, 2021, 2020, 2018, 2017, 2016, 2015 by perlancar <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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-GenPericmdCompleterScript
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 App::GenPericmdCompleterScript, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::GenPericmdCompleterScript
CPAN shell
perl -MCPAN -e shell install App::GenPericmdCompleterScript
For more information on module installation, please visit the detailed CPAN module installation guide.