napi-rs/cli/docs/artifacts.md

# 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

| Options         | CLI Options         | type   | required | default        | description                                                                                                        |
| --------------- | ------------------- | ------ | -------- | -------------- | ------------------------------------------------------------------------------------------------------------------ |
|                 | --help,-h           |        |          |                | get help                                                                                                           |
| cwd             | --cwd               | string | false    | process.cwd()  | The working directory of where napi command will be executed in, all other paths options are relative to this path |
| configPath      | --config-path,-c    | string | false    |                | Path to `napi` config json file                                                                                    |
| packageJsonPath | --package-json-path | string | false    | 'package.json' | Path to `package.json`                                                                                             |
| outputDir       | --output-dir,-o,-d  | string | false    | './artifacts'  | Path to the folder where all built `.node` files put, same as `--output-dir` of build command                      |
| npmDir          | --npm-dir           | string | false    | 'npm'          | Path to the folder where the npm packages put                                                                      |