@incremental/engine
v0.1.3
Published
Prebuilt native binaries for the Incremental compute engine
Readme
@incremental/engine
Prebuilt native binaries for the Incremental compute engine (core/dist/incremental).
Purpose
This package bundles the platform-specific native engine binary so consumers of
@incremental/client can run incremental serve / incremental affected /
incremental init etc. without building Goose from source.
Installation
npm install @incremental/engineBinary resolution
@incremental/client resolves the engine binary through
@incremental/engine.enginePath():
INCREMENTAL_ENGINEenvironment variable (explicit override)- Prebuilt binary bundled in this package
(
prebuilds/<platform>-<arch>/incremental) - Dev-mode fallback:
core/dist/incrementalin the incremental monorepo
Supported platforms
| Platform | Arch | Status | | -------- | ----- | ------------------------------ | | darwin | arm64 | ✅ Prebuilt binary included | | darwin | x64 | ✅ Prebuilt binary included | | linux | x64 | Available via GitHub Releases* | | linux | arm64 | Available via GitHub Releases* |
* install.js downloads the incremental-<platform>-<arch> asset from the
latest GitHub Release at install time when no prebuild is bundled; you can
also build locally with make build and point INCREMENTAL_ENGINE at the
result.
Building the binary
From the incremental monorepo root:
make build # builds core/dist/incremental via Goose toolchainPackage contents
bin/incremental.js— CLI entry point that execs the native binaryindex.js/index.d.ts—enginePath()andengineDir()exportsinstall.js— postinstall script (verifies prebuilt binary or downloads)prebuilds/<platform>-<arch>/incremental— native engine binary
Usage
import { enginePath } from "@incremental/engine";
console.log(enginePath()); // /path/to/incremental binaryLicense
Apache-2.0
