Skip to content

A collection of bash script tools made to simplify and speed up your GIT workflow automation.

License

Notifications You must be signed in to change notification settings

iamprogrammerlk/bot_git_tool





Bot GIT Tool

A collection of bash script tools made to simplify and speed up your GIT workflow automation.

Tip

⭐ Star This Repository

If you enjoy this project and my work, please consider supporting me giving a ⭐ star ⭐ to this repository.


(👆 back to top 👆)


🪧 Usage

  • Clone the Bot GIT Tool repository anywhere you want 'bot_git_tool' on your system.

    git clone --recurse-submodules https://github.com/iamprogrammerlk/bot_git_tool.git
    

Important

Don't forget the --recurse-submodules option,

If you already cloned the project and forgot --recurse-submodules, You must run following two commands from the main project git submodule init to initialize your local configuration file, and git submodule update to fetch all the files from the bot_git_tool project, you can use the foolproof git submodule update --init --recursive command to also initialize, fetch and checkout any nested submodules.

GIT List

This application efficiently identifies all repositories located within the specified directories, offering a comprehensive overview of your projects. GIT List also appends the git path to the '.gitconfig' file.

How to use GIT List

Run first time?

Warning

The GIT List command will overwrite the $HOME/.gitconfig file. It is strongly recommended to create a backup before executing the GIT LIST operation.

  • Make the git_list.sh script executable in the bot_git_tool directory.

    sudo chmod +x source/git_list.sh
    

    Then run

    ./source/git_list.sh
    

    The GIT List will prompt you for your password to establish a symbolic link within your /usr/local/bin directory. This process is required only once. Additionally, it will generate all the necessary files within your $HOME/.config/bot_git_tool/git_list directory.

  • Please open the $HOME/.config/bot_git_tool/git_list/root_directory.conf file and add the list of root directories you wish to scan for GIT repositories. add one directory path on each line.

    [!IMPORTANT]

    Please avoid adding directories that are high up in the directory tree, such as /mnt/ or /. This can slow down the scanning process.

  • Please open the $HOME/.config/bot_git_tool/git_list/git_config.conf file and include all your global Git configurations. This step is necessary because GIT List overrides your default .gitconfig file in the home directory.

To run GIT List on any location within your system, open the terminal,

gitlist


(👆 back to top 👆)


💕 Credits


(👆 back to top 👆)


✨ Get Involved

Contributors are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Make your changes with clear commit messages (git commit -m "Add some AmazingFeature")
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Submit a pull request with description of changes

Read more about,

Get in touch with the project developers and the community through our Reddit.com Community forum.


(👆 back to top 👆)


🔥 Issues

Bug reports and feature requests can be submitted on the Github Issues. Please read the support.md and governance.md for more details.

Important

Please do not report security vulnerabilities through public Community Forum, GitHub Issues, Discussions, or Pull Requests. Instead, use SECURITY ADVISORIES


(👆 back to top 👆)


👍 Code of Conduct

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Code of Conduct, Governance, Security Policy, and be bound by the terms of the Contributor License Agreement.

Important

This project is not a platform for discussing politics, social issues, race, religion, gender, or sexual orientation. Please keep those discussions elsewhere.


(👆 back to top 👆)


⚖️ License

This work is distributed under the Do What The F*ck You Want To Public License (WTFPL) 2.0 License.

See license for more information.

Permissions

  • ✅ Commercial use
  • ✅ Distribution
  • ✅ Modification
  • Patent use
  • ✅ Private use

Conditions

  • Disclose source
  • License and copyright notice
  • Network use is distribution
  • Same license
  • State changes

Limitations

  • 🚫 Liability
  • Trademark use
  • 🚫 Warranty


(👆 back to top 👆)


©️ Copyright


(👆 back to top 👆)


About

A collection of bash script tools made to simplify and speed up your GIT workflow automation.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Sponsor this project

  •  

Languages