view release on metacpan or  search on metacpan

README.md  view on Meta::CPAN

In the ["Revs"](#revs) or ["Expression"](#expression), you can specify multiple items joined by
logical operators.  They are listed below in order of descending precedence.
Each operator must be separated by whitespace from any adjacent parameters.
Operators short-circuit.

- **( )**, **\[ \]**

    Grouping.  Parentheses and brackets are interchangeable.

- **-not**, **--not**, **!**, **^**

    Logical negation.

- **-a**, **--a**, **-and**, **--and**, **&&**

    Logical and.  This is the default operator between terms if no operator
    is given.

- **-o**, **--o**, **-or**, **--or**, **||**

    Logical or

- **,** (a single comma)

    Sequence: separates items to be evaluated separately.  The return value
    is that of the last item in the sequence.

## Revs

By default, git-find searches the current index (cache).  This is the same
as the default for git-ls-files(1).
You can specify one or more revs to search using any of the forms described
in [gitrevisions(7)](https://git-scm.com/docs/gitrevisions).

You can specify the special value `]]` (a double right bracket) to search
the working tree that is currently checked out.
(Mnemonic: search _right_ here.)  If you have an actual rev called "\]\]",
git-find won't be able to help you.  Sorry!

    TODO? You can specify multiple ranges of revs separated by C<-o> (or its
    equivalent forms given in L</Operators>) or C<,>.  Comma is treated as
    equivalent to C<-o> when separating revs.

## Expression

The expression includes one or more elements separated by ["Operators"](#operators).
Elements can be options, tests, or operators.

Elements of expressions can be specified in a form similar to find(1).
Long elements (e.g., `-name`) can start with a single or a double dash.

Tests are of two types:

- Index tests

    These are tests that only require information from the git index, such
    as the name of the file and whether it is executable.  They are (at least on
    Unix-like systems):

    `-cmin`, `-cnewer`, `-ctime`, `-empty`, `-executable`, `-false`, `-gid`,
    `-group`, `-ilname`, `-iname`, `-inum`, `-ipath`, `-iregex`,
    `-iwholename`, `-level`, `-mmin`, `-mtime`, `-name`, `-nogroup`,
    `-nouser`, `-path`, `-readable`, `-regex`, `-size`, `-true`, `-type`,
    `-uid`, `-user`, `-wholename`, `-writeable`

        TODO also -links, -lname, -perm, -samefile, -xtype?

- Detailed tests

    All tests other than index tests may require
    checking out a worktree with one or more of the given revs.
    Therefore, they may be much slower than name-only tests.  However, if the only
    rev given is `]]` (working directory), detailed tests can be executed without
    checking out a worktree, so the slowdown is not as bad.

# DIFFERENCES FROM FIND(1)

In git-find but not in find(1): -ref, -rev

In find(1) but not in git-find: find switches; TODO -xtype, -context?

# WARNINGS

If the `-W` option is given, warnings are enabled.  Possible warnings are:

- **-Wdetailed**

    Warn if a detailed test is used on a search scope other than `]]` (the
    current working tree).

# AUTHOR

Christopher White, `<cxw at cpan.org>`

# BUGS

Please report any bugs or feature requests through the GitHub interface at
[https://github.com/cxw42/git-find/issues](https://github.com/cxw42/git-find/issues).  I will be notified, and then
you'll automatically be notified of progress on your bug as I make changes.

# SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc App::GitFind

You can also look for information at:

- GitHub (report bugs here)

    [https://github.com/cxw42/git-find](https://github.com/cxw42/git-find)

- MetaCPAN

    [https://metacpan.org/release/App-GitFind](https://metacpan.org/release/App-GitFind)

# LICENSE AND COPYRIGHT

Copyright 2019 Christopher White.
Portions copyright 2019 D3 Engineering, LLC.