@napi-rs/cli

compare this package
fund

Cli tools for napi-rs

  • Types
  • ESM
  • CJS
License
MIT
Deps
13(-)
View dependency graphInspect dependency tree
Install Size
6.9 MB(52.6 MB)
Vulns
0
Published

Get started

$npm install @napi-rs/cli
$pnpm add @napi-rs/cli
$yarn add @napi-rs/cli
$bun add @napi-rs/cli
$deno add npm:@napi-rs/cli
$vlt install @napi-rs/cli
$vp add @napi-rs/cli
$nub add @napi-rs/cli
# Run locally
$npx napi
$pnpm exec napi
$npx napi
$bunx napi
$deno run npm:@napi-rs/cli
$vlx napi
$vp exec napi
$nubx napi

Weekly DownloadsAcross all versions

Compatibility

Node.js
^20.17.0 || ^22.13.0 || >= 23.5.0

Versions

3.8.2
latest
3.0.0-alpha.100
canary
3.0.0-alpha.4
alpha
2.0.0-beta.5
beta

Dependencies (13)

Peer Dependency (1)

Keywords

Maintainers

Readme

@napi-rs/cli

Download Install size chat

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. Pending napi-rs runtime promises are settled or cancelled first only when the binary exports the napi_prepare_wasm_env_cleanup preparation hook (a planned napi-side follow-up); otherwise they may remain pending forever, so settle in-flight work before disposing. 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]