@nimtech/nimpress 2.6.0 → 2.6.2

package/.claude/skills/nimpress/SKILL.md

@@ -112,7 +112,7 @@ nimpress view --offline
 nimpress dev --view
 ```
 
-Serves the central docs site this repo publishes into with the repo's export folder overlaid at its mapped path, and opens the browser on those pages. It needs no config in the repo. The docs site is read from the `docs-notify` step of the workflows under `.github/workflows/`, `docs-repo` and `export-dir`, one link per site when several name one; where none does, the command asks for the repo url, http or ssh, and `--docs-repo=` answers it up front. A connection that is refused leads to a login through `gh` when installed, else by naming the ssh key. Links and the login method persist in `~/.nimpress`, so the question is asked once per repo. The site is cloned under `~/.tide/nimpress/sites/<owner>__<repo>/`, fetched on every run unless `--offline`, and `pnpm install` runs there on first use and on a lockfile change. The mapped path is `nimpress.sources.json` merged with the receiver's `defaults`, the source winning per field. A repo with its own config runs `export` in watch mode underneath; `nimpress dev --view` is the same run from there. `--no-browser` prints the url instead of opening it, `--export-dir=` names the export folder when no workflow does, and `--target=` limits the export to one target name.
+Serves the central docs site this repo publishes into with the repo's export folder overlaid at its mapped path, and opens the browser on those pages. It needs no config in the repo. The docs site is read from the `docs-notify` step of the workflows under `.github/workflows/`, `docs-repo` and `export-dir`, one link per site when several name one; where none does, the command asks for the repo url, http or ssh, and `--docs-repo=` answers it up front. A connection that is refused leads to a login through `gh` when installed, else by naming the ssh key. Links and the login method persist in `~/.nimpress`, so the question is asked once per repo. The site is cloned under `~/.tide/nimpress/sites/<owner>__<repo>/`, fetched on every run unless `--offline`, and `pnpm install` runs there on first use and on a lockfile change. The mapped path is `nimpress.sources.json` merged with the receiver's `defaults`, the source winning per field. The local pages win: a site page whose url, by slug or `path` frontmatter, one of them takes is removed from the clone for the preview, printed as `the local pages replace <file>`, and restored from git on the next sync; the published site still refuses the collision, so the site repo retires that page before the real sync. A repo with its own config runs `export` in watch mode underneath; `nimpress dev --view` is the same run from there. `--no-browser` prints the url instead of opening it, `--export-dir=` names the export folder when no workflow does, and `--target=` limits the export to one target name.
 
 ### cache
 
@@ -184,7 +184,7 @@ nimpress completion --auto --skill
 nimpress completion bash --auto
 ```
 
-With a shell name and no `--auto` it prints the script for `bash`, `zsh`, `fish`, or `powershell` to stdout. `--auto` detects the shell from `$SHELL` when none is named, writes a nimpress owned file under `~/.config/nimpress/completions`, and points the rc file at it inside a block delimited by `# >>> nimpress completion >>>` and `# <<< nimpress completion <<<`. Rerunning `--auto` rewrites the block in place. fish is written to `~/.config/fish/completions/nimpress.fish` and needs no rc change. `--skill` installs this skill globally in the same step and only works alongside `--auto`.
+With a shell name and no `--auto` it prints the script for `bash`, `zsh`, `fish`, or `powershell` to stdout. `--auto` detects the shell from `$SHELL` when none is named, writes a nimpress owned file under `~/.config/nimpress/completions`, and writes the `nimpress` shell function and the completion wiring inside a block of the rc file delimited by `# >>> nimpress completion >>>` and `# <<< nimpress completion <<<`. Rerunning `--auto` rewrites the block in place. fish is written to `~/.config/fish/completions/nimpress.fish` and `~/.config/fish/functions/nimpress.fish` and needs no rc change. The function runs `node_modules/.bin/nimpress` when the current folder has one and `pnpm dlx` of the latest release otherwise, the same order the mcp server starts in. nimpress is never installed with `pnpm add -g`; the global folder is one shared project and another tool's Vite resolves under it. `--skill` installs this skill globally in the same step and only works alongside `--auto`.
 
 ## Where files land
 
@@ -257,10 +257,10 @@ nimpress guard map
 nimpress guard apply --map=uploaded.json
 ```
 
-Install the skill and completion on a fresh machine:
+Install the command, the skill and completion on a fresh machine:
 
 ```sh
-nimpress completion --auto --skill
+pnpm dlx @nimtech/nimpress completion --auto --skill
 ```
 
 ## Failure reading

package/README.md

@@ -40,6 +40,12 @@ pnpm add @nimtech/nimpress
 
 `@nimtech/nimpress` is public on npm. No `.npmrc`, no registry line, no token. It just works.
 
+To run `nimpress` from any folder, install the shell command once. It runs the repo's pinned `node_modules/.bin/nimpress` when there is one and the latest release through `pnpm dlx` everywhere else. Never install it with `pnpm add -g`: the global folder is one shared project, and another global tool's Vite ends up under nimpress.
+
+```bash
+pnpm dlx @nimtech/nimpress completion --auto --skill
+```
+
 ## Set up a site
 
 A consumer needs one config file and the `nimpress` CLI. The CLI owns Vite, serves the app shell and entry as virtual modules, and reads `nimpress.config`. There is no Vite config to write and no app to mount by hand.