Installation and updating

Requirements#

• Node ≥ 22, or Bun ≥ 1.3. Node 22 is the floor because earshot targets npm i -g and relies on modern ESM plus import attributes.
• Bun is required for development (workspaces, test runner, bundler). It is not required to run earshot.

Install#

From npm#

npm install --global @raegent/earshot
earshot doctor

The npm package requires Node 22 or newer. It does not require Bun.

Standalone binary#

Release assets are named for their platform:

Download the matching asset from GitHub Releases, make it executable on macOS or Linux (chmod +x earshot-*), and put it somewhere on PATH. The standalone build embeds Bun and does not require Node or Bun to be installed.

Updating#

earshot update

One command for both install forms: it detects whether it is running as an npm install or a standalone binary and updates that one. A binary update is verified against the SHA256SUMS published with the release before anything is replaced. Nothing happens without a confirmation — --yes skips it, --check reports and exits 4 if an update is available. See earshot update.

If a release is in a private repository, updating a standalone binary needs a GitHub token that can read it — GITHUB_TOKEN, GH_TOKEN or EARSHOT_GITHUB_TOKEN. Updating an npm install does not; that package is public.

A source checkout updates with git, not this command.

From source#

git clone https://github.com/rishabhguptajs/earshot
cd earshot
bun install
bun run build

That produces packages/cli/dist/main.js, run through the earshot bin:

node packages/cli/bin/earshot.js --version

To get a global earshot command on your PATH while developing:

cd packages/cli && npm link

Windows#

Install Git for Windows, including Git Bash. Earshot uses Bash for tool commands on every platform; it never silently substitutes PowerShell. Native Windows CI is separate from the hands-on release checklist.