Damn she has a ton of these helpful tech guides on her site under "Comics".
Programming
Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!
Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.
Hope you enjoy the instance!
Rules
Rules
- Follow the programming.dev instance rules
- Keep content related to programming in some way
- If you're posting long videos try to add in some form of tldr for those who don't want to watch videos
Wormhole
Follow the wormhole through a path of communities [email protected]
My ideal workflow: make the smallest, fastest possible PRs so there's no tomfoolery.
This is my take as well, and yet I have an 70+ file PR still pending a complete review... But to be fair that pr required me to change half the code base to change to a new network stackm.
I need this poster or canvas printed so I can hang it on my office wall...
but in light mode, right? ... right?
screams in ink spill
Looks like the original was "light mode". The image is a colour-reversed image of the free PDF version which is on the creator's site at the bottom of the page.
Direct PDF link: https://wizardzines.com/git-cheat-sheet.pdf
Why not just use a gui? I don't need something hanging on my wall because it's all just easy clicking around. And when I do want to use the cli, it's very easy to bring up.
I use an excellent GUI that opens a terminal to run the commands you execute in it so that you can review the precise command in case you need to modify it.
Whatsit?
GitExtensions
aesthetic. need i say more?
Alternatively, the Git CLI is pretty flexible and inertia makes me stick to CLI-only lmao. Plus, PowerShell git completion is meh.
(Not that GUI is bad. GitHub Desktop diffing is pretty.)
I guess to each their own because having to hang a cheat sheet on my wall with got commands seems like the exact opposite of good aesthetics to me.
That's fair. I'd probably wouldn't hang up a Git cheatsheet myself either. It still looks pretty though -- it's a dark-background Kool Knowledge poster, what's not to love? Like this evolution of Euler's formula one.
(Which I haven't acquired either :|)
GUIs tend to only cover the common/basic usage. Which is easy to remember without a cheat sheet. When you need more advanced stuff then GUIs tend to become more of a sticking point I find. And with common workflows it is far easier to automate with the CLI then with a GUI.
When you need more advanced stuff then GUIs tend to become more of a sticking point I find
What's stopping you just opening the terminal in those rare cases? For 99% of my daily needs I'm good with a good GUI
Any half-decent GUI should cover everything shown in this cheatsheet. You'd have to do quite some voodoo witchcraft to need CLI these days. It's actually the reverse sometimes, when my terminal bretheren complain that I do too much witchcraft when I'm just tidying stuff up with a GUI.
Other than untracking tracked files, I see nothing in this graphic that isn't easy to do with a gui. That might even be easy to do but it is something I do in the cli. Can I get some examples?
I would also argue that the common/basic stuff is 99% of what I do with git. And for this I can't fathom why people would think the cli is better. Like logging and diffing is just so much easier when I can just scroll and click as opposed to having to do a log command, scroll, then remember the hashes, and then write the command. This is something instantly available to me in a gui.
Don't get me wrong, if the cli is better for you more power to you. We moved from p4 to git and I did this almost exclusively in the cli so I could use scripts more easily. And sometimes I watch beginners use the gui and I have to bite my tongue because I know it would be faster in the cli.
But, especially for a beginner, i strongly recommend a gui.
Click to view diffs is super ergonomic; on the other hand, I actually have a story about the Git CLI trumping the GUI (spoiler: reflog).
In high school we had gotten the funding to build a robot, and one of the adults in charge -- guy was brilliant -- was using GitHub Desktop to conduct a feature merge with the student who served as team lead. The thing was, he was used to older codebases, so all of his experience was with CVS instead of Git -- so when the two slightly messed up the git merge, they discussed recloning everything instead of wasting time plumbing the error (relevant xkcd).
That was one of the earliest times I had the cajones to walk up to a superior and say "No, you're doing this totally wrong. You don't have to do that."
He looked at me and nodded. "What would you do instead?"
"Reflog."
"Reflog? I've never heard of it before. Can you show us?"
I hopped onto the laptop and clicked around GitHub Desktop, but couldn't manage to find any buttons related to reflog... so I went straight to cmd.exe instead.
git reflog
git reset --hard "HEAD@{7}"
"Done. We can continue rebasing."
And after that, the advisor complimented me for using the command line tool!
"Lots of GUI apps are just limited frontends to the real meat and potatoes, the command line. Nice job!"
I felt like a wizard! And so I became the team's Git-inator.
edit: pruned story
Interactive rebase? There's no GUI that actually does that well, if at all. And it's a massive part of my daily workflow.
The CLI is far, far more powerful and has many features that GUIs do not.
It's also scriptable. For example, I often like to see just the commits I've made that diverge from master, along with the files changed in each. This can be accomplished with git log --oneline --stat --name-status origin/master..HEAD
. What's more, since this is just a CLI command, I can very easily make a keybind in vim to execute the command and stick it's output into a split window. This lets me use git as a navigation tool as I can then very quickly jump to files that I've changed in some recent commit.
This is all using a standard, uniform interface without mucking around with IDE plugin settings (if they even can do such a thing). I have many, many other examples of scripting with it, such as loading side-by-side diffs for all files in the worktree against some particular commit (defaulting to master) in vim in a tabpage-per-file, which I often use to review all of my changes before making a commit.
I see nothing in this graphic that isn’t easy to do with a gui.
I didnt say the GUI was not easy for the common stuff. But I think the CLI is also easy for the common stuff so there is not much advantage other than a bit of a learning curve with the CLI. But the big thing that GUIs make harder is automation of common things. For instance, when I want to create a PR I like to rebase to the latest upstream. In a GUI that is a bunch of button clicks. With the cli I just <CTRL+R>pus
and that will autocomplete to git pull --rebase=interactive --autostash && git push && gh pr create --web
and I am landed in a web browser ready to review and submit my PR. Doing the same thing in a GUI takes a lot longer with a lot more clicking.
And that is a very common command for me.
Like logging and diffing is just so much easier when I can just scroll and click as opposed to having to do a log command, scroll, then remember the hashes, and then write the command.
Never found that to be a big issue. Most of the time when you want a diff you want to diff local changes or staged changes which is simply git diff
and git diff --staged
neither of those are hard or any real easier in the GUI (especially with bash history). For diffing specific commits I dont find that hard either just git log --oneline
and find the commits (and you can use grep to filter things out easily as well here) - typically does not require scrolling at all. Then git diff <copy paste>..<copy paste>
. In the GUIs you are often scrolling through commits you want to select at some point so I dont see how that saves you any real time here. I would not say the CLI or GUI is vastly easier in this case. And even in this case it is rare to need to do. Far more often is just branches which on a decent shell can be tab completed for convenience.
And sometimes I watch beginners use the gui and I have to bite my tongue because I know it would be faster in the cli.
This is why I prefer the CLI for common stuff. It is just faster.
But, especially for a beginner, i strongly recommend a gui.
And that is where I disagree. I think beginners should spend some time learning the tools they will need to use. IMO the CLI is critical for developers to learn and the sooner the better. So many things a vastly easier with the CLI than GUIs and a lot of stuff is near impossible with GUIs. Automation being a big one. I have not seen a good CI system that is GUI focused that you never need to know the cli for. Or when you have a repetitive task then it is quicker to write a quick script and run that then doing the same thing over and over in the GUI. Repeating actions is also easier in the CLI. All of these apply to more than just git as well.
I have seen so many beginners start with GUIs that don't really understand what they are doing in git. And quite often break things and then just delete and recreate the repo and manually make their changes again. I find people that never bother with the CLI always hit a ceiling quite quickly in terms of their ability and productivity.
The only real thing that makes the CLI worst is that it has a steeper learning curve. Once you are over that hill I find it to be vastly better for more situations or at least not practically any worst than a GUI equivalent. So that hill is one well worth climbing.
I can always use a GUI if I really needed to. But those that only know the GUI will have a very hard time on the CLI when they need to - which is required far more often than the other way round.
Missing the "oh shit need to fix this other thing but I am in the middle of a big change,,," flow. I use git stash, but I wish I could include files that haven't been added and I wish it could be tied to the branch
That sounds like the perfect situation to use git worktree
.
I've stopped using stash
and mostly just commit to my working branch. I can squah that commit away if I want later. But we squash before merge so it doesn't tend to be worth it.
It's just less things to remember.
The only time I see a rebase fail is due to a conflict. Which can be aborted with git rebase --abort
no need for reflogs unless you really mess things up.
I'll admit that in 10 years using git, I don't think I've ever used reflog once.
It can be nice when you successfully do a rebase (after resolving conflicts), but change your mind about the resolution and want to redo it.
Doesn't come up that much, but it's been handy once or twice, for me. It's also just nice security: no matter how I edit commits, I can always go back if I need to.
Maybe you resolved the conflict in the wrong way and want to restart after finishing the rebase.
Not sure I would say that is a rebase failing - just you messing things up. Can happen with any merge. But yeah that is a place where reflog would be useful. But I dont see why it would be on the cheat sheet instead of a git rebase --abort
or be rebase specific.
I went from GUI to terminal and I'll never go back. Especially with interactive add, git add -i
WHAT
Try it out. It is a great utility.
I recently got on git add -p
, which comes in clutch sometimes. But yeah, I'm definitely about to start doing the interactive add.
Also, squints at your username
In recent git versions (>2.23), git restore
and git restore --staged
are the preferred ways to discard changes in the working tree (git checkout -- .
) and staged changes (git reset --
) respectively.
Huh, TIL.
To be fair, git switch
was also derived from the features of git checkout
in >2.23, but like git restore
, the manual page warns that behavior may change, and neither are in my muscle memory (lmao).
I'll probably keep using checkout since it takes less kb in my head. ~~Besides, we still have to use checkout for checking out a previous commit, even if I learn the more ergonomically appropriate switch
and restore
.~~ No deprecation here so...
edit: maybe I got that java 8 mindset
edit 2: Correction -- git switch --detach
checks out previous commits. Git checkout may only be there for old scripts' sake, since all of its features have been split off into those two new functions... so there's nothing really keeping me from switch
.
Besides, we still have to use checkout for checking out a previous commit
git switch works on commits too. I don't think you have to use checkout anymore.
Oh, you're right. You just pass the -d
detach flag. I stand corrected!
One missing point:
git stash $NAME
lets you name a stash, and then you also can pop with that name to restore.
Super useful if you're doing something with plotting or presenting data and you want to try a few easy variants to see what you like most. I don't use it all the time but it's good to know.
git has 17 million options
proof needed /s
I wonder how many it actually is.
According to tab autocomplete...
$ git
zsh: do you wish to see all 141 possibilities (141 lines)?
But what about the sub options?
$ git clone https://github.com/git/git
$ cd git/builtin
# looking through source, options seem to be declared by OPT
# except for if statements, OPT_END, bug checks, etc.
$ grep -R OPT_ | grep --invert-match --count -E \
"OPT_END|BUG_ON_OPT|if |PARSE_OPT|;$|struct|#define"
1517
Maybe 1500 or so?
edit: Indeed, maybe this number is too low. git show
has a huge amount of possibilities on its own, though some may be duplicates and rewords of others.
$ git show --
zsh: do you wish to see all 489 possibilities (163 lines)?
$ man git-show | col -b | grep -E "^ -" --count
98
An attempt at naively parsing the manpages gives a larger number.
$ man $(find /usr/share/man -name "git*") \
| col -b | grep -E "^ -" -c
1849
Numbers all over the place. I dunno.
That's less than I expected. If there's 141 commands that on average comes down to 10 per.
I use like 4 git commands in prod (make a branch, rebase, rebase interactive, push) plus git gui & gitk.