@dotcomjack/grux 1.2.1 → 3.0.0
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 +13 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
The one command front door to [Grux OS](https://gruxai.com).
|
|
4
4
|
|
|
5
5
|
```sh
|
|
6
|
-
npx grux
|
|
6
|
+
npx @dotcomjack/grux
|
|
7
7
|
```
|
|
8
8
|
|
|
9
9
|
That finds Grux.app on your Mac, puts `grux` on your PATH, and hands you to the
|
|
@@ -24,13 +24,20 @@ bundle rather than beside it, so there is no separate artifact to fetch. If the
|
|
|
24
24
|
app is not on your Mac, the launcher says so, prints the download link, and
|
|
25
25
|
changes nothing.
|
|
26
26
|
|
|
27
|
+
## Why the scoped name
|
|
28
|
+
|
|
29
|
+
npm refuses `grux` as a bare name. Its typosquatting filter rejects it as too
|
|
30
|
+
close to `grunt`, `grpc`, `flux`, `rax`, `rx` and `urix`, and the scoped name is
|
|
31
|
+
npm's own suggested remedy. The command it installs is still plain `grux`, so
|
|
32
|
+
after the first run you type three letters either way.
|
|
33
|
+
|
|
27
34
|
## Usage
|
|
28
35
|
|
|
29
36
|
```sh
|
|
30
|
-
npx grux # link, then run setup (or status when not a terminal)
|
|
31
|
-
npx grux status # anything else is passed straight through
|
|
32
|
-
npx grux status --json # including flags, verbatim
|
|
33
|
-
npx grux --link-only # just put grux on the PATH, run nothing
|
|
37
|
+
npx @dotcomjack/grux # link, then run setup (or status when not a terminal)
|
|
38
|
+
npx @dotcomjack/grux status # anything else is passed straight through
|
|
39
|
+
npx @dotcomjack/grux status --json # including flags, verbatim
|
|
40
|
+
npx @dotcomjack/grux --link-only # just put grux on the PATH, run nothing
|
|
34
41
|
```
|
|
35
42
|
|
|
36
43
|
`--link-only` is the single flag this launcher consumes, and only as the first
|
|
@@ -47,7 +54,7 @@ The same four the Swift CLI uses, forwarded rather than reinvented.
|
|
|
47
54
|
| 2 | Waiting on you, on this Mac. Nothing any flag can do. |
|
|
48
55
|
| 3 | Run `grux doctor`. |
|
|
49
56
|
|
|
50
|
-
`npx grux` on a Mac with no Grux.app exits **2**, because installing it is
|
|
57
|
+
`npx @dotcomjack/grux` on a Mac with no Grux.app exits **2**, because installing it is
|
|
51
58
|
something only you can do.
|
|
52
59
|
|
|
53
60
|
## Where the link goes
|
package/package.json
CHANGED