Git::Helpers - Shortcuts for common Git commands
version 0.000017
use Git::Helpers qw( checkout_root current_branch_name https_remote_url is_inside_work_tree remote_url travis_url ); my $dir = '/path/to/folder/in/git/checkout'; my $root = checkout_root($dir); my $current_branch = current_branch_name(); my $https_remote_url = https_remote_url(); my $inside_work_tree = is_inside_work_tree(); my $remote_url = remote_url('upstream'); my $travis_url = travis_url();
Gives you the root level of the git checkout which you are currently in. Optionally accepts a directory parameter. If you provide the directory parameter, checkout_root will temporarily chdir to this directory and find the top level of the repository.
checkout_root
chdir
This method will throw an exception if it cannot find a git repository at the directory provided.
Returns the name of the current branch.
This is a browser-friendly URL for the remote, fixed up in such a way that GitHub (hopefully) doesn't need to redirect your URL.
Turns git@github.com:oalders/git-helpers.git into https://github.com/oalders/git-helpers
Turns https://github.com/oalders/git-helpers.git into https://github.com/oalders/git-helpers
Defaults to using origin as the remote if none is supplied.
origin
Defaults to master branch, but can also display current branch.
my $current_branch_url = https_remote_url( 'origin', 1 );
Returns true if git rev-parse --is-inside-work-tree returns true. Otherwise returns false. This differs slightly from the behaviour of --is-inside-work-tree in real life, since it returns fatal rather than false if run outside of a git repository.
true
git rev-parse --is-inside-work-tree
false
--is-inside-work-tree
fatal
Returns a URL for the remote you've requested by name. Defaults to 'origin'. Provides you with the exact URL which git returns. Nothing is fixed up for you.
# defaults to 'origin' my $remote_url = remote_url(); # $remote_url is now possibly something like one of the following: # git@github.com:oalders/git-helpers.git # https://github.com/oalders/git-helpers.git # get URL for upstream remote my $upstream_url = remote_url('upstream');
Returns a travis-ci.org URL for the remote you've requested by name. Defaults to 'origin'.
# get Travis URL for remote named "origin" my $origin_travis_url = travis_url(); # get Travis URL for remote named "upstream" my $upstream_travis_url = travis_url('upstream');
Olaf Alders <olaf@wundercounter.com>
This software is copyright (c) 2015-2018 by Olaf Alders.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Git::Helpers, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Git::Helpers
CPAN shell
perl -MCPAN -e shell install Git::Helpers
For more information on module installation, please visit the detailed CPAN module installation guide.