11 unstable releases (3 breaking)
0.4.2 | Oct 8, 2024 |
---|---|
0.4.0 | Oct 8, 2024 |
0.3.1 | Aug 15, 2024 |
0.2.1 | Jun 20, 2024 |
0.1.4 | May 29, 2024 |
#501 in GUI
56 downloads per month
205KB
4.5K
SLoC
lazyjj
TUI for Jujutsu/jj. Built in Rust with Ratatui. Interacts with jj
CLI.
https://github.com/Cretezy/lazyjj/assets/2672503/b5e6b4f1-ebdb-448f-af9e-361e86f0c148
Features
- Log
- Scroll through the jj log and view change details in side panel
- Create new changes from selected change with
n
- Edit changes with
e
- Desribe changes with
d
- Abandon changes with
a
- Toggle between color words and git diff with
p
- See different revset with
r
- Set a bookmark to selected change with
b
- Fetch/push with
f
/p
- Files
- View files in current change and diff in side panel
- See a change's files from the log tab with
Enter
- View conflicts list in current change
- Toggle between color words and git diff with
w
- Bookmarks
- View list of bookmarks, including from all remotes with
a
- Create with
c
, rename withr
, delete withd
, forget withf
- Track bookmarks with
t
, untrack bookmarks withT
- View list of bookmarks, including from all remotes with
- Command log: View every command lazyjj executes
- Config: Configure lazyjj with your jj config
- Help: See all key mappings with
h
/?
Setup
Make sure you have jj
installed first.
- With
cargo binstall
:cargo binstall lazyjj
- With
cargo install
:cargo install lazyjj
(may take a few moments to compile) - With pre-built binaries: View releases
- For Arch Linux:
pacman -S lazyjj
To build and install a pre-release version: cargo install --git https://github.com/Cretezy/lazyjj.git --locked
Configuration
You can optionally configure the following options through your jj config:
lazyjj.higlight-color
: Changes the highlight color. Can use named colors. Defaults to#323264
lazyjj.diff-format
: Change the default diff format. Can becolor-words
orgit
. Defaults tocolor_words
- If
lazyjj.diff-format
is not set butui.diff.format
is, the latter will be used
- If
lazyjj.bookmark-prefix
: Change the bookmark name prefix for generated bookmark names. Defaults topush-
- If
lazyjj.bookmark-prefix
is not set butgit.push-bookmark-prefix
is, the latter will be used
- If
Example: jj config set --user lazyjj.diff-format "color-words"
(for storing in user config file, repo config is also supported)
Usage
To start lazyjj for the repository in the current directory: lazyjj
To use a different repository: lazyjj --path ~/path/to/repo
To start with a different default revset: lazyjj -r '::@'
Key mappings
See all key mappings for the current tab with h
or ?
.
Basic navigation
- Quit with
q
- Change tab with
1
/2
/3
- Scrolling in left panel
- Scroll down/up by one line with
j
/k
or down/up arrow - Scroll down/up by half page with
J
/K
or down/up arrow
- Scroll down/up by one line with
- Scrolling in right panel
- Scroll down/up by one line with
Ctrl+e
/Ctrl+y
- Scroll down/up by a half page with
Ctrl+d
/Ctrl+u
- Scroll down/up by a full page with
Ctrl+f
/Ctrl+b
- Scroll down/up by one line with
Log tab
- Select current change with
@
- View change files in files tab with
Enter
- Display different revset with
r
(jj log -r
) - Change right panel diff format between color words (default) and Git with
w
- Toggle right panel wrapping with
W
- Create new change after highlighted change with
n
(jj new
)- Create new change and describe with
N
(jj new -m
)
- Create new change and describe with
- Edit highlighted change
e
(jj edit
) - Abandon a change with
a
(jj abandon
) - Describe the highlighted change with
d
(jj describe
)- Save with
Ctrl+s
- Cancel with
Esc
- Save with
- Set a bookmark to the highlighted change with
b
(jj bookmark set
)- Scroll in bookmark list with
j
/k
- Create a new bookmark with
c
- Use auto-generated name with
g
- Scroll in bookmark list with
- Git fetch with
f
(jj git fetch
)- Git fetch all remotes with
F
(jj git fetch --all-remotes
)
- Git fetch all remotes with
- Git push with
p
(jj git push
)- Git push all bookmarks with
P
(jj git push --all
)
- Git push all bookmarks with
Files tab
- Select current change with
@
- Change right panel diff format between color words (default) and Git with
w
- Toggle right panel wrapping with
W
Bookmarks tab
- Show bookmarks with all remotes with
a
(jj bookmark list --all
) - Create a bookmark with
c
(jj bookmark create
) - Rename a bookmark with
r
(jj bookmark rename
) - Delete a bookmark with
d
(jj bookmark delete
) - Forget a bookmark with
f
(jj bookmark forget
) - Track a bookmark with
t
(only works for bookmarks with remotes) (jj bookmark track
) - Untrack a bookmark with
T
(only works for bookmarks with remotes) (jj bookmark untrack
) - Change right panel diff format between color words (default) and Git with
w
- Toggle right panel wrapping with
W
- Create a new change after the highlighted bookmark's change with
n
(jj new
)- Create a new change and describe with
N
(jj new -m
)
- Create a new change and describe with
Command log tab
- Select latest command with
@
- Toggle right panel wrapping with
W
Development
Setup
- Install Rust and
- Clone repository
- Run with
cargo run
- Build with
cargo build --release
(output intarget/release
) - You can point it to another jj repo with
--path
:cargo run -- --path ~/other-repo
Logging/Tracing
lazyjj has 2 debugging tools:
- Logging: Enabled by setting
LAZYJJ_LOG=1
when running. Produces alazyjj.log
log file - Tracing: Enabled by setting
LAZYJJ_TRACE=1
when running. Producestrace-*.json
Chrome trace file, forchrome://tracing
or ui.perfetto.dev
Dependencies
~15–26MB
~390K SLoC