A small tool to clone git repositories to a standard location, organised by domain name and path.

Wesley Moore

Last update: Dec 19, 2022

Related tags

Overview

⤵️
Git Grab

A small tool to clone git repositories to a standard location, organised by domain name and path. Runs on BSD, Linux, macOS, Windows, and more.

Grab clones the repo into $GRAB_HOME/github.com/wezm/git-grab where GRAB_HOME defaults to ~/src if not set or supplied via the --home argument. For example:

$ git grab github.com/wezm/git-grab
Grab https://github.com/wezm/git-grab to /home/wmoore/src/github.com/wezm/git-grab
Cloning into '/home/wmoore/src/github.com/wezm/git-grab'...
remote: Enumerating objects: 30, done.
remote: Counting objects: 100% (30/30), done.
remote: Compressing objects: 100% (20/20), done.
remote: Total 30 (delta 9), reused 27 (delta 7), pack-reused 0
Receiving objects: 100% (30/30), 12.50 KiB | 12.50 MiB/s, done.
Resolving deltas: 100% (9/9), done.

$ exa --tree ~/src
/home/wmoore/src
└── github.com
   └── wezm
      └── git-grab
         ├── Cargo.lock
         ├── Cargo.toml
         └── src
            ├── args.rs
            ├── grab.rs
            └── main.rs

Download

Pre-compiled binaries are available for a number of platforms.

Example to download and extract a binary:

curl https://releases.wezm.net/git-grab/0.1.2/git-grab-0.1.2-x86_64-unknown-linux-musl.tar.gz | tar zxf -

Usage

USAGE:
    git grab [OPTIONS] [URL]...

ARGS:
    ...
        One or more git URLs to clone. Any URL accepted by `git` is valid.
        In addition, URLs without a scheme such as
        github.com/wezm/git-grab are also accepted.

OPTIONS:
    -h, --help
            Prints help information

        --home [default: ~/src]
            The directory to use as "grab home", where the URLs will be
            cloned into. Overrides the GRAB_HOME environment variable if
            set.

    -n, --dry-run
            Don't clone the repository but print what would be done.

    -V, --version
            Prints version information

ENVIRONMENT
    GRAB_HOME
        See --home

Build from Source

Minimum Supported Rust Version: 1.51.0

git-grab is implemented in Rust. See the Rust website for instructions on installing the toolchain.

From Git Checkout or Release Tarball

Build the binary with cargo build --release --locked. The binary will be in target/release/git-grab.

From crates.io

cargo install git-grab

Credits

This tool is inspired by grab by @jmhodges. A small comparison:

Feature	Original	This Version
VCS Supported	Git, Mercurial, Subversion, and Bazaar	Git
Dependencies	None	git
Progress Information	No	Yes, provided by `git`

Licence

This project is dual licenced under either of:

Apache License, Version 2.0 (LICENSE-APACHE)
MIT license (LICENSE-MIT)

at your option.

Comments

Feature request: keeping repositories up to date

Hi,

first of all, thank you for this tool. I've been doing the same manually until I found this from Lobsters.

Currently, I have hundreds of git repositories structured precisely like this and I have a crude shell script to keep them up to date.

Do you think it would be out of scope for git-grab to also keep the git repository remotes found at $GRAB_HOME updated?

Thanks!

opened by jrasanen 5
No issue, just thanks

I appreciate this tool so much. I had a horky fish function that tried to do what this tool does PERFECTLY I wish this was the default for cloning, it does exactly what I need.

Great job, and THANK YOU!

opened by bdmorin 1
[maybe interesting] organize existing git repositories similar to `git-grab`

When installing ein with cargo install gitoxide, one can run ein tools organize to get a listing of how repositories would be moved if --execute was specified.

It could help to organize a pre-existing loose structure into the one proposed by git-grab, and from there git-grab could be used to maintain structure on any clone.

In any case, I will be using git-grab from now on as it's easier than git clone + ein t organize -e.

opened by Byron 0
support passing args to clone command

it would be nice to pass args to the git clone command.

use case:

let's say i'm cloning a large repo and i want to pass in the --depth=1 arg, then the following command would come in handy: git grab --depth=1 URL

so prolly git-grab can pass all additional optional args to the git clone command?
accepted

opened by notjedi 1
[feature-request] winget package

Area: distribution OS: Windows Version: 10.X, 11.X

Description: git-grab is currently not available as a winget package.

Notes: really like the package, is this something that could be considered?
help wanted

opened by arpadbarta 2

Releases(1.0.1)

1.0.1(Jul 7, 2022)

Patch version bump to trigger build of universal binary for macOS.
Source code(tar.gz)
Source code(zip)
1.0.0(Jul 4, 2022)

The initial release almost a year ago has proven stable so after updating dependencies I'm calling this release 1.0.
Source code(tar.gz)
Source code(zip)
0.1.1(Jul 11, 2021)

Source code(tar.gz)
Source code(zip)