view release on metacpan or  search on metacpan

bin/git-codeowners  view on Meta::CPAN

    git clone https://github.com/chazmcgarvey/git-codeowners.git
    cd git-codeowners
    make bootstrap      # installs dependencies; requires cpanm

=head1 OPTIONS

=head2 --version

Print the program name and version to C<STDOUT>, and exit.

Alias: C<-v>

=head2 --help

Print the synopsis to C<STDOUT>, and exit.

Alias: C<-h>

You can also use C<--manual> to print the full documentation.

=head2 --color

Enable colorized output.

Color is ON by default on terminals; use C<--no-color> to disable. Some environment variables may
also alter the behavior of colorizing output:

=over 4

=item *

C<NO_COLOR> - Set to disable color (same as C<--no-color>).

=item *

C<COLOR_DEPTH> - Set the number of supportable colors (e.g. 0, 16, 256, 16777216).

=back

=head2 --format

Specify the output format to use. See L</FORMAT>.

Alias: C<-f>

=head2 --shell-completion

    eval "$(git-codeowners --shell-completion)"

Print shell code to enable completion to C<STDOUT>, and exit.

Does not yet support Zsh...

=head1 COMMANDS

=head2 show

    git-codeowners [show] [--format FORMAT] [--owner OWNER]...
                   [--pattern PATTERN]... [--[no-]patterns]
                   [--project PROJECT]... [--[no-]projects] [PATH...]
                   [--[no-]expand-aliases]

Show owners of one or more files in a repo.

If C<--owner>, C<--project>, C<--pattern> are set, only show files with matching
criteria. These can be repeated.

Use C<--patterns> to also show the matching pattern associated with each file.

By default the output might show associated projects if the C<CODEOWNERS> file
defines them. You can control this by explicitly using C<--projects> or
C<--no-projects> to always show or always hide defined projects, respectively.

Use C<--expand-aliases> to show owners that are group aliases defined in the
F<CODEOWNERS> file as their aliased owners.

=head2 owners

    git-codeowners owners [--format FORMAT] [--pattern PATTERN]

List all owners defined in the F<CODEOWNERS> file.

=head2 patterns

    git-codeowners patterns [--format FORMAT] [--owner OWNER]

List all patterns defined in the F<CODEOWNERS> file.

=head2 create

    git-codeowners create [REPO_DIRPATH|CODEOWNERS_FILEPATH]

Create a new F<CODEOWNERS> file for a specified repo (or current directory).

=head2 update

    git-codeowners update [REPO_DIRPATH|CODEOWNERS_FILEPATH]

Update the "unowned" list of an existing F<CODEOWNERS> file for a specified
repo (or current directory).

=head1 FORMAT

The C<--format> argument can be one of:

=over 4

=item *

C<csv> - Comma-separated values (requires L<Text::CSV>)

=item *

C<json:pretty> - Pretty JSON (requires L<JSON::MaybeXS>)

=item *

C<json> - JSON (requires L<JSON::MaybeXS>)

=item *

C<table> - Table (requires L<Text::Table::Any>)

=item *

C<tsv> - Tab-separated values (requires L<Text::CSV>)

=item *

C<yaml> - YAML (requires L<YAML>)

=item *

C<FORMAT> - Custom format (see below)