@yabasha/gex 1.3.4 → 1.3.6

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 CHANGED
@@ -37,15 +37,34 @@ node dist/cli.cjs --help
37
37
 
38
38
  ## Usage
39
39
 
40
- Synopsis:
40
+ ### Top-level entry: `gex` (interactive selector)
41
+
42
+ Starting with v1.3.6, the primary `gex` binary is an interactive launcher that lets you choose which runtime to use:
43
+
44
+ ```bash
45
+ gex
46
+ ```
47
+
48
+ You will be prompted with:
49
+
50
+ ```text
51
+ Select a runtime to use:
52
+ 1) gex-bun (Bun package manager)
53
+ 2) gex-npm (npm / Node.js package manager)
54
+ ```
55
+
56
+ Enter `1` for the Bun-based CLI (`gex-bun`) or `2` for the Node/npm-based CLI (`gex-npm`). The top-level `gex` command only shows this menu and a short hint; it does **not** execute any audit itself. To actually run commands, invoke `gex-bun` or `gex-npm` directly (see below).
57
+
58
+ ### Direct runtimes: `gex-npm` (Node) and `gex-bun` (Bun)
59
+
60
+ You can still call each runtime directly without the interactive selector:
41
61
 
42
62
  ```bash
43
- gex [options] # defaults to: gex local
44
- gex local [options]
45
- gex global [options]
63
+ gex-npm [command] [options] # Node.js / npm runtime (formerly `gex`)
64
+ gex-bun [command] [options] # Bun runtime
46
65
  ```
47
66
 
48
- Common options:
67
+ Common command options:
49
68
 
50
69
  - -f, --output-format <md|json> (default: json)
51
70
  - -o, --out-file <path>
@@ -54,45 +73,45 @@ Common options:
54
73
  - -c, --check-outdated Print a table of outdated packages (shows a lightweight spinner while checking; skips console report output unless `-o` is set so you can write the report to file instead)
55
74
  - -u, --update-outdated [pkg1 pkg2 ...] Update outdated packages (omit names to update everything). Node CLI shells out to `npm update`; Bun CLI mirrors `bun update` for locals and reinstalls globals via `bun add -g pkg@latest`.
56
75
 
57
- Examples:
76
+ Examples (Node/npm runtime via `gex-npm`):
58
77
 
59
78
  ```bash
60
79
  # Local (default): JSON output to console
61
- gex # prints JSON to console (same as: gex local)
62
- gex -o report.json # writes JSON to file
63
- gex -f md # prints markdown to console
64
- gex -f md -o report.md # writes markdown to file
80
+ gex-npm # prints JSON to console (same as: gex-npm local)
81
+ gex-npm -o report.json # writes JSON to file
82
+ gex-npm -f md # prints markdown to console
83
+ gex-npm -f md -o report.md # writes markdown to file
65
84
 
66
85
  # Local: exclude devDependencies
67
- gex local --omit-dev # prints JSON to console
68
- gex local --omit-dev -o deps.json # writes JSON to file
86
+ gex-npm local --omit-dev # prints JSON to console
87
+ gex-npm local --omit-dev -o deps.json # writes JSON to file
69
88
 
70
89
  # Global packages
71
- gex global # prints JSON to console
72
- gex global -o global.json # writes JSON to file
73
- gex global -f md # prints markdown to console
90
+ gex-npm global # prints JSON to console
91
+ gex-npm global -o global.json # writes JSON to file
92
+ gex-npm global -f md # prints markdown to console
74
93
 
75
94
  # Read a previous report (JSON or Markdown)
76
95
  # Default prints names@versions; add -i to install
77
96
  # Positional path or -r/--report are accepted
78
97
  # JSON
79
- gex read
80
- gex read -r path/to/report.json -i
98
+ gex-npm read
99
+ gex-npm read -r path/to/report.json -i
81
100
  # Markdown
82
- gex read global.md
83
- gex read global.md -i
101
+ gex-npm read global.md
102
+ gex-npm read global.md -i
84
103
 
85
104
  # Shell redirection (alternative to -o flag)
86
- gex > report.json # redirect JSON output to file
87
- gex global | jq '.global_packages' # pipe output to jq for processing
105
+ gex-npm > report.json # redirect JSON output to file
106
+ gex-npm global | jq '.global_packages' # pipe output to jq for processing
88
107
 
89
108
  # Check outdated packages / update them (Node runtime)
90
- gex local --check-outdated # show outdated local deps as a table
91
- gex global -c # short flag works too
92
- gex local --update-outdated # update every outdated local dependency
93
- gex local -u axios react # update specific packages
109
+ gex-npm local --check-outdated # show outdated local deps as a table
110
+ gex-npm global -c # short flag works too
111
+ gex-npm local --update-outdated # update every outdated local dependency
112
+ gex-npm local -u axios react # update specific packages
94
113
 
95
- # Bun runtime uses the same flags
114
+ # Bun runtime uses the same flags with Bun semantics
96
115
  gex-bun local --check-outdated
97
116
  gex-bun global --update-outdated # updates global Bun installs via `bun update`/`bun add -g`
98
117
  ```