@vlandoss/run-run 0.5.1 → 0.5.2

package/README.md

@@ -18,7 +18,7 @@ CLI toolbox to fullstack common scripts in [Variable Land](https://variable.land
 ## Installation
 
 ```sh
-pnpm add @vlandoss/run-run
+pnpm add -D @vlandoss/run-run
 ```
 
 It adds the `rr` command to your project.
@@ -28,39 +28,83 @@ It adds the `rr` command to your project.
 Run the help command:
 
 ```sh
-rr help
+pnpm rr help
 ```
 
+> If you have `node_modules/.bin` on your `PATH` (e.g. via `mise` or `direnv` — see [Shell completion](#shell-completion)), you can drop the `pnpm` prefix and invoke `rr` directly.
+
 See [`CLI.md`](./CLI.md) for the full reference (auto-generated per release).
 
 ## Shell completion
 
-`rr` ships a `completion` subcommand that prints a shell-specific script. Add it to your shell rc file:
+`rr` ships a `completion` subcommand that prints a shell-specific script.
+Pick the option that matches your setup.
+
+### Option A — with `mise` or `direnv` (recommended)
+
+If your tooling puts `node_modules/.bin` on `PATH` per-project, `rr` resolves at shell startup and completion picks up new commands automatically on each new shell. Examples:
+
+```toml
+# mise.toml
+[env]
+_.path = ["{{config_root}}/node_modules/.bin"]
+```
+
+```sh
+# .envrc (direnv)
+PATH_add node_modules/.bin
+```
+
+Then add a guarded eval to your shell rc — the guard makes it a no-op when you open a shell outside any project:
 
 ```sh
 # zsh — ~/.zshrc
-eval "$(rr completion zsh)"
+command -v rr >/dev/null 2>&1 && eval "$(rr completion zsh)"
 
 # bash — ~/.bashrc
-eval "$(rr completion bash)"
+command -v rr >/dev/null 2>&1 && eval "$(rr completion bash)"
 
 # fish — ~/.config/fish/config.fish
-rr completion fish | source
+command -v rr >/dev/null 2>&1; and rr completion fish | source
 ```
 
-**Prerequisite:** the [`usage`](https://usage.jdx.dev) CLI must be on your `PATH` (it powers completion at runtime). Install via one of:
+### Option B — without a per-project PATH manager
+
+Cache the completion script once, then source the cached file from your shell rc. Run the generation step from inside a project that has `@vlandoss/run-run` installed:
+
+```sh
+mkdir -p ~/.cache
+pnpm exec rr completion zsh  > ~/.cache/rr-completion.zsh
+pnpm exec rr completion bash > ~/.cache/rr-completion.bash
+pnpm exec rr completion fish > ~/.cache/rr-completion.fish
+```
+
+```sh
+# zsh — ~/.zshrc
+[ -f ~/.cache/rr-completion.zsh ] && source ~/.cache/rr-completion.zsh
+
+# bash — ~/.bashrc
+[ -f ~/.cache/rr-completion.bash ] && source ~/.cache/rr-completion.bash
+
+# fish — ~/.config/fish/config.fish
+test -f ~/.cache/rr-completion.fish; and source ~/.cache/rr-completion.fish
+```
+
+Regenerate the cache after upgrading `@vlandoss/run-run` to pick up new commands.
+
+### Prerequisite
+
+The [`usage`](https://usage.jdx.dev) CLI must be on your `PATH` (it powers completion at runtime). Install via one of:
 
 ```sh
 mise use -g usage
 brew install usage
 ```
 
-When you upgrade `@vlandoss/run-run`, the next shell session will pick up new commands automatically — no need to re-run anything.
-
 ## Troubleshooting
 
 To enable debug mode, set the `DEBUG` environment variable to `run-run:*` before running *any* command.
 
 ```sh
-DEBUG=run-run:* rr <command>
+DEBUG=run-run:* pnpm rr <command>
 ```

package/dist/cli.usage.kdl

@@ -1,7 +1,7 @@
 // @generated by @usage-spec/commander from Commander.js metadata
 name rr
 bin rr
-version "0.5.1"
+version "0.5.2"
 usage "[options] <command...>"
 flag --usage help="print KDL spec for this CLI (https://kdl.dev)"
 cmd completion help="print shell completion script 🐚 (usage)" {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vlandoss/run-run",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "The CLI toolbox to fullstack common scripts in Variable Land",
   "homepage": "https://github.com/variableland/dx/tree/main/packages/run-run#readme",
   "bugs": {
@@ -63,8 +63,8 @@
     "rimraf": "6.1.3",
     "tsdown": "0.21.10",
     "typescript": "6.0.3",
-    "@vlandoss/clibuddy": "0.5.0",
-    "@vlandoss/loggy": "0.2.0"
+    "@vlandoss/loggy": "0.2.0",
+    "@vlandoss/clibuddy": "0.5.0"
   },
   "devDependencies": {
     "@vlandoss/tsdown-config": "^0.0.1"