xref: /dports/devel/p5-App-GitGot/App-GitGot-1.339/bin/got

#! /usr/bin/env perl
# ABSTRACT: A tool to make it easier to manage multiple code repositories using different VCSen
# PODNAME: got


use 5.014;    # strict, unicode_strings
use warnings;

use App::GitGot;
App::GitGot->run;

__END__

=pod

=encoding UTF-8

=head1 NAME

got - A tool to make it easier to manage multiple code repositories using different VCSen

=head1 VERSION

version 1.339

=head1 SYNOPSIS

    cd some/proj/in/a/vcs

    got add
    # answer prompts for various information
    # or run with '-D' to take all defaults

    # show managed repositories
    got list
    got ls

    # run a command in selected repositories
    got do --tag perl --command "ls t/"

    # show managed repositories sorted by path (default = sort by name)
    got ls -p

    # remove repo #1 from the list
    got remove 1

    # remove repo named 'bar' from the list
    got remove bar

    # remove all repos tagged 'foo' without confirmation prompts
    got rm -f -t foo

    # remove repo #3 without confirmation prompts and be noisy about it
    got rm -f -v 3

    # show status (up-to-date, dirty, etc.) for all repos
    got status

    # show status for repo #3
    got st 3

    # fetch upstream for all repositories
    got fetch

    # fetch upstream for repo #3
    got fetch 3

    # update all repos with configured remotes
    got update

    # update repo named 'bar'
    got up bar

    # Note: if a repo is in the list but doesn't have a local checkout, 'got
    # update' will create directories as needed and do the initial check out.

    # Run the 'git gc' command to garbage collect in git repos
    got gc

    # spawn a subshell with working directory set to 'path' of repo #1
    got chdir 1

    # spawn a subshell with working directory set to 'path' of repo foo
    got cd foo

    # or use 'tmux' subcommand to open a new tmux window instead
    got tmux 1
    got tmux foo
    # N.b., 'tmux' will reuse an existing window if one is open

    # checkout a local working copy of a repo and add it to your list of repos.
    # will prompt for info on what to name repo, tags, etc.
    got clone <git/http/ssh url>

    # As above, but accept defaults for all options without prompting
    got clone -D <git/http/ssh url>

    # fork a github repo, add it to your list of repos, and check it out in
    # the current working directory
    got fork https://github.com/somebodies/repo_name

    # note: the default path to a repo added via 'fork' is a directory
    # named 'repo_name' in the current working directory

    # if you just want to fork without checking out a working copy:
    got fork --noclone https://github.com/somebodies/repo_name

    # finally, please note that you need a C<~/.github-identity> file set up
    # with your access token or your username and password in the following key-value
    # format:
    user username
    pass password

    # *OR*
    access_token token

    # note that if you specify both, the access_token value will be used

    # show version of got
    got version

=head1 DESCRIPTION

C<got> is a script to make it easier to manage all the version controlled
repositories you have on all the computers you use. It can operate on all,
some, or just one repo at a time, to both check the status of the repo (up to
date, pending changes, dirty, etc.) and sync it with any upstream remote.

got also supports forking a GitHub repo and adding it to the list of managed
repositories.

=head1 OPTIONS

In addition to the subcommand-specific options illustrated in the SYNOPSIS,
all the subcommands accept the following options:

=over 4

=item * C<--verbose / -v>

Be more verbose about what is happening behind the scenes

=item * C<--quiet / -q>

Be more quiet

=item * C<--tags / -t>

Select all repositories that have the given tag. May be given multiple
times. Multiple args are (effectively) 'and'-ed together.

=item * C<--skip-tags / -T>

Skip all repositories that have the given tag. May be given multiple
times. Multiple args are (effectively) 'or'-ed together.  May be combined with
-t to select all repos with the -t tag except for those with the -T tag.

=item * C<--no-color / -C>

Suppress colored output

=item * C<--color-scheme / -c>

Specify a color scheme. Defaults to 'dark'. People using light backgrounds may
want to specify "-c light".

The name given to the option indicates a library to load. By default this
library is assumed to be in the 'App::GitGot::Outputter::' namespace; the
given scheme name will be appended to that namespace. You can load something
from a different namespace by prefacing a '+'. (E.g., '-C +GitGot::pink' will
attempt to load 'GitGot::pink'.)

If the requested module can't be loaded, the command will exit.

See COLOR SCHEMES for details on how to write your own custom color scheme.

=item * repo name, repo number, range

Commands may be limited to a subset of repositories by giving a combination of
additional arguments, consisting of either repository names, repository
numbers (as reported by the 'C<list>' subcommand), or number ranges (e.g., C<2-4>
will operate on repository numbers 2, 3, and 4).

Note that if you have a repository whose name is an integer number, bad things
are going probably going to happen. Don't do that.

=back

=head1 COLOR SCHEMES

Color scheme libraries should extend C<App::GitGot::Outputter> and need to
define four required attributes: C<color_error>, C<color_warning>,
C<color_major_change>, and C<color_minor_change>. Each attribute should be a
read-only of type 'Str' with a default value that corresponds to a valid
C<Term::ANSIColor> color string.

=head1 SEE ALSO/CREDITS

=over

=item L<http://github.com/ingydotnet/app-aycabtu-pm/>

Seeing Ingy döt Net speak about AYCABTU at PPW2010 was a major factor in the
development of this script -- earlier (unreleased) versions did not have any way
to limit operations to a subset of managed repositories; they also didn't deal
well managing output. After lifting his interface (virtually wholesale) I
ended up with something that I thought was worth releasing.

=item L<http://www.leancrew.com/all-this/2010/12/batch-comparison-of-git-repositories/>

drdrang prodded me about making the color configuration more friendly to those
that weren't dark backrgound terminal people. The colors in
C<App::GitGot::Outputter::light> are based on a couple of patches that drdrang
sent me.

=item L<The Wire|http://en.wikipedia.org/wiki/The_Wire>

=back

=head2 Similar tools

=over

=item L<Git::Bunch>

Allows to check the status and exec commands on a list of
repository, as well as to sync the local machine's repositories with
another via rsync. Can also manage (and rsync) regular directories.

=item L<myrepos|http://myrepos.branchable.com/>

Allows to run the main commands (C<update>,C<status>,etc) in all registered
repos. Advertised as working with many versioning systems.
Not on CPAN nor GitHub.

=back

=head1 LIMITATIONS

Currently git is the only supported VCS.

=head1 CONTRIBUTORS

=over

=item Yanick Champoux <yanick@babyl.dyndns.org>

=item Michael Greb <michael@thegrebs.com>

=item Chris Prather <chris@prather.org>

=item Rolando Pereira

=item Tina Müller <tinita@cpan.org>

=item Karen Etheridge

=item Lucy Wyman

=back

=head1 AUTHOR

John SJ Anderson <john@genehack.org>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2020 by John SJ Anderson.

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

=cut