perlancar > Git-Bunch > gitbunch

Download:
Git-Bunch-0.58.tar.gz

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

gitbunch - Manage gitbunch directory (directory which contain git repos)

VERSION ^

This document describes version 0.58 of gitbunch (from Perl distribution Git-Bunch), released on 2016-11-29.

SYNOPSIS ^

To check the status of bunch (will do a 'git status' for each git repo inside the bunch and report which repos are 'unclean', e.g. needs commit, has untracked files, etc):

 % gitbunch check ~/repos

To synchronize bunch to another (will do a 'git pull/push' for each git repo, and do an rsync for everything else):

 % gitbunch sync ~/repos /mnt/laptop/repos

DESCRIPTION ^

A gitbunch or bunch directory is just a term I coined to refer to a directory which contains, well, a bunch of git repositories. It can also contain other stuffs like files and non-git repositories (but they must be dot-dirs). Example:

 repos/            -> a gitbunch dir
   proj1/          -> a git repo
   proj2/          -> ditto
   perl-Git-Bunch/ -> ditto
   ...
   .videos/        -> a non-git dir
   README.txt      -> file

If you organize your data as a bunch, you can easily check the status of your repositories and synchronize your data between two locations, e.g. your computer's harddisk and an external/USB harddisk.

A little bit of history: after git got popular, in 2008 I started using it for software projects, replacing Subversion and Bazaar. Soon, I moved everything*) to git repositories: notes & writings, Emacs .org agenda files, configuration, even temporary downloads/browser-saved HTML files. I put the repositories inside $HOME/repos and add symlinks to various places for conveniences. Thus, the $HOME/repos became the first bunch directory.

*) everything except large media files (e.g. recorded videos) which I put in dot-dirs inside the bunch.

See also rsybak, which I wrote to backup everything else.

SUBCOMMANDS ^

check

Check status of git repositories inside gitbunch directory.

Will perform a 'git status' for each git repositories inside the bunch and report which repositories are clean/unclean.

Will die if can't chdir into bunch or git repository.

exec

Execute a command for each repo in the bunch.

For each git repository in the bunch, will chdir to it and execute specified command.

ls

List contents inside gitbunch directory.

Will list each repo or non-repo dir/file.

sync

Synchronize bunch to another bunch.

For each git repository in the bunch, will perform a 'git pull/push' for each branch. If repository in destination doesn't exist, it will be rsync-ed first from source. When 'git pull' fails, will exit to let you fix the problem manually.

For all other non-repo file/directory, will simply synchronize by one-way rsync. But, for added safety, will first check the newest mtime (mtime of the newest file or subdirectory) between source and target is checked first. If target contains the newer newest mtime, rsync-ing for that non-repo file/dir will be aborted. Note: you can use --skip-mtime-check option to skip this check.

OPTIONS ^

* marks required options.

Common options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--debug

Set log level to debug (note: you also need to set LOG=1 to enable logging, or use DEBUG=1).

--format=s

Choose output format, e.g. json, text.

Default value:

 undef
--help, -h, -?

Display help message and exit.

--json

Set output format to json.

--log-level=s

Set log level (note: you also need to set LOG=1 to enable logging).

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]
--no-config

Do not use any configuration file.

--no-env

Do not read environment for default options.

--quiet

Set log level to quiet (note: you also need to set LOG=1 to enable logging, or use QUIET=1).

--subcommands

List available subcommands.

--trace

Set log level to trace (note: you also need to set LOG=1 to enable logging, or use TRACE=1).

--verbose

Set log level to info (note: you also need to set LOG=1 to enable logging, or use VERBOSE=1).

--version, -v

Display program's version and exit.

Options for subcommand check

--exclude-files

Exclude files from processing.

This only applies to `sync_bunch` operations. Operations like `check_bunch` and `exec_bunch` already ignore these and only operate on git repos.

--exclude-non-git-dirs

Exclude non-git dirs from processing.

This only applies to and `sync_bunch` operations. Operations like `check_bunch` and `exec_bunch` already ignore these and only operate on git repos.

--exclude-repos-json=s

Exclude some repos from processing (JSON-encoded).

See --exclude-repos.

--exclude-repos-pat=s

Specify regex pattern of repos to exclude.

--exclude-repos=s@

Exclude some repos from processing.

Can be specified multiple times.

--include-files

Alias for --no-exclude-files.

See --exclude-files.

--include-non-git-dirs

Alias for --no-exclude-non-git-dirs.

See --exclude-non-git-dirs.

--include-repos-json=s

Specific git repos to sync, if not specified all repos in the bunch will be processed (JSON-encoded).

See --include-repos.

--include-repos-pat=s

Specify regex pattern of repos to include.

--include-repos=s@

Specific git repos to sync, if not specified all repos in the bunch will be processed.

Can be specified multiple times.

--min-repo-access-time=s

Limit to repos that are accessed (mtime, committed, status-ed, pushed) recently.

This can significantly reduce the time to process the bunch if you are only interested in recent repos (which is most of the time unless you are doing a full check/sync).

--repo=s

Only process a single repo.

--source=s*

Directory to check.

Options for subcommand exec

--command=s*

Command to execute.

--exclude-files

Exclude files from processing.

This only applies to `sync_bunch` operations. Operations like `check_bunch` and `exec_bunch` already ignore these and only operate on git repos.

--exclude-non-git-dirs

Exclude non-git dirs from processing.

This only applies to and `sync_bunch` operations. Operations like `check_bunch` and `exec_bunch` already ignore these and only operate on git repos.

--exclude-repos-json=s

Exclude some repos from processing (JSON-encoded).

See --exclude-repos.

--exclude-repos-pat=s

Specify regex pattern of repos to exclude.

--exclude-repos=s@

Exclude some repos from processing.

Can be specified multiple times.

--include-files

Alias for --no-exclude-files.

See --exclude-files.

--include-non-git-dirs

Alias for --no-exclude-non-git-dirs.

See --exclude-non-git-dirs.

--include-repos-json=s

Specific git repos to sync, if not specified all repos in the bunch will be processed (JSON-encoded).

See --include-repos.

--include-repos-pat=s

Specify regex pattern of repos to include.

--include-repos=s@

Specific git repos to sync, if not specified all repos in the bunch will be processed.

Can be specified multiple times.

--min-repo-access-time=s

Limit to repos that are accessed (mtime, committed, status-ed, pushed) recently.

This can significantly reduce the time to process the bunch if you are only interested in recent repos (which is most of the time unless you are doing a full check/sync).

--repo=s

Only process a single repo.

--source=s*

Directory to check.

Options for subcommand ls

--detail, -l

Show detailed record for each entry instead of just its name.

--exclude-files

Exclude files from processing.

This only applies to `sync_bunch` operations. Operations like `check_bunch` and `exec_bunch` already ignore these and only operate on git repos.

--exclude-non-git-dirs

Exclude non-git dirs from processing.

This only applies to and `sync_bunch` operations. Operations like `check_bunch` and `exec_bunch` already ignore these and only operate on git repos.

--exclude-repos-json=s

Exclude some repos from processing (JSON-encoded).

See --exclude-repos.

--exclude-repos-pat=s

Specify regex pattern of repos to exclude.

--exclude-repos=s@

Exclude some repos from processing.

Can be specified multiple times.

--include-files

Alias for --no-exclude-files.

See --exclude-files.

--include-non-git-dirs

Alias for --no-exclude-non-git-dirs.

See --exclude-non-git-dirs.

--include-repos-json=s

Specific git repos to sync, if not specified all repos in the bunch will be processed (JSON-encoded).

See --include-repos.

--include-repos-pat=s

Specify regex pattern of repos to include.

--include-repos=s@

Specific git repos to sync, if not specified all repos in the bunch will be processed.

Can be specified multiple times.

--min-repo-access-time=s

Limit to repos that are accessed (mtime, committed, status-ed, pushed) recently.

This can significantly reduce the time to process the bunch if you are only interested in recent repos (which is most of the time unless you are doing a full check/sync).

--repo=s

Only process a single repo.

--sort=s

Order entries.

Valid values:

 ["name","-name","mtime","-mtime","commit_time","-commit_time","status_time","-status_time","pull_time","-pull_time"]
--source=s*

Directory to check.

Options for subcommand sync

--backup

Whether doing backup to target.

This setting lets you express that you want to perform synchronizing to a backup target, and that you do not do work on the target. Thus, you do not care about uncommitted or untracked files/dirs in the target repos (might happen if you also do periodic copying of repos to backup using cp/rsync). When this setting is turned on, the function will first do a `git clean -f -d` (to delete untracked files/dirs) and then `git checkout .` (to discard all uncommitted changes). This setting will also implicitly turn on `create_bare` setting (unless that setting has been explicitly enabled/disabled).

--create-bare-target, --use-bare

Whether to create bare git repo when target does not exist.

When target repo does not exist, gitbunch can either copy the source repo using `rsync` (the default, if this setting is undefined), or it can create target repo with `git init --bare` (if this setting is set to 1), or it can create target repo with `git init` (if this setting is set to 0).

Bare git repositories contain only contents of the .git folder inside the directory and no working copies of your source files.

Creating bare repos are apt for backup purposes since they are more space-efficient.

Non-repos will still be copied/rsync-ed.

--delete-branch

Whether to delete branches in dest repos not existing in source repos.

--exclude-files

Exclude files from processing.

This only applies to `sync_bunch` operations. Operations like `check_bunch` and `exec_bunch` already ignore these and only operate on git repos.

--exclude-non-git-dirs

Exclude non-git dirs from processing.

This only applies to and `sync_bunch` operations. Operations like `check_bunch` and `exec_bunch` already ignore these and only operate on git repos.

--exclude-repos-json=s

Exclude some repos from processing (JSON-encoded).

See --exclude-repos.

--exclude-repos-pat=s

Specify regex pattern of repos to exclude.

--exclude-repos=s@

Exclude some repos from processing.

Can be specified multiple times.

--include-files

Alias for --no-exclude-files.

See --exclude-files.

--include-non-git-dirs

Alias for --no-exclude-non-git-dirs.

See --exclude-non-git-dirs.

--include-repos-json=s

Specific git repos to sync, if not specified all repos in the bunch will be processed (JSON-encoded).

See --include-repos.

--include-repos-pat=s

Specify regex pattern of repos to include.

--include-repos=s@

Specific git repos to sync, if not specified all repos in the bunch will be processed.

Can be specified multiple times.

--min-repo-access-time=s

Limit to repos that are accessed (mtime, committed, status-ed, pushed) recently.

This can significantly reduce the time to process the bunch if you are only interested in recent repos (which is most of the time unless you are doing a full check/sync).

--repo=s

Only process a single repo.

--rsync-del

Whether to use --del rsync option.

When rsync-ing non-repos, by default `--del` option is not used for more safety because rsync is a one-way action. To add rsync `--del` option, enable this

--rsync-opt-maintain-ownership

Whether or not, when rsync-ing from source, we use -a (= -rlptgoD) or -rlptD (-a minus -go).

Sometimes using -a results in failure to preserve permission modes on sshfs-mounted filesystem, while -rlptD succeeds, so by default we don't maintain ownership. If you need to maintain ownership (e.g. you run as root and the repos are not owned by root), turn this option on.

--skip-mtime-check

Whether or not, when rsync-ing non-repos, we check mtime first.

By default when we rsync a non-repo file/dir from source to target and both exist, to protect wrong direction of sync-ing we find the newest mtime in source or dir (if dir, then the dir is recursively traversed to find the file/subdir with the newest mtime). If target contains the newer mtime, the sync for that non-repo file/dir is aborted. If you want to force the rsync anyway, use this option.

--source=s*

Directory to check.

--target=s*

Destination bunch.

COMPLETION ^

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C gitbunch gitbunch

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

tcsh

To activate tcsh completion for this script, put:

 complete gitbunch 'p/*/`gitbunch`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE ^

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/gitbunch.conf, ~/gitbunch.conf, or /etc/gitbunch.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

Common for all subcommands

 format (see --format)
 log_level (see --log-level)
 naked_res (see --naked-res)

Configuration for subcommand 'check'

 exclude_files (see --exclude-files)
 exclude_non_git_dirs (see --exclude-non-git-dirs)
 exclude_repos (see --exclude-repos)
 exclude_repos_pat (see --exclude-repos-pat)
 include_repos (see --include-repos)
 include_repos_pat (see --include-repos-pat)
 min_repo_access_time (see --min-repo-access-time)
 repo (see --repo)
 source (see --source)

Configuration for subcommand 'exec'

 command (see --command)
 exclude_files (see --exclude-files)
 exclude_non_git_dirs (see --exclude-non-git-dirs)
 exclude_repos (see --exclude-repos)
 exclude_repos_pat (see --exclude-repos-pat)
 include_repos (see --include-repos)
 include_repos_pat (see --include-repos-pat)
 min_repo_access_time (see --min-repo-access-time)
 repo (see --repo)
 source (see --source)

Configuration for subcommand 'ls'

 detail (see --detail)
 exclude_files (see --exclude-files)
 exclude_non_git_dirs (see --exclude-non-git-dirs)
 exclude_repos (see --exclude-repos)
 exclude_repos_pat (see --exclude-repos-pat)
 include_repos (see --include-repos)
 include_repos_pat (see --include-repos-pat)
 min_repo_access_time (see --min-repo-access-time)
 repo (see --repo)
 sort (see --sort)
 source (see --source)

Configuration for subcommand 'sync'

 backup (see --backup)
 create_bare_target (see --create-bare-target)
 delete_branch (see --delete-branch)
 exclude_files (see --exclude-files)
 exclude_non_git_dirs (see --exclude-non-git-dirs)
 exclude_repos (see --exclude-repos)
 exclude_repos_pat (see --exclude-repos-pat)
 include_repos (see --include-repos)
 include_repos_pat (see --include-repos-pat)
 min_repo_access_time (see --min-repo-access-time)
 repo (see --repo)
 rsync_del (see --rsync-del)
 rsync_opt_maintain_ownership (see --rsync-opt-maintain-ownership)
 skip_mtime_check (see --skip-mtime-check)
 source (see --source)
 target (see --target)

ENVIRONMENT ^

GITBUNCH_OPT => str

Specify additional command-line options

FILES ^

~/.config/gitbunch.conf

~/gitbunch.conf

/etc/gitbunch.conf

HOMEPAGE ^

Please visit the project's homepage at https://metacpan.org/release/Git-Bunch.

SOURCE ^

Source repository is at https://github.com/perlancar/perl-Git-Bunch.

BUGS ^

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Git-Bunch

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 ^

rsybak.

http://joeyh.name/code/mr/. You probably want to use this instead. mr supports other control version software aside from git, doesn't restrict you to put all your repos in one directory, supports more operations, and has been developed since 2007. Had I known about mr, I probably wouldn't have started gitbunch. On the other hand, gitbunch is simpler (I think), doesn't require any config file, and can copy/sync files/directories not under source control. I mainly use gitbunch to quickly: 1) check whether there are any of my repositories which have uncommitted changes; 2) synchronize (pull/push) to other locations. I put all my data in one big gitbunch directory; I find it simpler. gitbunch works for me and I use it daily.

AUTHOR ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2016 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.

syntax highlighting: