Simplify Git repository downloads with ease!
Report Bug
.
Request Feature
- About the Project
- Features
- Why gitd?
- Built With
- Getting Started
- Usage
- Customizing Repository Location
- Examples
- Roadmap
- Contributing
- License
- Authors
This project provides a simple Zsh script (gitd) to streamline the process of downloading Git repositories. It offers a user-friendly command-line interface to quickly clone repositories with customizable settings.
- 🔄 Easy Cloning: Quickly clone Git repositories with just a few commands.
- 📁 Customizable Base Directory: Choose your preferred base directory for downloaded repositories.
- 🎨 Stylish Logs: Colorful and informative logs for a better user experience.
- ⚙️ Configuration Options: Customize the script behavior using environment variables.
- ⚙️ Setup Option: Set up the downloaded repository, including installing dependencies.
- Simplicity: gitd is designed to be straightforward and easy to use.
- Style: Enjoy stylish and colorful logs during the cloning process.
- Configurability: Tailor gitd to your preferences with customizable options.
- Zsh (Z shell)
To get started with gitd, follow the instructions below.
- Zsh or Bash installed on your system
- GitHub CLI (
gh) for retrieving repository details
You can install gitd by running the following command in your terminal:
bash -c "$(curl -fsSL https://raw.githubusercontent.com/Obed0101/gitd/main/install.sh)"Use the gitd script with the following syntax:
gitd [options] <repo_url> [options]Replace <repo_url> with the URL of the Git repository you want to download. Optionally, you can specify a branch.
| Option | Description |
|---|---|
-h, --help |
Show help message. |
-v, --version |
Display the script version. |
-s, --setup |
Set up the downloaded repository, including installing dependencies. |
-b, --branch |
Specify the branch for cloning. |
Note: The setup option is currently compatible with the following package managers and systems:
- npm: Node.js package manager
- yarn: Fast, reliable, and secure dependency management
- pnpm: Fast, disk space efficient package manager
- bundle: Ruby dependency manager
- mvn: Apache Maven for Java projects
- go: Go programming language
- gcc: GNU Compiler Collection (for C/C++ projects)
By default, gitd saves repositories in the $HOME/Repos directory. You can customize this location by setting the GITD_BASE_DIR environment variable. For example:
export GITD_BASE_DIR=~/my_reposAdd this line to your shell configuration file (e.g., .zshrc or .bashrc) to make it persistent across sessions.
- Clone a repository with the default settings:
gitd https://github.com/Obed0101/gitd - Specify a branch for cloning:
gitd -b main https://github.com/Obed0101/gitd - Set up a repository after cloning:
gitd -s https://github.com/example/repo - Customize the base directory:
export GITD_BASE_DIR=~/Downloads
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.
- Please also read through the Code Of Conduct before posting your first idea as well.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the Apache License. See LICENSE for more information.
- Obed0101 - Fullstack Developer - Obed0101 - Built gitd
- AlphaTechnolog - Fullstack Developer - AlphaTechnolog - Developer/Tester of gitd