Back to Napi Rs

Artifacts

cli/docs/artifacts.md

1.0.02.1 KB
Original Source

Artifacts

This file is generated by cli/codegen. Do not edit this file manually.

Copy artifacts from Github Actions into npm packages and ready to publish

Usage

sh
# CLI
napi artifacts [--options]
typescript
// Programatically
import { NapiCli } from '@napi-rs/cli'

new NapiCli().artifacts({
  // options
})

Options

OptionsCLI Optionstyperequireddefaultdescription
--help,-hget help
cwd--cwdstringfalseprocess.cwd()The working directory of where napi command will be executed in, all other paths options are relative to this path
configPath--config-path,-cstringfalsePath to napi config json file
packageJsonPath--package-json-pathstringfalse'package.json'Path to package.json
outputDir--output-dir,-o,-dstringfalse'./artifacts'Path to the folder where all built .node files put, same as --output-dir of build command
npmDir--npm-dirstringfalse'npm'Path to the folder where the npm packages put
buildOutputDir--build-output-dirstringfalsePath to the build output dir, only needed when targets contains wasm32-wasi-*