Docs
CLI
Rename

Rename

Rename the NAPI-RS project

Usage

# CLI
napi rename [--options]
// Programmatically
import { NapiCli } from '@napi-rs/cli'
 
new NapiCli().rename({
  // 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-pathstringfalsepackage.jsonPath to package.json
npmDir--npm-dirstringfalsenpmPath to the folder where the npm packages put
name--name,-nstringfalseThe new name of the project
binaryName--binary-name,-bstringfalseThe new binary name *.node files
packageName--package-namestringfalseThe new package name of the project
manifestPath--manifest-pathstringfalseCargo.tomlPath to Cargo.toml
repository--repositorystringfalseThe new repository of the project
description--descriptionstringfalseThe new description of the project