Skip to content

QUICK_REFERENCE_TUI.md

Latest commit

 

History

History
306 lines (243 loc) · 3.48 KB

QUICK_REFERENCE_TUI.md

File metadata and controls

306 lines (243 loc) · 3.48 KB

TUI Quick Reference

Interactive Rebase

Start:

mug rebase -i HEAD~5

Navigation:

  • j: Down
  • k: Up
  • Page Down: Scroll down
  • Page Up: Scroll up
  • Home: First line
  • End: Last line

Actions:

  • p: pick (use commit)
  • s: squash (merge with previous)
  • r: reword (edit message)
  • d: drop (remove)
  • e: edit (pause for changes)

Execute:

  • Enter: Apply
  • Esc: Cancel
  • q: Quit

Conflict Resolution

View Conflicts:

mug status

Markers:

<<<<<<< HEAD
your changes
=======
their changes
>>>>>>> branch

Resolve:

  1. Open file in editor
  2. Choose one version or combine
  3. Remove markers
  4. Save

Mark Resolved:

mug add <file>

Complete:

mug commit

Log View

Show Log:

mug log

Oneline:

mug log --oneline

Recent:

mug log -n 10

Details:

mug show <commit>

Status View

Current Status:

mug status

Shows:

  • Current branch
  • Staged files
  • Modified files
  • Untracked files
  • Conflicts

Common Workflows

Create and Switch Branch:

mug branch feature
mug checkout feature

Commit Changes:

mug add .
mug commit -m "message"

Rebase onto Main:

mug rebase main

Interactive Rebase:

mug rebase -i main
# Use TUI to select actions

Merge Feature:

mug checkout main
mug merge feature

Keyboard Shortcuts

General:

  • Ctrl+C: Cancel
  • q: Quit
  • ?: Help (if available)
  • Enter: Confirm/Execute

Navigation:

  • j/k or Arrow Keys: Move
  • Page Up/Down: Scroll
  • Home/End: Jump

Editing:

  • Esc: Cancel edit
  • Enter: Confirm edit

Colors

In Terminal Output:

  • Green: New/Added
  • Red: Deleted
  • Yellow: Modified
  • White: Untracked

Tips

Use Oneline for Quick Overview:

mug log --oneline -n 20

Squash Commits Before Merge:

mug rebase -i main
# Mark commits to squash with 's'

Check Status Before Actions:

mug status

Review Changes Before Commit:

mug diff

Common Tasks

List All Branches:

mug branches

Delete Branch:

mug branch -d feature

Undo Last Commit:

mug reset soft HEAD~1

View Specific Commit:

mug show abc1234

Show Diff:

mug diff HEAD~1 HEAD

Find Commit:

mug log --oneline | grep "keyword"

Error Recovery

Abort Rebase:

mug rebase --abort

Abort Merge:

mug merge --abort

Undo Reset:

mug reflog
mug reset --hard <commit>

Recover Branch:

mug reflog
mug branch <name> <commit>

Performance Tips

Use Oneline for Speed:

mug log --oneline -n 100

Limit Commit Range:

mug log -n 20

Use Grep for Search:

mug grep "pattern"

Check Status for Overview:

mug status

Merge Conflict TUI

Conflict Markers:

<<<<<<< HEAD
Your version
=======
Their version
>>>>>>> branch-name

Resolution Steps:

  1. Identify conflicts with mug status
  2. Open file in text editor
  3. Review both versions
  4. Choose or combine versions
  5. Remove conflict markers
  6. Save file
  7. Run mug add <file>
  8. Run mug commit

Advanced Commands

Reorder Commits:

mug rebase -i HEAD~5
# Move lines in editor

Extract Commit:

mug cherry-pick abc1234

Split Commit:

mug rebase -i HEAD~3
# Mark commit with 'e' to edit
# Make changes
# Create new commit

Combine Branches:

mug merge other-branch

Reference

For full documentation: see DOCS.md For quick start: see QUICK_START.md For features: see FEATURE_SUMMARY.md