From 2572dac2daa3386b8bc07c74f6ce7af888d932d4 Mon Sep 17 00:00:00 2001 From: anshal21 Date: Fri, 10 Jul 2026 12:49:48 +0530 Subject: [PATCH] readme: npm install channel, live and stranger-tested @firstops/whittle@0.3.0 is published (all five packages) and verified cold from the public registry: npx -y @firstops/whittle version runs the real release binary. The install section now leads with npm install -g (durable path for the background service; bare npx would wire launchd at npm's prunable cache, a real footgun caught in review and documented in the npm README too), keeps go install and brew alongside, and adds a zero-commitment npx try-it line plus the npm version badge. Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 7 ++++--- npm/README.md | 10 +++++++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b506efc..32ad69f 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![CI](https://github.com/firstops-dev/whittle/actions/workflows/ci.yml/badge.svg)](https://github.com/firstops-dev/whittle/actions/workflows/ci.yml) [![Release](https://img.shields.io/github/v/release/firstops-dev/whittle)](https://github.com/firstops-dev/whittle/releases) +[![npm](https://img.shields.io/npm/v/%40firstops%2Fwhittle)](https://www.npmjs.com/package/@firstops/whittle) [![Go Reference](https://pkg.go.dev/badge/github.com/firstops-dev/whittle.svg)](https://pkg.go.dev/github.com/firstops-dev/whittle) [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE) @@ -33,11 +34,11 @@ Built for engineers running long Claude Code sessions who refuse to trade fideli ## Install ```sh -go install github.com/firstops-dev/whittle/cmd/whittle@latest -whittle setup # hook + local daemon + optional ML sidecar, one command +npm install -g @firstops/whittle # or: go install github.com/firstops-dev/whittle/cmd/whittle@latest +whittle setup # hook + local daemon + optional ML sidecar, one command ``` -Tool outputs are whittled from now on; `whittle stats` shows what you're saving. (Homebrew: `brew install firstops-dev/tap/whittle`. If `go install`'s binary isn't found, add `~/go/bin` to your PATH. Linux runs the daemon under systemd, see [notes](docs/compression.md).) +Tool outputs are whittled from now on; `whittle stats` shows what you're saving. Try it with zero commitment: `npx -y @firstops/whittle compress build.log`. (Homebrew: `brew install firstops-dev/tap/whittle`. Linux runs the daemon under systemd, see [notes](docs/compression.md).) **Optional: turn on model routing.** diff --git a/npm/README.md b/npm/README.md index c013267..279a724 100644 --- a/npm/README.md +++ b/npm/README.md @@ -8,10 +8,14 @@ Linux, arm64 and amd64). It is the npm distribution of same binaries also ship via `go install` and Homebrew. ```sh -npx @firstops/whittle setup # one command: hook + local daemon + sidecar -# or install globally: -npm install -g @firstops/whittle && whittle setup +npm install -g @firstops/whittle +whittle setup # one command: hook + local daemon + sidecar ``` +(Use `npm install -g` rather than bare `npx` for setup: setup registers a +background service pointing at the installed binary, and the npx cache is not a +stable home for it. `npx -y @firstops/whittle compress file.log` is fine for +trying whittle without installing.) + Full documentation, benchmarks, and the fidelity contract: [the repository](https://github.com/firstops-dev/whittle).