Skip to content

Commit ce554fe

Browse files
committed
Match nested plugin README: PATH prepend, then screenrig.
1 parent 68f69ff commit ce554fe

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

‎plugins/screenrig/README.md‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@ app you want, and it goes on the Player.
2727
## Install
2828

2929
The official install is this plugin. Do not install a global `screenrig` from a
30-
package registry and do not expect one on `PATH`: "CLI" names the product
31-
category, and the bundled CLI runs from the plugin's package-relative launcher.
30+
package registry. After install, prepend `$SCREENRIG_PLUGIN_ROOT/skills/screenrig/scripts`
31+
(or the runtime plugin root) to `PATH` once, then invoke `screenrig`. Do not
32+
export `SR`. "CLI" names the product category, and the bundled CLI is the
33+
plugin wrapper, not a global package.
3234

3335
Claude Code:
3436

@@ -53,11 +55,13 @@ grok plugin install screenrig --trust
5355

5456
Node.js 20.11 or newer must be active. Read the ScreenRig package root from your
5557
agent's plugin list (`claude plugin list --json`, `codex plugin list --json`) or
56-
from `GROK_PLUGIN_ROOT`, `CLAUDE_PLUGIN_ROOT`, or `CODEX_PLUGIN_ROOT`, then
57-
confirm the bundled CLI:
58+
from `GROK_PLUGIN_ROOT`, `CLAUDE_PLUGIN_ROOT`, or `CODEX_PLUGIN_ROOT`, prepend
59+
`$SCREENRIG_PLUGIN_ROOT/skills/screenrig/scripts` to `PATH` once, then confirm:
5860

5961
```sh
60-
<plugin-root>/skills/screenrig/scripts/screenrig --json version
62+
SCREENRIG_PLUGIN_ROOT="${GROK_PLUGIN_ROOT:-${CODEX_PLUGIN_ROOT:-${CLAUDE_PLUGIN_ROOT:-${PLUGIN_ROOT:-}}}}"
63+
PATH="$SCREENRIG_PLUGIN_ROOT/skills/screenrig/scripts:$PATH"
64+
screenrig --json version
6165
```
6266

6367
That launcher is the entry point for every ScreenRig command. It runs the

0 commit comments

Comments
 (0)