@pathrule/cli 0.0.12 → 0.0.14
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 +66 -5
- package/dist/index.js +3049 -431
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -60,10 +60,18 @@ pathrule setup --workspace <workspace-id-or-name> --target all --yes
|
|
|
60
60
|
|
|
61
61
|
## Install Options
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
Pathrule CLI requires Node.js `>=20.11.1` on every supported platform.
|
|
64
|
+
After install, the binary lives at whatever path your npm global prefix
|
|
65
|
+
puts it — verify with `command -v pathrule` (macOS/Linux) or
|
|
66
|
+
`where pathrule` (Windows).
|
|
67
|
+
|
|
68
|
+
### macOS
|
|
64
69
|
|
|
65
70
|
```bash
|
|
66
71
|
npm i -g @pathrule/cli
|
|
72
|
+
pathrule login
|
|
73
|
+
pathrule setup
|
|
74
|
+
pathrule doctor
|
|
67
75
|
```
|
|
68
76
|
|
|
69
77
|
Upgrade:
|
|
@@ -72,18 +80,64 @@ Upgrade:
|
|
|
72
80
|
npm i -g @pathrule/cli@latest
|
|
73
81
|
```
|
|
74
82
|
|
|
75
|
-
###
|
|
83
|
+
### Linux
|
|
76
84
|
|
|
77
85
|
```bash
|
|
78
|
-
|
|
86
|
+
npm i -g @pathrule/cli
|
|
87
|
+
pathrule login
|
|
88
|
+
pathrule setup
|
|
89
|
+
pathrule doctor
|
|
79
90
|
```
|
|
80
91
|
|
|
81
|
-
|
|
92
|
+
Optional: the bridge daemon can run under `systemd --user` if your
|
|
93
|
+
distro ships user services. `pathrule daemon start` works without
|
|
94
|
+
systemd; the daemon stays foreground until you stop it.
|
|
95
|
+
|
|
96
|
+
### Windows
|
|
97
|
+
|
|
98
|
+
```powershell
|
|
99
|
+
npm i -g @pathrule/cli
|
|
100
|
+
pathrule login
|
|
101
|
+
pathrule setup
|
|
102
|
+
pathrule doctor
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Notes:
|
|
106
|
+
|
|
107
|
+
- Windows autostart for the bridge daemon is intentionally deferred for
|
|
108
|
+
M41 — start it manually with `pathrule daemon start`. `pathrule daemon
|
|
109
|
+
status --json` reports `supported: false, method: "task-scheduler",
|
|
110
|
+
reason: "deferred (M41): …"` so scripts can distinguish a planned
|
|
111
|
+
no-op from a real failure.
|
|
112
|
+
- The CLI writes a `pathrule-hook.cmd` shim next to `pathrule-hook.js`
|
|
113
|
+
inside `%USERPROFILE%\.pathrule\bin\`. AI clients that spawn hooks
|
|
114
|
+
without a shell (Codex on Windows) execute the `.cmd` directly.
|
|
115
|
+
- If you use a corporate proxy or custom CA, set `HTTPS_PROXY`,
|
|
116
|
+
`HTTP_PROXY`, `NO_PROXY`, or `NODE_EXTRA_CA_CERTS` in the env before
|
|
117
|
+
running `pathrule install <client>` — the CLI propagates those values
|
|
118
|
+
into the managed MCP entry so AI-client-spawned MCP can still reach
|
|
119
|
+
Supabase.
|
|
120
|
+
|
|
121
|
+
### Homebrew (macOS)
|
|
122
|
+
|
|
123
|
+
The Homebrew formula is generated by every release but the tap is not
|
|
124
|
+
yet publishing publicly. Until the `pathrule/homebrew-tap` repository
|
|
125
|
+
goes live, prefer `npm i -g @pathrule/cli@latest`. Once the tap is up,
|
|
126
|
+
`brew upgrade pathrule` will be advertised through `versions.json`.
|
|
127
|
+
|
|
128
|
+
### Local-state override
|
|
129
|
+
|
|
130
|
+
Pathrule keeps per-user state in `~/.pathrule` on every supported OS by
|
|
131
|
+
default. Override with `PATHRULE_HOME` if you need a custom location:
|
|
82
132
|
|
|
83
133
|
```bash
|
|
84
|
-
|
|
134
|
+
PATHRULE_HOME=/srv/pathrule pathrule sync
|
|
85
135
|
```
|
|
86
136
|
|
|
137
|
+
`pathrule install <client>` propagates the active `PATHRULE_HOME` into
|
|
138
|
+
the managed MCP entry so AI-client-spawned MCP reads the same
|
|
139
|
+
credentials.
|
|
140
|
+
|
|
87
141
|
## Authentication
|
|
88
142
|
|
|
89
143
|
Most users do not need to run `pathrule login` manually. `pathrule setup`
|
|
@@ -109,4 +163,11 @@ repository:
|
|
|
109
163
|
- The local bridge binds to loopback and is intended for local browser and CLI
|
|
110
164
|
workflows only.
|
|
111
165
|
|
|
166
|
+
## Troubleshooting and Release Operations
|
|
167
|
+
|
|
168
|
+
- Cross-platform troubleshooting:
|
|
169
|
+
[docs/cli/troubleshooting.md](../../docs/cli/troubleshooting.md)
|
|
170
|
+
- Release operator checklist (canary → promote → rollback):
|
|
171
|
+
[docs/cli/release-checklist.md](../../docs/cli/release-checklist.md)
|
|
172
|
+
|
|
112
173
|
For more details, visit [pathrule.io](https://pathrule.io).
|