Skip to content

README: npm install channel (published + verified) #10

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
anshal21 merged 1 commit into from
Jul 10, 2026
Merged

README: npm install channel (published + verified) #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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.**

Expand Down
10 changes: 7 additions & 3 deletions npm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Loading