git-xcleaner(1)

1GIT-XCLEANER(1)                                                GIT-XCLEANER(1)
2
3
4

NAME

6       git-xcleaner - interactive git branch removal
7

SYNOPSIS

9       git xcleaner
10

DESCRIPTION

12       This  tool  helps  with  deleting unused topic branches using TUI (text
13       user interface). It also offers mechanisms for  pre-selecting  branches
14       that can be safely removed.
15
16       It  is  NOT  recommended running garbage collection after cleanup, this
17       can wipe mis-deleted branches. If you want to do this, do it prior run‐
18       ning cleaning, so you are still able to recover after few weeks.
19

WARNING

21       This tool deletes git branches after confirmation. There is no way back
22       when git garbage is collected. Double  check  what  you  are  about  to
23       remove!
24

ACTIONS

26       Merged
27
28       Command git branch --merged is used to find a list of branches that are
29       marked for deletion.
30
31       Messages
32
33       For each branch, tip commit message is compared  against  base  history
34       and  if  found, the branch is marked for deletion. Whole commit message
35       is compared and it must fully match.
36
37       User enters base branch name (defaults to "master").
38
39       Remote
40
41       Delete all remote  branches  in  remote  repo  which  are  not  present
42       locally.
43
44       User enters remote name (defaults to current username).
45
46       Upstream
47
48       All branches which no longer exist in origin or specific remote reposi‐
49       tory are marked for deletion.
50
51       User enters specific remote name (defaults to current username).
52
53       Manual
54
55       User manually marks branches for deletion.
56

ACTIVE BRANCH

58       Active branch is never marked for deletion.
59

UNDELETING

61       If you mis-deleted a branch and ignored all the warnings in  documenta‐
62       tion  and on the screen, check out the homepage for instructions how to
63       checkout your branch back.
64

RETURN VALUES

66       Zero on success, one on errors when manipulating with git.
67

BUGS

69       File bugs at https://github.com/lzap/git-xcleaner/issues
70

AUTHOR

72       Lukas Zapletal and contributors (see README.md).
73

COPYRIGHT

75       (c) 2014 Lukas Zapletal
76