Installation
Neurowire is published as a set of scoped npm packages. Install only the ones you need for your use case.
Requirements
- Node >= 24. Every package declares
engines.node: ">=24". - ESM only. All packages are
"type": "module". Import them withimport, notrequire.
Published packages
| Package | Version | Role |
|---|---|---|
@neurowire/core | 0.7.0 | Canonical model, serializers (NWF, atom, rss, json, md), validateNwf, mergeFeeds, mesh/construct types. Pure, no network. |
@neurowire/ingest | 0.6.0 | Fetch + detect + parse, HTML auto-detect, the CSS-template engine, fetchFeed/fetchMesh/fetchConstruct. |
@neurowire/taps | 0.3.0 | Curated per-host templates for feed-less sites plus loaders. |
@neurowire/tap-wizard | 0.1.0 | Tap authoring and healing: candidate selectors, preview, and the verification gate. No model, no API key. |
@neurowire/cli | 0.7.0 | The neurowire binary. |
@neurowire/web | 0.5.0 | HTML page generator: toHtml plus the neurowire-web binary. |
Dependency direction
Dependencies flow strictly one way: core <- ingest <- (taps, tap-wizard) <- (cli, web). Higher packages pull in everything below them, so you rarely install more than one for a given job. taps and tap-wizard are siblings and know nothing of each other: one carries taps, the other authors them.
Which package do I install?
CLI users
Install the CLI globally and use the neurowire command. It bundles core, ingest, taps, and tap-wizard, so tap wizard, tap check, and tap heal work out of the box with nothing else to install.
pnpm add -g @neurowire/clinpm install -g @neurowire/cliPage generators
For self-contained HTML news pages, install the web package. It ships the neurowire-web binary and the toHtml / toConstructHtml / toConstructPages functions.
pnpm add -g @neurowire/webnpm install -g @neurowire/webLibrary users
Add packages to your project as dependencies (not global). Most programmatic work needs @neurowire/ingest (which re-exports nothing from core, so add core too for the types and serializers):
pnpm add @neurowire/core @neurowire/ingestnpm install @neurowire/core @neurowire/ingestAdd @neurowire/tap-wizard when your own code needs to author, verify, or heal taps rather than just use them. It is what the CLI's tap commands are built on, and it pulls in nothing beyond core, ingest, and cheerio:
pnpm add @neurowire/tap-wizardnpm install @neurowire/tap-wizardSee @neurowire/tap-wizard for the API.
Add @neurowire/taps when you want curated recipes for feed-less sites (call registerAllTaps()), and @neurowire/web when you want HTML rendering:
pnpm add @neurowire/taps @neurowire/webnpm install @neurowire/taps @neurowire/webSee Library usage for code examples.
Verify the install
neurowire --version