Git Interactive Rebase Tool
Native cross-platform full feature terminal based sequence editor for interactive rebase in Git 1.7.8+.
This is the documentation for the development build. For the current stable release, please use the 1.2.x documentation.
Table of Contents
Features
Cross platform
Built and works on Linux, macOS, Windows and BSD.
Set action
Easily set the action to pick, squash, fixup, edit, reword and drop.
Reorder rebase list
Reorder the action list with a single key press.
Multiline modification
Change action and reorder multiple lines at once with visual mode.
Toggle breaks
View commit details and diff
View the commit overview and a full commit diff with a press of a key.
Unicode and Emoji support
Edit exec command
Easily edit the command that is run by an exec command.
Edit in external editor
Need to do something in your Git editor? Quickly shell out to your editor, make a change and return to the tool.
Setup
Most systems
git config --global sequence.editor interactive-rebase-tool
Windows
Standard Command Pompt
git config --global sequence.editor "'C:/path/to/interactive-rebase-tool.exe'"
GitBash
GitBash requires the use of winpty in order to work correctly, so to set the editor use:
git config --global sequence.editor "winpty /c/path/to/interactive-rebase-tool.exe"
Notes
Windows before version 10 has serious rendering issues with saturated darker colors, such as the blue color that is entirely illegible on modern displays. While it is possible to avoid using saturated colors, a better option is to update the theme using Microsoft's ColorTool.
Temporary Override
You can temporarily use a different sequence editor by using the GIT_SEQUENCE_EDITOR environment variable:
GIT_SEQUENCE_EDITOR=emacs git rebase -i [<upstream> [<branch>]]
Usage
interactive-rebase-tool <rebase-todo-filepath>
interactive-rebase-tool --help
interactive-rebase-tool --version
Getting Help
The tool has built-in help that can be accessed by hitting the ? key.
Default Key Bindings
Key bindings can be configured, see configuration for more information.
| Key | Mode | Description |
|---|---|---|
| Up | All | Move selection up |
| Down | All | Move selection down |
| Page Up | All | Move selection up five lines |
| Page Down | All | Move selection down five lines |
q |
Normal | Abort interactive rebase |
Q |
Normal | Immediately abort interactive rebase |
w |
Normal | Write interactive rebase file |
W |
Normal | Immediately write interactive rebase file |
? |
All | Show help |
c |
Normal | Show commit information |
j |
All | Move selected commit(s) down |
k |
All | Move selected commit(s) up |
b |
Normal | Toggle break action |
p |
All | Set selected commit(s) to be picked |
r |
All | Set selected commit(s) to be reworded |
e |
All | Set selected commit(s) to be edited |
s |
All | Set selected commit(s) to be squashed |
f |
All | Set selected commit(s) to be fixed-up |
d |
All | Set selected commit(s) to be dropped |
E |
Normal | Edit the command of an exec action |
v |
All | Enter and exit visual mode |
d |
Diff | Show full commit diff |
Development
Install Rust
To start developing the project, you will need to install Rust, which can generally be done using rustup.
Setup
Debian and derivatives
If you plan to build a release package you will need pkg-config and liblzma-dev. They can be installed using apt:
sudo apt install pkg-config liblzma-dev
Build and run
Use cargo to build and run the project. From the project root run:
# only build
cargo build --release
# build and run
cargo run -- <path-to-git-rebase-todo-file>
Tests
Automated tests are available for all features and ran be run with:
cargo test
Linting
The project uses Clippy to provide additional linting, run with:
./scripts/lint.bash
Format
This project uses rust-fmt to provide a consistent format. A helpful script will ensure that all files are formatted correctly:
./scripts/format.bash
Release
Install Cargo Deb
cargo install cargo-deb
Building
cargo build --release
cargo deb
A deb file will be written to target/debian/interactive-rebase-tool_*.deb.
Related Projects
- rebase-editor is a very similar project written in Node.js.
License
Git Interactive Rebase Tool is released under the GPLv3 license. See LICENSE.
See Third Party Licenses for licenses of the third-party libraries used by this project.