napi-rs/cli/docs/create-npm-dirs.md

32 lines
1.9 KiB
Markdown

# Create Npm Dirs
> This file is generated by cli/codegen. Do not edit this file manually.
Create npm package dirs for different platforms
## Usage
```sh
# CLI
napi create-npm-dirs [--options]
```
```typescript
// Programatically
import { NapiCli } from '@napi-rs/cli'
new NapiCli().createNpmDirs({
// 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` |
| npmDir | --npm-dir | string | false | 'npm' | Path to the folder where the npm packages put |
| dryRun | --dry-run | boolean | false | false | Dry run without touching file system |