The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.


App::GitHub::FindRepository - Determine the right case for a GitHub repository


Version 0.06


    github-find-repository git://
    # git://

    github-find-repository robertkrimen,Doc-Simply
    # git://

    github-find-repository --pinger=./bin/git-ls-remote ...

    # ... or ...

    use App::GitHub::FindRepository

    my $url = App::GitHub::FindRepository->find( robertkrimen/Doc-Simply )
    # git://


GitHub recently made a change that now allows mixed-case repository names. Unfortunately, their git daemon will not find the right repository given the wrong case.

App::GitHub::FindRepository (github-find-repository) will interrogate the repository home page (HTML), looking for the "right" repository name in a case insensitive manner

If LWP is not installed and curl is not available, then the finder will fallback to using the git protocol (via git-ls-remote or git-peek-remote). It will first attempt to ping the mixed-case version, and, failing that, will attempt to ping the lowercase version.

In either case, it will return/print the valid repository url, if any


When finding via the git protocol, the following applies:

Given a mixed-case repository, the find routine will try the mixed-case once, then the lowercase. It will not find anything else

    github-find-repository --git-protocol robertkrimen/Doc-Simply

...will work, as long as the real repository is robertkrimen/Doc-Simply.git or robertkrimen/doc-simply.git

If the real repository is robertkrimen/dOc-sImPlY.git then the finder will NOT see it


You can install App::GitHub::FindRepository by using CPAN:

    cpan -i App::GitHub::FindRepository

If that doesn't work properly, you can find help at: # Help on Mac OS X # Help with a non-root account


You can contribute or fork this project via GitHub:

    git clone git://



A commandline application that will print out the the repository with the right casing

    Usage: github-find-repository [...] <repository>

        --pinger <pinger>   The pinger to use (default is either git-ls-remote or git-peek-remote)

        --getter <getter>   The getter to use (default is LWP then curl)

        --git-protocol      Don't try to determine the repository by sniffing HTML, just use git://
                            NOTE: This mode will only check the given casing then lowercase

        --output <output>   One of (case insensitive):

                            Given ""

                            public   git://
                            base     robertkrimen/App-GitHub-FindRepository
                            name     App-GitHub-FindRepository

        --help, -h, -?      This help

        <repository>        The repository to test, can be like:


    For example:

        github-find-repository --getter curl robertkrimen,aPp-giTHuB-findRepOsitory

$repository = AppGitHub::FindRepository->find( <repository> [, ...] )

Given a mixed-case repository URI, it will return the version with the right case

    getter  The method to use to access the repository home page (HTML)
    pinger  The pinger to use to access the repository via the git protocol

$repository = AppGitHub::FindRepository->find_by_git( <repository> [, ...] )

    pinger  The pinger to use to access the repository via the git protocol

Given a mixed-case repository URI, it will return the version with the right case, but only using the git protocol

NOTE: This method will only check the given casing then lowercase. See CAVEAT


The repository object that ->find and ->find_by_git return

The object will stringify via the ->url method


The URL (URI) of the repository (depends on what the object was instantiated with)


The public github clone URL:



The private github clone URL:<base>.git


The user/project part of the repository path (WITHOUT the .git suffix):



The name of the project:



The home page of the project on GitHub:<base> # Will redirect to .../tree/master

A bash function as an alternative

If you do not want to install App::GitHub::FindRepository, here is a bash equivalent (using the git protocol, see CAVEAT):


    function github-find-repository() {
        local pinger=`which git-ls-remote`
        if [ "$pinger" == "" ]; then pinger=`which git-peek-remote`; fi
        if [ "$pinger" == "" ]; then echo "Couldn't find pinger (git-ls-remote or git-peek-remote)"; return -1; fi
        local repository=$1
        if [ "`$pinger $repository 2>/dev/null`" ]; then echo $repository; return 0; fi
        repository=`echo $repository | tr "[:upper:]" "[:lower:]" `
        if [ "`$pinger $repository 2>/dev/null`" ]; then echo $repository; return 0; fi
        return -1

    github-find-repository $*




Robert Krimen, <rkrimen at>


Please report any bugs or feature requests to bug-app-github-findrepository at, or through the web interface at I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.


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

    perldoc App::GitHub::FindRepository

You can also look for information at:



Copyright 2009 Robert Krimen, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.