An open API service indexing awesome lists of open source software.

https://github.com/eikendev/gitool

A tool for managing Git repositories
https://github.com/eikendev/gitool

cli git repository-management repository-tools repository-utilities

Last synced: 11 months ago
JSON representation

A tool for managing Git repositories

Awesome Lists containing this project

README

          

.. image:: https://img.shields.io/github/actions/workflow/status/eikendev/gitool/main.yml?branch=master
:alt: Build status
:target: https://github.com/eikendev/gitool/actions

.. image:: https://img.shields.io/pypi/status/gitool
:alt: Development status
:target: https://pypi.org/project/gitool/

.. image:: https://img.shields.io/pypi/l/gitool
:alt: License
:target: https://pypi.org/project/gitool/

.. image:: https://img.shields.io/pypi/pyversions/gitool
:alt: Python version
:target: https://pypi.org/project/gitool/

.. image:: https://img.shields.io/pypi/v/gitool
:alt: Version
:target: https://pypi.org/project/gitool/

.. image:: https://img.shields.io/pypi/dm/gitool
:alt: Downloads
:target: https://pypi.org/project/gitool/

Usage
=====

This tool can be used to manage many `Git `_ repositories at once through the command line.
It can display repositories that contain uncommitted code or not yet pushed commits.
In the future, this tool is meant as a high-level synchronization tool for repository configurations across multiple machines.

For a quick introduction, let me show how you would use the tool to get started.

.. code:: bash

gitool status -d ~/git/

This command will collect status information for all repositories in ``~/git/`` and display a summary when done.
As can be seen above, you have to specify a directory where all your repositories are located in.

Installation
============

From PyPI
---------

.. code:: bash

pip install gitool

From Source
-----------

.. code:: bash

./setup.py install

Fedora
------

.. code:: bash

sudo dnf copr enable eikendev/gitool
sudo dnf install python3-gitool

Configuration
=============

A configuration file can be saved to ``~/.config/gitool/config.ini`` to avoid specifying the path for each invocation.
Of course, ``$XDG_CONFIG_HOME`` can be set to change your configuration path.
Alternatively, the path to the configuration file can be set via the ``--config-file`` argument.

.. code:: ini

[GENERAL]
RootDir = ~/git/

Development
===========

The source code is located on `GitHub `_.
To check out the repository, the following command can be used.

.. code:: bash

git clone https://github.com/eikendev/gitool.git