@xuhaojun/githunk 0.2.0 → 0.3.1
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/README.md +23 -2
- package/dist/githunk.js +1425 -400
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -5,19 +5,40 @@ A review-first Git TUI that mixes [lazygit](https://github.com/jesseduffield/laz
|
|
|
5
5
|
|
|
6
6
|
## Install
|
|
7
7
|
|
|
8
|
+
No Node.js required — githunk ships as a standalone binary:
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
curl -fsSL https://raw.githubusercontent.com/XuHaoJun/githunk/main/install.sh | sh
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
This installs the newest release into `~/.local/bin` (or `$XDG_BIN_HOME`, or `$GITHUNK_INSTALL_DIR`), verifying its checksum first. Pin a version with `sh -s -- 0.2.0`, or pass `--no-modify-path` to skip shell-startup PATH wiring. macOS and Linux only.
|
|
15
|
+
|
|
16
|
+
Alternative via npm (needs Node.js 26.1.0 or newer just to install):
|
|
17
|
+
|
|
8
18
|
```sh
|
|
9
19
|
npm install --global @xuhaojun/githunk
|
|
10
20
|
```
|
|
11
21
|
|
|
12
22
|
## Requirements
|
|
13
23
|
|
|
14
|
-
- Node.js 26.1.0 or newer
|
|
15
24
|
- Git
|
|
16
25
|
- A terminal with interactive TUI support
|
|
17
26
|
|
|
18
27
|
`gh` is optional. When it is installed and authenticated, githunk can show GitHub pull-request status; local Git review works without it.
|
|
19
28
|
|
|
20
|
-
The
|
|
29
|
+
The launcher prefers the prebuilt binary. On platforms without one it falls back to the Node.js bundle, which needs Node.js 26.1.0 or newer; the launcher enables Node's experimental FFI support automatically for OpenTUI.
|
|
30
|
+
|
|
31
|
+
## Update
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
githunk update # newest release
|
|
35
|
+
githunk update 0.3.0 # a specific version
|
|
36
|
+
githunk update --check # report without installing
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Standalone installs replace their own binary after checksum verification. npm installs update through npm instead: `npm update --global @xuhaojun/githunk`.
|
|
40
|
+
|
|
41
|
+
Installer knobs: `GITHUNK_VERSION` pins the version, `GITHUNK_INSTALL_DIR` overrides the install directory, `GITHUNK_NO_MODIFY_PATH=1` skips shell-startup PATH wiring.
|
|
21
42
|
|
|
22
43
|
## Usage
|
|
23
44
|
|