Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 2.42 KB

README.md

File metadata and controls

84 lines (52 loc) · 2.42 KB
Raw

clone-it-all

clone-it-all is a script for cloning all repositories from a specified GitHub user or organization. By default, it clones only non-forked repositories, but you can optionally include forked repositories with the --with-forks flag.

Features

  • Clone all repositories from a GitHub user or organization.
  • Optionally include forked repositories with --with-forks.

Important

This script requires the GitHub CLI (gh). Ensure it's installed and authenticated on your system (gh auth login).

Installation

  1. Install GitHub CLI:

    Follow the installation instructions for GitHub CLI to install gh.

  2. Download and Give Execute Permissions:

    You can download the script directly from the repository or use curl to fetch it:

    sudo curl -L -o /usr/local/bin/clone-it-all https://raw.githubusercontent.com/mohammadxali/clone-it-all/main/clone-it-all.sh
sudo chmod +x /usr/local/bin/clone-it-all

  3. Verify Installation:

    Check that the script is available globally:

    clone-it-all --help

Usage

Basic Usage

To clone all non-fork repositories from a specified GitHub user or organization:

clone-it-all <github-username-or-organization>
  • <github-username-or-organization>: The GitHub username or organization from which to clone repositories.

Example

Clone all repositories from someusername into a folder named someusername in the current directory:

clone-it-all someusername

Including Forks

To include forked repositories in the clone operation, use the --with-forks flag:

clone-it-all <github-username-or-organization> --with-forks

Specifying an Output Folder

To specify a custom output folder, use the --output option:

clone-it-all <github-username-or-organization> --output /path/to/output-folder

Example

Clone all repositories, including forks, from someusername into /path/to/output-folder:

clone-it-all someusername --with-forks --output /path/to/output-folder

Options

  • --with-forks: Include forked repositories in the cloning process. By default, forks are ignored.
  • --output <output-folder>: Specify the output folder where repositories will be cloned. Defaults to a folder named after the GitHub username or organization in the current directory.
  • --help: Display the help message and exit.