/ 
App-FileSortUtils-0.009
River stage one • 1 direct dependent • 1 total dependent
/ foremost

NAME

foremost - Return file(s) which are alphabetically the first

VERSION

This document describes version 0.009 of foremost (from Perl distribution App-FileSortUtils), released on 2023-11-26.

SYNOPSIS

foremost --help (or -h, -?)

foremost --version (or -v)

foremost [--all|-a] [--debug|--log-level=level|--quiet|--trace|--verbose] [--detail|-l] [(--dir=dirname)+|--dirs-json=json] [--exclude-filename-pattern=re_from_str|-X=re_from_str] [--format=name|--json] [--ignore-case|-i|--no-ignore-case|--noignore-case] [--include-filename-pattern=re_from_str|-I=re_from_str] [--(no)naked-res] [--num-ranks=uint|-N=uint] [--num-results=uint|-n=uint] [--page-result[=program]|--view-result[=program]] [--recursive|-R] [--type=str|-d|-f|-t=str] -- [dir] ...

DESCRIPTION

Notes:

  • by default dotfiles are not included, use --all (-a) to include them

Some examples:

# return foremost file in current directory
% foremost -f

OPTIONS

* marks required options.

Main options

--num-ranks=s, -N

Number of ranks to return.

Difference between num_results and num_ranks: num_results (-n option) specifies number of results regardless of ranks while num_ranks (-N option) returns number of ranks. For example, if sorting is by reverse size and if num_results is set to 1 and there are 2 files with the same largest size then only 1 of those files will be returned. With num_ranks set to 1, both files will be returned because are they both rank #1.

--num-results=s, -n

Number of results to return.

Filtering options

--all, -a

Do not ignore entries starting with ..

--exclude-filename-pattern=s, -X

Exclude filenames that match a regex pattern.

--include-filename-pattern=s, -I

Only include filenames that match a regex pattern.

--type=s, -t

Only include files of certain type.

Valid values:

["file","dir"]
-d

Shortcut for `--type=dir`.

See --type.

-f

Shortcut for `--type=file`.

See --type.

Input options

--dir=s@

Directory to sort files of, defaults to current directory.

Default value:

["."]

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

Can be specified multiple times.

--dirs-json=s

Directory to sort files of, defaults to current directory (JSON-encoded).

See --dir.

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

--recursive, -R

Recurse into subdirectories.

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

--detail, -l

(No description)

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

Sorting options

--ignore-case, -i

(No description)

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

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

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

SOURCE

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

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

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.