List of Commands?

[AriaFallah]

Hey! Love the idea for this project. I'm completely new to it, and I can't really find a list of commands (+flags they can take) anywhere in the docs. Is there something like that?

If not, is there somewhere in the source code I could just read in the meantime? For example, I'd love to learn if git sl takes a flag that can show more history than just the past few commits or if there's a flag to put the most recent commit at the top instead of at the bottom.

[arxanas]

Hi @AriaFallah, thanks for your interest in the project!

You can run git branchless help to see an overview of all of the commands, or pass -h to any command.

However, Git does something frustrating where it overrides the --help flag and tries to look up the man-pages for the provided command, and Cargo currently does not support installing man-pages. So the following work:

• git branchless -h
• git branchless restack -h
• git branchless help
• git branchless help restack
• git-branchless --help
• git-branchless restack --help

But the following do not work:

• git branchless --help
• git restack --help

There's currently no wiki pages on the individual commands beyond the -h output. If you have any feedback on additional documentation that should be added, I can either add it to the command help option, or start writing up documentation on the wiki.

If you prefer to read the source, you can start from https://github.com/arxanas/git-branchless/blob/master/src/main.rs.

On the topic of the smartlog, git branchless smartlog currently takes no options:

• It's designed to only show non-master commits which are currently "visible" (see https://github.com/arxanas/git-branchless/wiki/Concepts#visibility), so it probably won't show many commits by default. What other commits are you hoping to see? You might prefer to use git log --graph depending on your use-case.
• There's currently no way to reverse the graph output. Facebook's smartlog used to display the commits in the opposite order, and I really didn't like it because it usually meant that the commit I was working on would scroll out of view, which is why I reversed it for this implementation of the smartlog. I'm not fundamentally against it, though.

[AriaFallah]

Thanks this is exactly what I was looking for. I think it'd be really helpful to update the main README (or wiki) with this information too.

However, Git does something frustrating where it overrides the --help flag and tries to look up the man-pages for the provided command, and Cargo currently does not support installing man-pages

Ah this sucks. I was pretty confused.

If you have any feedback on additional documentation that should be added, I can either add it to the command help option, or start writing up documentation on the wiki.

I didn't see any docs on the move command, which I find extremely helpful. So that's another thing I'd love if there were docs for in the main README.

What other commits are you hoping to see?

Honestly using --graph makes sense. I just thought it'd be cool to see more history using your cool rendering lol.

There's currently no way to reverse the graph output. Facebook's smartlog used to display the commits in the opposite order, and I really didn't like it because it usually meant that the commit I was working on would scroll out of view, which is why I reversed it for this implementation of the smartlog. I'm not fundamentally against it, though.

Lol maybe it's because I'm still at FB then. I'm just used to seeing the most recent one on top.

---

Thanks for the informative comment and the help :)

[arxanas]

@AriaFallah Thanks again for your feedback. I've started work on a command overview in the Wiki. Please check the articles in the sidebar and let me know if you have any feedback. For example, here's the documentation on git move: https://github.com/arxanas/git-branchless/wiki/Command:-git-move

I've also opened #112 to attempt to fix the usage of --help under Git for at least some cases.

[AriaFallah]

I love it. Thanks a lot :)

[martinvonz]

Agreed, great documentation!

A bit off topic, but I have a comment about what to do about the git move -s 87b20a4b -d xyzzy at the end (instead of erroring out because it's a cycle). Another reasonable behavior would be to leave the commits in the range between those commits in place but move any side branches on top of the destination. You could then do something like git move -s <old origin/main> -d <new origin/main> to rebase all the commits you had off of <old origin/main>.

[arxanas]

@martinvonz That's a good idea. It's also currently the case that git move without any parameters fails because it takes on the default behavior of attempting to rebase the current commit on top of itself, which would form a cycle. Adopting your suggestion would cleanly make it a no-op.