Installation

Knoflows requires Node.js 22 or newer.

Engine

The engine package is @knoflows/engine. Its command is knoflows.

npm install -g @knoflows/engine
npm install -g @knoflows/engine@beta
npm install -g @knoflows/engine@alpha

The unsuffixed version is the more stable channel. @beta has been verified by the maintainer and is not yet graduated. @alpha is freshly implemented and not verified. The version string you install is the stage you are on.

Start it with:

knoflows

That starts the REST API and the bundled web client. The process logs the address it is serving. The preferred port is PORT, or 3000 when PORT is unset. If that port is taken, the next free port is used. Open the logged URL.

knoflows --help lists purge and secrets prune, which do not start the server. See the CLI reference.

CLI

The terminal client is a separate package. It talks to an engine that is already running.

npm install -g @knoflows/cli@alpha

The command is kno. By default it uses http://localhost:3000. Point it elsewhere with --host or KNO_ENGINE_URL. Full flags are in the CLI reference.

Next: Quick start.