summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Keybindings.md85
-rw-r--r--docs/Keybindings_en.md114
2 files changed, 114 insertions, 85 deletions
diff --git a/docs/Keybindings.md b/docs/Keybindings.md
deleted file mode 100644
index 2f10a297c..000000000
--- a/docs/Keybindings.md
+++ /dev/null
@@ -1,85 +0,0 @@
-# Keybindings:
-
-## Global:
-
-<pre>
- <kbd>←</kbd><kbd>→</kbd><kbd>↑</kbd><kbd>↓</kbd>/<kbd>h</kbd><kbd>j</kbd><kbd>k</kbd><kbd>l</kbd>: navigate
- <kbd>PgUp</kbd>/<kbd>PgDn</kbd> or <kbd>ctrl</kbd>+<kbd>u</kbd>/<kbd>ctrl</kbd>+<kbd>d</kbd>: scroll diff panel
- (for <kbd>PgUp</kbd> and <kbd>PgDn</kbd>, use <kbd>fn</kbd>+<kbd>up</kbd>/<kbd>fn</kbd>+<kbd>down</kbd> on osx)
- <kbd>q</kbd>: quit
- <kbd>p</kbd>: pull
- <kbd>shift</kbd>+<kbd>P</kbd>: push
-</pre>
-
-## Status Panel:
-
-<pre>
- <kbd>e</kbd>: edit config file
- <kbd>o</kbd>: open config file
-</pre>
-
-## Files Panel:
-
-<pre>
- <kbd>space</kbd>: toggle staged
- <kbd>a</kbd>: stage/unstage all
- <kbd>c</kbd>: commit changes
- <kbd>shift</kbd>+<kbd>C</kbd>: commit using git editor
- <kbd>shift</kbd>+<kbd>S</kbd>: stash files
- <kbd>t</kbd>: add patched (i.e. pick chunks of a file to add)
- <kbd>o</kbd>: open
- <kbd>e</kbd>: edit
- <kbd>s</kbd>: open in sublime (requires 'subl' command)
- <kbd>v</kbd>: open in vscode (requires 'code' command)
- <kbd>i</kbd>: add to .gitignore
- <kbd>d</kbd>: delete if untracked checkout if tracked (aka go away)
- <kbd>shift</kbd>+<kbd>R</kbd>: refresh files
- <kbd>shift</kbd>+<kbd>A</kbd>: abort merge
-</pre>
-
-## Branches Panel:
-
-<pre>
- <kbd>space</kbd>: checkout branch
- <kbd>f</kbd>: force checkout branch
- <kbd>m</kbd>: merge into currently checked out branch
- <kbd>c</kbd>: checkout by name
- <kbd>n</kbd>: new branch
- <kbd>d</kbd>: delete branch
- <kbd>D</kbd>: force delete branch
-</pre>
-
-## Commits Panel:
-
-<pre>
- <kbd>s</kbd>: squash down (only available for topmost commit)
- <kbd>r</kbd>: rename commit
- <kbd>shift</kbd>+<kbd>R</kbd>: rename commit using git editor
- <kbd>g</kbd>: reset to this commit
-</pre>
-
-## Stash Panel:
-
-<pre>
- <kbd>space</kbd>: apply
- <kbd>g</kbd>: pop
- <kbd>d</kbd>: drop
-</pre>
-
-## Popup Panel:
-
-<pre>
- <kbd>esc</kbd>: close/cancel
- <kbd>enter</kbd>: confirm
- <kbd>tab</kbd>: enter newline (if editing)
-</pre>
-
-## Resolving Merge Conflicts (Diff Panel):
-
-<pre>
- <kbd>←</kbd><kbd>→</kbd>/<kbd>h</kbd><kbd>l</kbd>: navigate conflicts
- <kbd>↑</kbd><kbd>↓</kbd>/<kbd>k</kbd><kbd>j</kbd>: select hunk
- <kbd>space</kbd>: pick hunk
- <kbd>b</kbd>: pick both hunks
- <kbd>z</kbd>: undo (only available while still inside diff panel)
-</pre>
diff --git a/docs/Keybindings_en.md b/docs/Keybindings_en.md
new file mode 100644
index 000000000..e80ba5f95
--- /dev/null
+++ b/docs/Keybindings_en.md
@@ -0,0 +1,114 @@
+# Lazygit menu
+
+## Global
+
+<pre>
+ <kbd>m</kbd>: view merge/rebase options
+ <kbd>P</kbd>: push
+ <kbd>p</kbd>: pull
+ <kbd>R</kbd>: refresh
+</pre>
+
+## Status
+
+<pre>
+ <kbd>e</kbd>: edit config file
+ <kbd>o</kbd>: open config file
+ <kbd>u</kbd>: check for update
+ <kbd>s</kbd>: switch to a recent repo
+</pre>
+
+## Files
+
+<pre>
+ <kbd>c</kbd>: commit changes
+ <kbd>A</kbd>: amend last commit
+ <kbd>C</kbd>: commit changes using git editor
+ <kbd>space</kbd>: toggle staged
+ <kbd>d</kbd>: delete if untracked / checkout if tracked
+ <kbd>e</kbd>: edit file
+ <kbd>o</kbd>: open file
+ <kbd>i</kbd>: add to .gitignore
+ <kbd>r</kbd>: refresh files
+ <kbd>S</kbd>: stash files
+ <kbd>s</kbd>: soft reset to last commit
+ <kbd>a</kbd>: stage/unstage all
+ <kbd>t</kbd>: add patch
+ <kbd>D</kbd>: reset hard and remove untracked files
+ <kbd>enter</kbd>: stage individual hunks/lines
+ <kbd>f</kbd>: fetch
+</pre>
+
+## Branches
+
+<pre>
+ <kbd>space</kbd>: checkout
+ <kbd>o</kbd>: create pull request
+ <kbd>c</kbd>: checkout by name
+ <kbd>F</kbd>: force checkout
+ <kbd>n</kbd>: new branch
+ <kbd>d</kbd>: delete branch
+ <kbd>r</kbd>: rebase branch
+ <kbd>M</kbd>: merge into currently checked out branch
+ <kbd>f</kbd>: fast-forward this branch from its upstream
+</pre>
+
+## Commits
+
+<pre>
+ <kbd>s</kbd>: squash down
+ <kbd>r</kbd>: reword commit
+ <kbd>R</kbd>: rename commit with editor
+ <kbd>g</kbd>: reset to this commit
+ <kbd>f</kbd>: fixup commit
+ <kbd>d</kbd>: delete commit
+ <kbd>J</kbd>: move commit down one
+ <kbd>K</kbd>: move commit up one
+ <kbd>e</kbd>: edit commit
+ <kbd>A</kbd>: amend commit with staged changes
+ <kbd>p</kbd>: pick commit (when mid-rebase)
+ <kbd>t</kbd>: revert commit
+ <kbd>c</kbd>: copy commit (cherry-pick)
+ <kbd>C</kbd>: copy commit range (cherry-pick)
+ <kbd>v</kbd>: paste commits (cherry-pick)
+</pre>
+
+## Stash
+
+<pre>
+ <kbd>space</kbd>: apply
+ <kbd>g</kbd>: pop
+ <kbd>d</kbd>: drop
+</pre>
+
+## Main (Normal)
+
+<pre>
+ <kbd>PgDn</kbd>: scroll down
+ <kbd>PgUp</kbd>: scroll up
+</pre>
+
+## Main (Staging)
+
+<pre>
+ <kbd>esc</kbd>: return to files panel
+ <kbd>▲</kbd>: select previous line
+ <kbd>▼</kbd>: select next line
+ <kbd>◄</kbd>: select previous hunk
+ <kbd>►</kbd>: select next hunk
+ <kbd>space</kbd>: stage line
+ <kbd>a</kbd>: stage hunk
+</pre>
+
+## Main (Merging)
+
+<pre>
+ <kbd>esc</kbd>: return to files panel
+ <kbd>space</kbd>: pick hunk
+ <kbd>b</kbd>: pick both hunks
+ <kbd>◄</kbd>: select previous conflict
+ <kbd>►</kbd>: select next conflict
+ <kbd>▲</kbd>: select top hunk
+ <kbd>▼</kbd>: select bottom hunk
+ <kbd>z</kbd>: undo
+</pre>