view release on metacpan or  search on metacpan

README  view on Meta::CPAN

    executable:

        curl -OL https://raw.githubusercontent.com/chazmcgarvey/git-codeowners/solo/git-codeowners
        chmod +x git-codeowners

    To hack on the code, clone the repo instead:

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

OPTIONS

 --version

    Print the program name and version to STDOUT, and exit.

    Alias: -v

 --help

    Print the synopsis to STDOUT, and exit.

    Alias: -h

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

 --color

    Enable colorized output.

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

      * NO_COLOR - Set to disable color (same as --no-color).

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

 --format

    Specify the output format to use. See "FORMAT".

    Alias: -f

 --shell-completion

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

    Print shell code to enable completion to STDOUT, and exit.

    Does not yet support Zsh...

COMMANDS

 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 --owner, --project, --pattern are set, only show files with matching
    criteria. These can be repeated.

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

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

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

 owners

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

    List all owners defined in the CODEOWNERS file.

 patterns

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

    List all patterns defined in the CODEOWNERS file.

 create

        git-codeowners create [REPO_DIRPATH|CODEOWNERS_FILEPATH]

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

 update

        git-codeowners update [REPO_DIRPATH|CODEOWNERS_FILEPATH]

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

FORMAT

    The --format argument can be one of:

      * csv - Comma-separated values (requires Text::CSV)

      * json:pretty - Pretty JSON (requires JSON::MaybeXS)

      * json - JSON (requires JSON::MaybeXS)

      * table - Table (requires Text::Table::Any)

      * tsv - Tab-separated values (requires Text::CSV)

      * yaml - YAML (requires YAML)

      * FORMAT - Custom format (see below)

 Format string

    You can specify a custom format using printf-like format sequences.
    These are the items that can be substituted:

      * %F - Filename

      * %O - Owner or owners

      * %P - Project

      * %T - Pattern

      * %n - newline