LEGIT(1)

📦
version 1.2.0.post0 · 3 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

💖 LEGIT: GIT FOR HUMANS 💖

okay bestie, sit down, hydrate, because this one is a whole moment. This is legit, aka Git for Humans, and it's lowkey inspired by GitHub for Mac. Yes, we're bringing that energy to your terminal. periodt. 🫶

✨ THE CONCEPT ✨

GitHub for Mac is not just a Git client. It's giving something else entirely.

This comment on Hacker News says it best, and honestly? They ate:

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.

So like… why not bring this innovation back to the command line? 🌈 Exactly. That's the whole vibe.

🎀 THE INTERFACE 🎀

These are the commands, and yes they're iconic:

  • switch <branch> — Switches to specified branch. Defaults to current branch. Automatically stashes and unstashes any changes. (alias: sw)
  • sync [<branch>] — 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 [<branch>] — Publishes specified branch to the remote. (alias: pub)
  • unpublish <branch> — Removes specified branch from the remote. (alias: unp)
  • undo — Un-does the last commit in git history. (alias: un)
  • branches [<wildcard pattern>] — Display a list of available branches. Allows wildcard pattern matching of branch name.

🌸 THE INSTALLATION 🌸

first up, the little badges, because aesthetics:

[image: https://img.shields.io/pypi/v/legit.svg] [image: https://img.shields.io/travis/frostming/legit/master.svg] [image: https://img.shields.io/coveralls/github/frostming/legit.svg] [image: https://repl.it/badge/github/frostming/legit]

From PyPI with the Python package manager:

pip install legit

Or download a standalone Windows executable from GitHub Releases. (yes, standalone, no notes 🦋)

Wanna live on the edge and install the cutting edge version from the git repository? Slay:

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 install command. Classic. 😭

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. every single one. no cap.

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

💀 CAVEATS 💀

okay this is the part where we get real for a sec:

  • 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. (we're aware, bestie, it's on the list 🙈)

that's the whole page, babe — and that lil footer line said LEGIT: GIT FOR HUMANS() with no version or date attached, so consider this your cute sign-off: go forth, legit responsibly, and remember that auto-stashing is main character energy. 💅✨🎀

📦 where this page comes from