- License
- MIT
- Install Size
- 7.2 MB(51.7 MB)
- Vulns
- 0
- Published
npm install @napi-rs/clipnpm add @napi-rs/cliyarn add @napi-rs/clibun add @napi-rs/clideno add npm:@napi-rs/clivlt install @napi-rs/clivp add @napi-rs/clinub add @napi-rs/clinpx napipnpm exec napinpx napibunx napideno run npm:@napi-rs/clivlx napivp exec napinubx napi@napi-rs/cli
Cli tools for napi-rs
# or npm, pnpm
yarn add @napi-rs/cli -D
yarn napi build
Requirements
@napi-rs/cli supports Node.js ^20.17.0, ^22.13.0, and >=23.5.0.
Earlier Node.js releases are no longer supported by the CLI runtime.
Commands
| Command | desc | docs |
|---|---|---|
| new | create new napi-rs project | ./docs/new.md |
| build | build napi-rs project | ./docs/build.md |
| create-npm-dirs | Create npm package dirs for different platforms | ./docs/create-npm-dirs |
| artifacts | Copy artifacts from Github Actions into specified dir | ./docs/artifacts.md |
| rename | Rename the napi-rs project | ./docs/rename.md |
| universalize | Combile built binaries into one universal binary | ./docs/universalize.md |
| version | Update version in created npm packages by create-npm-dirs |
./docs/version.md |
| pre-publish | Update package.json and copy addons into per platform packages | ./docs/pre-publish.md |
Disposing generated WASI bindings
Generated WASI bindings expose deterministic cleanup through a non-enumerable symbol on the binding object:
const binding = require('<package>')
const dispose = binding[Symbol.for('napi.rs.wasi.dispose')]
if (dispose) {
await dispose()
}
The symbol is present only when the loaded binding is WASI. Browser WASI
loaders expose it on their default export. Disposal releases the instance: it
destroys the emnapi context and then terminates the workers owned by that
binding. Before that, the loader calls the binary's
napi_prepare_wasm_env_cleanup preparation hook, which shuts the addon's async
runtime down while the environment can still call into JavaScript. A registered
AsyncRuntime backend quiesces there and its cancelled tasks reject their
promises; the built-in Tokio runtime only starts draining, so with it a
promise whose task is still running can still be left pending. Settle in-flight
work before disposing if that matters. Concurrent calls share one
promise, successful disposal is idempotent, and a failed cleanup phase can be
retried by calling the same function again. Do not call addon exports after
disposal completes.
See WASI targets and loaders for threaded, threadless, browser, and workerd packaging behavior.
Debug mode
DEBUG="napi:*" napi [command]