Skip to content
Whistle0.3.0
Install

Install

Semantic command graph, projections and wire parsing

For a published npm release:

TERMINAL
npm install @fungi.computer/whistle @opentui/keymap

pnpm, Yarn and Bun work the same way.

Bring your own @opentui/keymap. @fungi.computer/whistle lists it as a peer dependency so your app keeps one copy.

Entrypoints

Section titled “Entrypoints”
  • @fungi.computer/whistle
  • @fungi.computer/whistle/wire
  • @fungi.computer/whistle/interaction
  • @fungi.computer/whistle/catalog
  • @fungi.computer/whistle/html

What comes with it

Section titled “What comes with it”

Installing @fungi.computer/whistle also installs zod.

Install or set up

Section titled “Install or set up”
TERMINAL
npm install @fungi.computer/whistle

Whistle is an ESM package with Zod as its only runtime dependency. It runs in Node, browsers, and Workers. It has five entrypoints:

  • @fungi.computer/whistle: the runtime, scopeSnapshot, the keymap adapter, and the command types.

  • @fungi.computer/whistle/wire: Zod schemas and parsers for command definitions, prompts, notices, and prompt answers.

  • @fungi.computer/whistle/interaction: a renderer-neutral interaction store.

  • @fungi.computer/whistle/catalog: parses a backend’s whistle.catalog/v1 command catalog and turns it into commands.

  • @fungi.computer/whistle/html: binds command projections to a DOM keymap. HTML users install the optional peer @opentui/keymap@0.5.10; core users do not need it.