Skip to content
Native cross platform full feature terminal based sequence editor for git interactive rebase. Written in Rust using ncurses.
Rust Shell Roff
Branch: master
Clone or download

Latest commit

MitMaro Cleanup and refactor ViewLine
Cleanup some code duplication and calculate the length on creation
instead of on retrieval. Also add some tests to ensure that the struct
is working as expected.
Latest commit 2c024e3 May 24, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fix GitHub action macos builds May 18, 2020
docs update choco install doc Nov 12, 2019
readme Add note about Apple Terminal support Jan 12, 2020
scripts Move publish and latest release to GitHub Actions Feb 20, 2020
src Cleanup and refactor ViewLine May 25, 2020
test Add tests and docs for commit::utils Jan 28, 2020
.editorconfig Move publish and latest release to GitHub Actions Feb 20, 2020
.gitignore Initial project commit Dec 22, 2016
.rustfmt.toml Rust Format update Jul 24, 2019
CHANGELOG.md Fix scroll position resetting on resize May 23, 2020
CODE_OF_CONDUCT.md Add a Contributor Covenant Code of Conduct Jun 17, 2017
Cargo.lock Update git2-rs dependency to the latest version Mar 15, 2020
Cargo.toml Update git2-rs dependency to the latest version Mar 15, 2020
LICENSE Re-license project under the GPLv3 Apr 24, 2019
README.md Add support for additional key bindings Apr 30, 2020
THIRD_PARTY_LICENSES Re-license project under the GPLv3 Apr 24, 2019

README.md

Crates.io GitHub license

Git Interactive Rebase Tool

Native cross-platform full feature terminal based sequence editor for interactive rebase in Git 1.7.8+. Written in Rust using ncurses.

Git Interactive Rebase Tool

This is the documentation for the development build. For the current stable release please use the 1.2.x documentation.

Install

Configure

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 are completely illegible on modern displays. While it is possible to avoid using the saturated colors, a better option is to update the theme using Microsoft's ColorTool.

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

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>]]

Configuration

The tool can be configured using the git config command. Invalid values are ignored and the default used instead. String values are case-insensitive.

Example

git config --global interactive-rebase-tool.foregroundColor black

General

Key Default Type Description
autoSelectNext false bool If true, auto select the next line after action modification
verticalSpacingCharacter ~ String Vertical spacing character. Can be set to an empty string.

Colors

The valid colors are the eight original 8 ANSI colors. They are black, blue, cyan, green, magenta, red, white and yellow. Each terminal controls the exact color for these color names. On terminals that support 256 colors, a color triplet with the format <red>,<green>,<blue> can be used. Each color has a range of 0 to 255 with 255, 255, 255 resulting in white and 0,0,0 resulting in black. A value of -1 or transparent can be used to use the default terminal color.

Key Default Type Description
breakColor white Color Color used for the break action
diffAddColor green Color Color used for lines and files added in a diff
diffChangeColor yellow Color Color used for lines and files changed in a diff
diffRemoveColor red Color Color used for lines and files removed in a diff
dropColor red Color Color used for the drop action
editColor blue Color Color used for the edit action
fixupColor magenta Color Color used for the fixup action
foregroundColor white Color Color used for most text and the UI
indicatorColor cyan Color Color used for text the indicates or needs to standout
pickColor green Color Color used for the pick action
rewordColor yellow Color Color used for the reword action
selectedBackgroundColor 35,35,40 Color Color used as the background color for the selected line
squashColor cyan Color Color used for the squash action

Default Key Bindings

Key Default Type Description
inputAbort q String Key for abort rebase with prompt
inputActionBreak b String Key for setting action to rebase
inputActionDrop d String Key for setting action to drop
inputActionEdit e String Key for setting action to edit
inputActionFixup f String Key for setting action to fixup
inputActionPick p String Key for setting action to pick
inputActionReword r String Key for setting action to reword
inputActionSquash s String Key for setting action to squash
inputConfirmNo n String Key for rejecting a confirmation
inputConfirmYes y String Key for confirming a confirmation
inputEdit E String Key for entering edit mode
inputForceAbort Q String Key for forcing an abort of the rebase
inputForceRebase W String Key for forcing a rebase
inputHelp ? String Key for showing the help
inputMoveDown Down String Key for moving the cursor down
inputMoveLeft Left String Key for moving the cursor left
inputMoveRight Right String Key for moving the cursor right
inputMoveSelectionDown j String Key for moving the selected line(s) down
inputMoveSelectionUp k String Key for moving the selected line(s) up
inputMoveStepDown PageDown String Key for moving the cursor down by a large step
inputMoveStepUp PageUp String Key for moving the cursor up by a large step
inputMoveUp Up String Key for moving the cursor up
inputOpenInExternalEditor ! String Key for opening the external editor
inputRebase w String Key for rebasing with confirmation
inputShowCommit c String Key for showing the selected commit
inputToggleVisualMode v String Key for toggling visual mode
Changing Key Bindings

Most keys can be changed to any printable character or supported special character. It is possible to provide conflicting keybindings, which will result in undefined behaviour. The inputConfirmYes bindings has a special behaviour in that it responds to both the uppercase and lowercase letter of the value set, if the variant exist.

Example
git config --global interactive-rebase-tool.inputRebase S
Supported Special Keys

Keys that do not have easily printable characters, such as the arrow keys, are set using the special values defined in the table below. Some special keys do not work correctly on some setups.

Note: If a special key does not exist, please open an issue to request it to be added.

Key Description
Backspace Backspace key
Delete Delete key
Down Down arrow key
End End key
Enter Enter key
F0 Function 0 key
F1 Function 1 key
F2 Function 2 key
F3 Function 3 key
F4 Function 4 key
F5 Function 5 key
F6 Function 6 key
F7 Function 7 key
F8 Function 8 key
F9 Function 9 key
F10 Function 10 key
F11 Function 11 key
F12 Function 12 key
F13 Function 13 key (shift + F1 on some keyboards)
F14 Function 14 key (shift + F2 on some keyboards)
F15 Function 15 key (shift + F3 on some keyboards)
Home Home key
Insert The insert key
Left Left arrow key
PageDown Page Down key
PageUp Page Up key
Right Right arrow key
Shift+Delete Shift key plus delete key
Shift+Down Shift key plus down arrow key
Shift+End Shift key plus end key
Shift+Home Shift key plus home key
Shift+Left Shift key plus left arrow key
Shift+Right Shift key plus right arrow key
Shift+Tab Shift key plus Shift key plus tab key
Shift+Up Shift key plus up arrow key
Tab Tab key
Up Up arrow key

Configuring External Editor

The external editor action will first attempt to start the editor defined by the Git configuration "core.editor", followed by the VISUAL and EDITOR environment variables. Finally, if neither is set the external editor defaults to using vi.

The % character in the value will be replaced with the git rebase todo file. If the % character is not found, then the git rebase todo file will be provided as the last argument.

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

You will need build-essential and libncurses5-dev to build the project. Additionally, you will need pkg-config and liblzma-dev if you wish to build a release. They can be installed using apt-get:

sudo apt-get install build-essential libncursesw5-dev
sudo apt-get 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>

Format

Use rust-fmt format project. You need to run format with nightly. The current nightly rust version is nightly-2019-09-13. You can find the current nightly rust version in the scripts/format.bash.

# format code before you commit
cargo +nightly-2019-09-13 fmt

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.

TODO

  • Full support for exec action
  • Insert action
  • Configure key bindings

Related Projects

License

Git Interactive Rebase Tool is released under the GPLv3 license. See LICENSE.

See Third Party Licenses for licenses for third-party libraries used by this project.

You can’t perform that action at this time.