Skip to content

Latest commit

 

History

History
executable file
·
153 lines (109 loc) · 6.25 KB

README.md

File metadata and controls

executable file
·
153 lines (109 loc) · 6.25 KB
Raw

Logo

🚀 gitd

Simplify Git repository downloads with ease!
Report Bug . Request Feature

Downloads Contributors Forks Stargazers Issues License

📚 Table Of Contents

🚀 About The Project

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.

✨ Features

  • 🔄 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.

🤔 Why gitd?

  • 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.

🛠️ Built With

  • Zsh (Z shell)

🚀 Getting Started

To get started with gitd, follow the instructions below.

📋 Prerequisites

  • Zsh or Bash installed on your system
  • GitHub CLI (gh) for retrieving repository details

🛠️ Installation

You can install gitd by running the following command in your terminal:

bash -c "$(curl -fsSL https://raw.githubusercontent.com/xXDeathAbyssXx/gitd/main/install.sh)"

🛠️ Usage

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.

⚙️ Options:

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)

🌐 Customizing Repository Location

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_repos

Add this line to your shell configuration file (e.g., .zshrc or .bashrc) to make it persistent across sessions.

🚀 Examples

  • Clone a repository with the default settings: gitd https://github.com/xXDeathAbyssXx/gitd
  • Specify a branch for cloning: gitd -b main https://github.com/xXDeathAbyssXx/gitd
  • Set up a repository after cloning: gitd -s https://github.com/example/repo
  • Customize the base directory: export GITD_BASE_DIR=~/Downloads

🗺️ Roadmap

See the open issues for a list of proposed features (and known issues).

🤝 Contributing

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.

🌐 Creating A Pull Request

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

Distributed under the Apache License. See LICENSE for more information.

🌟 Authors

  • DeathAbyss - Fullstack Developer - DeathAbyss - Built gitd
  • AlphaTechnolog - Fullstack Developer - AlphaTechnolog - Developer/Tester of gitd