abhinav / git-spice

Manage stacked Git branches
https://abhinav.github.io/git-spice/
GNU General Public License v3.0
259 stars 18 forks source link

gui to visualise the stacks #368

Open gedw99 opened 3 months ago

gedw99 commented 3 months ago

Hey @abhinav

I am quite interested in this concept to make it easier for my Users that are scientists that use git for their documentation.

They have a git LFS, which holds all markdown and images.

Is there a GUI to visualise the branches and their stacks ? I only saw the CLI.

To built a GUI, we would probably need some sort of API to the code, but its not really structured that way.

abhinav commented 3 months ago

Hey @gedw99, thanks for the issue. Sorry, there's no GUI. The gs log short (or gs ls) and gs log long (or gs ll) do provide a visualization of the branch structure, but they're command-line based. Existing Git GUIs that show branches next to commits would work to some degree.

I would be open to adding, say, a --json flag to the log commands that would present the structure of the stack(s) in a format that could be fed into another tool, and other such flags for other commands to automate/script from a GUI tool. If necessary, I would also be open to exposing a public API for inspecting stacks directly from code. With that said, I don't have any plans to build a GUI myself at this time.

gedw99 commented 3 months ago

Hey 👋

yeah an output flag with json as a parameter would do the job .

The gui in the docs looks like a mermaid diagram to me . I did not check though .

I would love to know what gui you think works best ? A mermaid style tree is pretty easy for cognitive information overload . Those fancy git flow curved gui can be intense .

the idea is for them to be able to control git from just this visual gui . Not a form gui . So maybe a mermaid diagram is enough . Easy to built too . But a mermaid is read only . So might need to add htmx to it to make it interactive .

Just brain storming :)

gedw99 commented 3 months ago

https://stackoverflow.com/questions/1838873/visualizing-branch-topology-in-git Has a few other brain storming ideas for this .

where do you mean. You built this system and you know is potential so I follow your lead .

Will be a or bs k to this repo I you want of course .