You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
`git-merged-branches` is a simple command-line utility that allows you to view all branches that have been merged into a selected base branch, such as master.
**git-merged-branches` is a command-line utility to view branches merged into a selected base branch (e.g., master or main).**
7
+
8
+
- CLI usage
9
+
- customizable via `package.json`
4
10
5
11
## Installation
6
12
7
-
To install `git-merged-branches`globally, use the following command:
13
+
Install globally to use `git-merged-branches`or the shorter version `gmb`:
8
14
9
15
```bash
10
16
npm install --global git-merged-branches
11
17
```
12
18
13
-
## Usage
19
+
Or use it without installation via [npx](https://docs.npmjs.com/cli/v7/commands/npx):
14
20
15
-
After installation, you can use the `git-merged-branches` command in your terminal. By default, it will show a list of branches that have been merged into the base branch (e.g., master or main).
21
+
```bash
22
+
npx git-merged-branches
23
+
```
16
24
17
-
The utility checks for the default base branch (**master** or **main**), and if neither exists, it will notify you.
25
+
## Usage
18
26
19
-
When you run the `git-merged-branches` command, it will show a list of branches that have been merged into the base branch:
27
+
By default, the command shows merged branches into the base branch (**master** or **main**). If neither exists, it will notify you.
28
+
29
+
Example output:
20
30
21
31
```bash
22
32
$ git-merged-branches
@@ -26,26 +36,23 @@ bugfix/fix-crash-on-start
26
36
hotfix/urgent-fix
27
37
```
28
38
29
-
Also, you may use `gmb` as an alias for `git-merged-branches`.
30
-
31
39
## Configuration
32
40
33
-
You can configure the behavior of the `git-merged-branches` command by adding a `git-merged-branches` object to your `package.json`.
34
-
The configuration allows you to specify:
41
+
You can configure the utility in your `package.json` under `git-merged-branches`. This allows you to set:
35
42
36
-
-**issueUrlFormat**: The base URL for your issue tracker. Must be a valid URL. If it's not, the utility will warn you.
37
-
-**issueUrlPrefix**: The prefix used to identify issues in branch names. Must consist of letters. If it's not, the utility will warn you.
43
+
-**issueUrlFormat**: Base URL for your issue tracker (must be a valid URL).
44
+
-**issueUrlPrefix**: Prefix for issue identifiers in branch names (must be letters).
38
45
39
-
Here is an example of how to add the configuration:
Now you can run `git-merged-branches` on your local machine.
98
+
99
+
## Contributing
100
+
101
+
If you have any ideas, bug reports, or feature requests, feel free to [contribute](https://github.com/VChet/git-merged-branches/pulls) or report [issues](https://github.com/VChet/git-merged-branches/issues).
0 commit comments