/ 
App-CompleteCLIs-0.153
River stage one • 1 direct dependent • 1 total dependent
/ complete-file

NAME

complete-file - Complete file and directory from local filesystem

VERSION

This document describes version 0.153 of complete-file (from Perl distribution App-CompleteCLIs), released on 2023-12-01.

SYNOPSIS

complete-file --help (or -h, -?)

complete-file --version (or -v)

complete-file [--allow-dot|--disallow-dot] [--debug|--log-level=level|--quiet|--trace|--verbose] [--exclude-dir|--include-dir] [--exclude-leaf|--include-leaf] [--file-ext-filter=any|--file-ext-filter-json=json] [--file-regex-filter=re] [--filter=any|--filter-json=json] [--format=name|--json] [--handle-tilde|--no-handle-tilde|--nohandle-tilde] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--recurse|-r|--no-recurse|--norecurse] [--recurse-matching=str] [--starting-path=str] -- <word>

OPTIONS

* marks required options.

Main options

--disallow-dot

This is most useful when combined with starting_path option to prevent user going up/outside the starting path.

--exclude-dir

(No description)

--exclude-leaf

(No description)

--no-handle-tilde

(No description)

--recurse, -r

(No description)

--recurse-matching=s

Default value:

"level-by-level"

Valid values:

["level-by-level","all-at-once"]
--starting-path=s

Default value:

"."
--word=s*

Word to complete.

Default value:

""

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

Filtering options

--file-ext-filter-json=s

See --file-ext-filter.

--file-ext-filter=s

This is also an alternative to specifying full filter or file_regex_filter. You can set this to a regex or a set of extensions to accept. Note that like in file_regex_filter, directories of any name is also still allowed.

--file-regex-filter=s

Filter shortcut for file regex.

This is a shortcut for constructing a filter. So instead of using filter, you use this option. This will construct a filter of including only directories or regular files, and the file must match a regex pattern. This use-case is common.

--filter-json=s

Only return items matching this filter (JSON-encoded).

See --filter.

--filter=s

Only return items matching this filter.

Filter can either be a string or a code.

For string filter, you can specify a pipe-separated groups of sequences of these characters: f, d, r, w, x. Dash can appear anywhere in the sequence to mean not/negate. An example: f means to only show regular files, -f means only show non-regular files, drwx means to show only directories which are readable, writable, and executable (cd-able). wf|wd means writable regular files or writable directories.

For code filter, you supply a coderef. The coderef will be called for each item with these arguments: $name. It should return true if it wants the item to be included.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

By default, these log levels are available (in order of increasing level of importance, from least important to most): trace, debug, info, warn/warning, error, fatal. By default, the level is usually set to warn, which means that log statements with level info and less important levels will not be shown. To increase verbosity, choose info, debug, or trace.

For more details on log level and logging, as well as how new logging levels can be defined or existing ones modified, see Log::ger.

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

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.

--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]
--page-result

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.

--view-result

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.

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 complete-file complete-file

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 complete-file 'p/*/`complete-file`/'

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.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-CompleteCLIs.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-CompleteCLIs.

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

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2021, 2020, 2019, 2017, 2016, 2015, 2014 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.

BUGS

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

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.