NAME
App::GitUtils - Day-to-day command-line utilities for git
VERSION
This document describes version 0.07 of App::GitUtils (from Perl distribution App-GitUtils), released on 2018-01-30.
SYNOPSIS
This distribution provides the following command-line utilities:
These utilities provide some shortcuts and tab completion to make it more convenient when working with git con the command-line.
FUNCTIONS
info
Usage:
info() -> [status, msg, result, meta]Return information about git repository.
This function is not exported.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
list_hooks
Usage:
list_hooks() -> [status, msg, result, meta]List available hooks for the repository.
This function is not exported.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
post_commit
Usage:
post_commit() -> [status, msg, result, meta]Run post-commit hook.
Basically the same as:
% .git/hooks/post-commitexcept can be done anywhere inside git repo.
This function is not exported.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
pre_commit
Usage:
pre_commit() -> [status, msg, result, meta]Run pre-commit hook.
Basically the same as:
% .git/hooks/pre-commitexcept can be done anywhere inside git repo.
This function is not exported.
No arguments.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
run_hook
Usage:
run_hook(%args) -> [status, msg, result, meta]Run a hook.
Basically the same as:
% .git/hooks/<hook-name>except can be done anywhere inside git repo and provides tab completion.
This function is not exported.
Arguments ('*' denotes required arguments):
name* => str
Hook name, e.g. post-commit.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
FAQ
What is the purpose of this distribution? Haven't other similar utilities existed?
For example, mpath from Module::Path distribution is similar to pmpath in App::PMUtils, and mversion from Module::Version distribution is similar to pmversion from App::PMUtils distribution, and so on.
True. The main point of these utilities is shell tab completion, to save typing.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-GitUtils.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-GitUtils.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-GitUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
Below is the list of distributions that provide CLI utilities for various purposes, with the focus on providing shell tab completion feature.
App::DistUtils, utilities related to Perl distributions.
App::DzilUtils, utilities related to Dist::Zilla.
App::GitUtils, utilities related to git.
App::IODUtils, utilities related to IOD configuration files.
App::LedgerUtils, utilities related to Ledger CLI files.
App::PlUtils, utilities related to Perl scripts.
App::PMUtils, utilities related to Perl modules.
App::ProgUtils, utilities related to programs.
App::WeaverUtils, utilities related to Pod::Weaver.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2018, 2015, 2014 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.