README
¶
git-spice
Introduction
git-spice is a tool for stacking Git branches. It lets you manage and navigate stacks of branches, conveniently modify and rebase them, and create GitHub Pull Requests from them.
See https://abhinav.github.io/git-spice/ for more details.
Usage looks roughly like this:
# Stack a branch on top of the current branch.
$ gs branch create feat1
# Stack aonther branch on top of feat1.
$ gs branch create feat2
# Submit pull requests for feat1 and feat2.
$ gs stack submit
# Pull latest changes from the remote repository
# and delete merged branches.
$ gs repo sync
# Restack branches on top of the latest changes.
$ gs stack restack
Or equivalently, using CLI shorthands:
$ gs bc feat1 # branch create feat1
$ gs bc feat2 # branch create feat2
$ gs ss # stack submit
$ gs rs # repo sync
$ gs sr # stack restack
Features
- Create, edit, and navigate stacks of branches with ease.
- Create and update GitHub Pull Requests for the entire stack or parts of it with a single command.
- Keep using your existing workflow and adopt git-spice incrementally.
- Completely offline operation with no external dependencies until you push or pull from a remote repository.
- Easy-to-remember shorthands for most commands.
Documentation
See https://abhinav.github.io/git-spice/ for the full documentation.
License
This software is distributed under the GPL-3.0 License:
git-spice: Stacked Pull Requests
Copyright (C) 2024 Abhinav Gupta
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
See LICENSE for details.
As an exception to the above, the following files are distributed under a different license. See the file headers for details:
internal/komplete/komplete.go
internal/komplete/komplete_test.go
Documentation
Source Files
¶
- auth.go
- auth_login.go
- auth_logout.go
- auth_status.go
- bottom.go
- branch.go
- branch_checkout.go
- branch_create.go
- branch_delete.go
- branch_edit.go
- branch_fold.go
- branch_onto.go
- branch_rename.go
- branch_restack.go
- branch_split.go
- branch_submit.go
- branch_track.go
- branch_untrack.go
- commit.go
- commit_amend.go
- commit_create.go
- commit_split.go
- down.go
- downstack.go
- downstack_edit.go
- downstack_submit.go
- dumpmd_disable.go
- editor.go
- log.go
- log_long.go
- log_short.go
- main.go
- rebase.go
- rebase_abort.go
- rebase_continue.go
- remote.go
- repo.go
- repo_init.go
- repo_sync.go
- shell.go
- shell_completion.go
- stack.go
- stack_edit.go
- stack_restack.go
- stack_submit.go
- submit.go
- top.go
- trunk.go
- up.go
- upstack.go
- upstack_onto.go
- upstack_restack.go
- upstack_submit.go
- version.go
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
cli/shorthand
Package shorthand implements support for shorthand commands for the git-spice CLI.
|
Package shorthand implements support for shorthand commands for the git-spice CLI. |
|
cmputil
Package cmputil provides utilities for comparing values.
|
Package cmputil provides utilities for comparing values. |
|
execedit
Package execedit provides the ability to invoke external editors.
|
Package execedit provides the ability to invoke external editors. |
|
fixturetest
Package fixturetest allows generating values using a possibly-random source on the first run of a test, and stores it in a file for subsequent runs.
|
Package fixturetest allows generating values using a possibly-random source on the first run of a test, and stores it in a file for subsequent runs. |
|
forge
Package forge provides an abstraction layer between git-spice and the underlying forge (e.g.
|
Package forge provides an abstraction layer between git-spice and the underlying forge (e.g. |
|
forge/github
Package github provides a wrapper around GitHub's APIs in a manner compliant with the forge.Forge interface.
|
Package github provides a wrapper around GitHub's APIs in a manner compliant with the forge.Forge interface. |
|
forge/shamhub
Package shamhub implements a fake GitHub-like Forge.
|
Package shamhub implements a fake GitHub-like Forge. |
|
git
Package git provides access to the Git CLI with a Git library-like interface.
|
Package git provides access to the Git CLI with a Git library-like interface. |
|
git/gittest
Package gittest provides utilities for testing git repositories.
|
Package gittest provides utilities for testing git repositories. |
|
ioutil
Package ioutil provides I/O utilities.
|
Package ioutil provides I/O utilities. |
|
komplete
Package komplete is a package for generating completions for Kong CLIs.
|
Package komplete is a package for generating completions for Kong CLIs. |
|
logtest
Package logtest provides a log.Logger for testing.
|
Package logtest provides a log.Logger for testing. |
|
maputil
Package maputil provides utilities for working with maps.
|
Package maputil provides utilities for working with maps. |
|
mockedit
Package mockedit provides a mock implementation of an editor.
|
Package mockedit provides a mock implementation of an editor. |
|
must
Package must provides runtime assertions.
|
Package must provides runtime assertions. |
|
osutil
Package osutil provides utilities for working with the os package.
|
Package osutil provides utilities for working with the os package. |
|
secret
Package secret provides a layer for storing secretes.
|
Package secret provides a layer for storing secretes. |
|
secret/secrettest
Package secrettest provides a cross-process testable secret.Stash.
|
Package secrettest provides a cross-process testable secret.Stash. |
|
sliceutil
Package sliceutil contains utility functions for working with slices.
|
Package sliceutil contains utility functions for working with slices. |
|
spice
Package spice intends to provide the core functionality of the tool.
|
Package spice intends to provide the core functionality of the tool. |
|
spice/state
Package state defines and sores the state for gs.
|
Package state defines and sores the state for gs. |
|
spice/state/storage
Package storage provides a key-value storage abstraction where values are JSON-serializable structs.
|
Package storage provides a key-value storage abstraction where values are JSON-serializable structs. |
|
stub
Package stub provides helper functions to replace global variables for testing, and restore them afterwards.
|
Package stub provides helper functions to replace global variables for testing, and restore them afterwards. |
|
termtest
Package termtest provides utilities for testing terminal-based programs.
|
Package termtest provides utilities for testing terminal-based programs. |
|
text
Package text provides text manipulation functions.
|
Package text provides text manipulation functions. |
|
ui
Package ui provides terminal widgets for git-spice.
|
Package ui provides terminal widgets for git-spice. |
|
ui/fliptree
Package fliptree renders a tree of nodes as text in reverse: children first, then parent.
|
Package fliptree renders a tree of nodes as text in reverse: children first, then parent. |
|
ui/widget
Package widget implements more complex user interface components on top of the primitives offered in the ui package.
|
Package widget implements more complex user interface components on top of the primitives offered in the ui package. |
Click to show internal directories.
Click to hide internal directories.