Skip to content

README: wire bins via npm scripts, warn against npx #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chalin merged 2 commits into from
Jul 22, 2026
Merged

README: wire bins via npm scripts, warn against npx #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e7eada
README: wire bins via npm scripts, warn against npx
chalin Jul 22, 2026
faa63ed
README: apply Prettier wrapping
chalin Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,29 @@ This puts both bins on your project's `PATH`.

## Usage

Wire the bins into your `package.json` scripts (bare names — `npm run` puts
`node_modules/.bin` on the `PATH`):

```json
"scripts": {
"check:links": "lychee-norm-cache",
"refcache": "refcache"
}
```

```sh
npx lychee-norm-cache # check links, then sort/normalize the cache
npx refcache --summary # cache stats (count, oldest, status, ages)
npm run check:links # check links, then sort/normalize the cache
npm run refcache -- --summary # cache stats (count, oldest, status, ages)
```

> [!WARNING]
>
> Don't invoke these bins via `npx`: this package isn't on the npm registry, so
> on a stale or missing `node_modules`, `npx` falls back to the public registry
> and runs **whatever package holds the name there** (the `lychee-norm-cache`
> name is squatted). Bare bin names in `npm run` scripts resolve locally or fail
> loudly — they never touch the registry.

`lychee-norm-cache` runs in the current directory (your site root) and forwards
any extra arguments to lychee. Run either tool with `--help` for its full
options, and `lychee --help` for the link-checking flags `lychee-norm-cache`
Expand Down