wukong-gitlog-cli 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -0
- package/README.md +11 -13
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
### [0.0.2](https://github.com/tomatobybike/wukong-gitlog-cli/compare/v0.0.1...v0.0.2) (2025-11-26)
|
|
6
|
+
|
|
5
7
|
### 0.0.1 (2025-11-26)
|
|
6
8
|
|
|
7
9
|
|
package/README.md
CHANGED
|
@@ -33,17 +33,15 @@ cd wukong-gitlog-cli
|
|
|
33
33
|
npm install
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
```bash
|
|
39
|
-
node ./src/cli.mjs --help
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
(Optional) Install globally to run with a short command:
|
|
36
|
+
Install globally to run with a short command (recommended for CLI consumers):
|
|
43
37
|
|
|
44
38
|
```bash
|
|
39
|
+
# Install globally from the repo (for development):
|
|
45
40
|
npm link
|
|
46
|
-
#
|
|
41
|
+
# Or install via npm when published:
|
|
42
|
+
npm i -g wukong-gitlog-cli
|
|
43
|
+
|
|
44
|
+
# Then you can run the CLI globally:
|
|
47
45
|
wukong-gitlog-cli --help
|
|
48
46
|
```
|
|
49
47
|
|
|
@@ -52,7 +50,7 @@ wukong-gitlog-cli --help
|
|
|
52
50
|
## Usage
|
|
53
51
|
|
|
54
52
|
```bash
|
|
55
|
-
|
|
53
|
+
wukong-gitlog-cli [options]
|
|
56
54
|
```
|
|
57
55
|
|
|
58
56
|
Command-line options:
|
|
@@ -83,7 +81,7 @@ Command-line options:
|
|
|
83
81
|
Use the `--gerrit` option to include a Gerrit link for each commit. You can provide a template containing `{{hash}}` to place the full commit hash into the URL, for example:
|
|
84
82
|
|
|
85
83
|
```bash
|
|
86
|
-
|
|
84
|
+
wukong-gitlog-cli --gerrit "https://gerrit.example.com/c/project/+/{{hash}}" --limit 5 --format text
|
|
87
85
|
```
|
|
88
86
|
|
|
89
87
|
If `{{hash}}` is not present, the CLI will append the commit hash to the prefix with a `/` separator.
|
|
@@ -124,19 +122,19 @@ node ./src/cli.mjs --format text --group-by month --gerrit "https://gerrit.examp
|
|
|
124
122
|
Export to Excel with stats and Gerrit URLs:
|
|
125
123
|
|
|
126
124
|
```bash
|
|
127
|
-
|
|
125
|
+
wukong-gitlog-cli --format excel --stats --gerrit "https://gerrit.example.com/c/project/+/{{hash}}"
|
|
128
126
|
```
|
|
129
127
|
|
|
130
128
|
Export raw JSON:
|
|
131
129
|
|
|
132
130
|
```bash
|
|
133
|
-
|
|
131
|
+
wukong-gitlog-cli --json --out commits.json
|
|
134
132
|
```
|
|
135
133
|
|
|
136
134
|
Export text to a custom directory (parent output folder):
|
|
137
135
|
|
|
138
136
|
```bash
|
|
139
|
-
|
|
137
|
+
wukong-gitlog-cli --out-dir ../output --format text --limit 5 --out custom1.txt
|
|
140
138
|
```
|
|
141
139
|
|
|
142
140
|
---
|