@yabasha/gex 1.3.8 → 1.4.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.
Files changed (2) hide show
  1. package/README.md +31 -10
  2. package/package.json +4 -2
package/README.md CHANGED
@@ -21,19 +21,37 @@ Reports can be emitted as machine-readable JSON (default) or human-friendly Mark
21
21
  ## Install
22
22
 
23
23
  - Requirements: Node >= 18.18, npm
24
- - Global install:
24
+ - **Global install (npm)**:
25
25
 
26
- ```bash
27
- npm i -g @yabasha/gex
28
- ```
26
+ ```bash
27
+ npm i -g @yabasha/gex
28
+ ```
29
29
 
30
- Or run locally after building this repo:
30
+ - **Global install (Bun)**:
31
31
 
32
- ```bash
33
- npm i
34
- npm run build
35
- node dist/cli.cjs --help
36
- ```
32
+ ```bash
33
+ bun add -g @yabasha/gex
34
+ ```
35
+
36
+ - **Local Build / Development**:
37
+
38
+ clone the repository and run:
39
+
40
+ **Using npm**:
41
+
42
+ ```bash
43
+ npm i
44
+ npm run build
45
+ node dist/cli.cjs --help
46
+ ```
47
+
48
+ **Using Bun**:
49
+
50
+ ```bash
51
+ bun install
52
+ bun run build
53
+ bun dist/cli-bun.mjs --help
54
+ ```
37
55
 
38
56
  ## Usage
39
57
 
@@ -85,7 +103,10 @@ You can also call each runtime directly without the interactive launcher:
85
103
 
86
104
  ```bash
87
105
  gex-node [command] [options] # Node.js / npm runtime (formerly `gex`)
106
+ # Alias: gn
107
+
88
108
  gex-bun [command] [options] # Bun runtime
109
+ # Alias: gb
89
110
  ```
90
111
 
91
112
  Common command options:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yabasha/gex",
3
- "version": "1.3.8",
3
+ "version": "1.4.1",
4
4
  "private": false,
5
5
  "description": "A CLI tool for auditing and documenting your Node.js package environment, generating comprehensive reports of global and local dependencies.",
6
6
  "type": "module",
@@ -17,7 +17,9 @@
17
17
  "bin": {
18
18
  "gex": "./dist/cli.cjs",
19
19
  "gex-node": "./dist/cli-node.cjs",
20
- "gex-bun": "./dist/cli-bun.mjs"
20
+ "gex-bun": "./dist/cli-bun.mjs",
21
+ "gb": "./dist/cli-bun.mjs",
22
+ "gn": "./dist/cli-node.cjs"
21
23
  },
22
24
  "files": [
23
25
  "dist"