Skip to main content

Ginz is a command-line utility that simplifies the process of cloning multiple repositories from GitHub by allowing you to specify the repositories and their branches in a single configuration file.

Project description

Logo

Ginz

Ginz is a command-line tool for cloning multiple repositories from GitHub based on a configuration file. It simplifies the process of cloning multiple repositories by allowing you to specify the repositories and their branches in a single configuration file.

Features

  • Clones multiple repositories from GitHub.
  • Supports specifying the branch for each repository.
  • Provides progress updates during the cloning process. (Coming)
  • Easy-to-use command-line interface.(Coming)
  • Customizable through a configuration file.

Installation

  1. Ensure that Python 3.x is installed on your system.
  2. Open a terminal or command prompt.
  3. Run the following command to install Ginz:

Via pip

pip install git+https://github.com/happer64bit/ginz-cli

Usage

  1. Create a configuration file named Ginz.toml in the desired directory. The file should be in the TOML format.
  2. Add repository entries to the configuration file in the following format:
[repository-name]
source = "https://github.com/username/repository-name"
branch = "main"

Replace [repository-name] with a unique name for each repository, source with the GitHub repository URL, and branch with the desired branch name (optional, defaults to "main").

  1. Open a terminal or command prompt.
  2. Navigate to the directory containing the Ginz.toml configuration file.
  3. Run the following command to start the cloning process:
ginz

Ginz will read the configuration file, clone the specified repositories, and display progress updates during the cloning process.

Options

Ginz supports the following command-line options:

  • --version or -v: Prints the version of Ginz.
  • --help or -h: Displays help information and usage instructions.
  • --refetch : Update All Repo in Ginz.toml
  • --config-url <url> : Fetch Config and run

Example

Let's assume you have the following Ginz.toml configuration file:

[project-a]
source = "https://github.com/user-a/project-a"
branch = "main"

[project-b]
source = "https://github.com/user-b/project-b"
branch = "development"

Running the command gint in the directory containing the Ginz.toml file will clone project-a from the main branch and project-b from the development branch.

Project details


Release history Release notifications | RSS feed

This version

1.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

ginz-1.3-py3-none-any.whl (4.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page