Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/frostming/legit

Git for Humans, Inspired by GitHub for Mac™.
https://github.com/frostming/legit

cli git kennethreitz tool

Last synced: about 2 months ago
JSON representation

Git for Humans, Inspired by GitHub for Mac™.

Awesome Lists containing this project

README 

        
.. -*-restructuredtext-*-



Legit: Git for Humans

=====================



Inspired by GitHub for Mac.



The Concept

-----------



`GitHub for Mac `_ is not just a Git client.



This `comment `_ on Hacker News

says it best:



    They haven't re-created the git CLI tool in a GUI, they've created something different. They've created a tool that makes Git more accessible. Little things like auto-stashing when you switch branches will confuse git veterans, but it will make Git much easier to grok for newcomers because of the assumptions it makes about your Git workflow.



Why not bring this innovation back to the command line?



The Interface

-------------



``sw ``

    Switches to specified branch.

    Defaults to current branch.

    Automatically stashes and unstashes any changes. (alias: ``switch`` for git < 2.23)



``sync []``

    Synchronizes the given branch. Defaults to current branch.

    Stash, Fetch, Auto-Merge/Rebase, Push, and Unstash.

    You can only sync published branches. (alias: ``sy``)



``publish []``

    Publishes specified branch to the remote. (alias: ``pub``)



``unpublish ``

    Removes specified branch from the remote. (alias: ``unp``)



``undo``

    Un-does the last commit in git history.  (alias: ``un``)



``branches []``

    Display a list of available branches.

    Allows wildcard pattern matching of branch name.



The Installation

----------------



.. image:: https://img.shields.io/pypi/v/legit.svg

    :target: https://pypi.python.org/pypi/legit/



.. image:: https://img.shields.io/travis/frostming/legit/master.svg

    :target: https://travis-ci.org/frostming/legit/



.. image:: https://img.shields.io/coveralls/github/frostming/legit.svg

    :target: https://coveralls.io/r/frostming/legit/



.. image:: https://repl.it/badge/github/frostming/legit

    :target: https://repl.it/github/frostming/legit



From `PyPI `_ with the Python package manager::



    pip install legit



Or download a standalone Windows executable from `GitHub Releases `_.



Alternatively, legit can be installed via Homebrew under macOS and Linux:



    brew install legit



Several system package distributions also include legit.

Available legit version information can be found at the end of this README.



To install the cutting edge version from the git repository::



    git clone https://github.com/frostming/legit.git

    cd legit

    python setup.py install



Note: if you encountered `Permission denied`,

prepend `sudo` before the `pip` or `python setup.py` command.



You'll then have the wonderful ``legit`` command available. Run it within

a repository.



To view usage and examples, run ``legit`` with no commands or options::



    legit



To install the git aliases, run the following command::



    legit --install



To uninstall the git aliases, run the following command::



    legit --uninstall



Command Options

---------------



All legit commands support ``--verbose`` and ``--fake`` options.



In order to view the git commands invoked by legit, use the ``--verbose`` option::



    legit sync --verbose



If you want to see the git commands used by legit but don't want them invoked, use the ``--fake`` option::



    legit publish --fake



Legit Options

-------------



By default, ``legit sync`` avoids a true merge.

If the merge is not fast-forward, legit will rebase.



In gitconfig, if ``legit.smartMerge`` is set to false,

and ``pull.rebase`` is set to false or unset,

then legit will not rebase but merge.



If ``legit.smartMerge`` is set to false, and ``pull.ff`` is set to ``only``,

then if the merge is not fast-forward, legit will abort.



Caveats

-------



- All remote operations are carried out by the remote identified in ``$ git config legit.remote remotename``

- If a ``stash pop`` merge fails, Legit stops. I'd like to add checking for a failed merge, and undo the command with friendly error reporting.



Packaging Status

----------------



.. image:: https://repology.org/badge/vertical-allrepos/legit-git-cli.svg

    :alt: packaing status

    :target: https://repology.org/project/legit-git-cli/versions