npm command-line interface

# npm-init

Create a package.json file

## Table of contents

- Synopsis
- Description

- Forwarding additional options

- Examples
- Workspaces support
- A note on caching

- prefer-online
- prefer-offline
- offline
- workspace
- workspaces

- See Also

### Synopsis

    npm init [--force|-f|--yes|-y|--scope]
    npm init <@scope> (same as `npm exec <@scope>/create`)
    npm init [<@scope>/]<name> (same as `npm exec [<@scope>/]create-<name>`)
    npm init [-w <dir>] [args...]

### Description

`npm init <initializer>` can be used to set up a new or existing npm package.

`initializer` in this case is an npm package named `create-<initializer>`, which will be installed by `npm-exec`, and then have its main bin executed – presumably creating or updating `package.json` and running any other initialization-related operations.

The init command is transformed to a corresponding `npm exec` operation as follows:

- `npm init foo` -> `npm exec create-foo`
- `npm init @usr/foo` -> `npm exec @usr/create-foo`
- `npm init @usr` -> `npm exec @usr/create`

If the initializer is omitted (by just calling `npm init`), init will fall back to legacy init behavior. It will ask you a bunch of questions, and then write a package.json for you. It will attempt to make reasonable guesses based on existing fields, dependencies, and options selected. It is strictly additive, so it will keep any fields and values that were already set. You can also use `-y`/`--yes` to skip the questionnaire altogether. If you pass `--scope`, it will create a scoped package.

#### Forwarding additional options

Any additional options will be passed directly to the command, so `npm init foo -- --hello` will map to `npm exec -- create-foo --hello`.

To better illustrate how options are forwarded, here’s a more evolved example showing options passed to both the npm cli and a create package, both following commands are equivalent:

- `npm init foo -y --registry=<url> -- --hello -a`
- `npm exec -y --registry=<url> -- create-foo --hello -a`

### Examples

Create a new React-based project using `create-react-app`:

    $ npm init react-app ./my-react-app

Create a new `esm`-compatible package using `create-esm`:

    $ mkdir my-esm-lib && cd my-esm-lib
    $ npm init esm --yes

Generate a plain old package.json using legacy init:

    $ mkdir my-npm-pkg && cd my-npm-pkg
    $ git init
    $ npm init

Generate it without having it ask any questions:

    $ npm init -y

### Workspaces support

It’s possible to create a new workspace within your project by using the `workspace` config option. When using `npm init -w <dir>` the cli will create the folders and boilerplate expected while also adding a reference to your project `package.json` `"workspaces": []` property in order to make sure that new generated workspace is properly set up as such.

Given a project with no workspaces, e.g:

    .
    +-- package.json

You may generate a new workspace using the legacy init:

    $ npm init -w packages/a

That will generate a new folder and `package.json` file, while also updating your top-level `package.json` to add the reference to this new workspace:

    .
    +-- package.json
    `-- packages
       `-- a
           `-- package.json

The workspaces init also supports the `npm init <initializer> -w <dir>` syntax, following the same set of rules explained earlier in the initial Description section of this page. Similar to the previous example of creating a new React-based project using `create-react-app`, the following syntax will make sure to create the new react app as a nested workspace within your project and configure your `package.json` to recognize it as such:

    npm init -w packages/my-react-app react-app .

This will make sure to generate your react app as expected, one important consideration to have in mind is that `npm exec` is going to be run in the context of the newly created folder for that workspace, and that’s the reason why in this example the initializer uses the initializer name followed with a dot to represent the current directory in that context, e.g: `react-app .`:

    .
    +-- package.json
    `-- packages
       +-- a
       |   `-- package.json
       `-- my-react-app
           +-- README
           +-- package.json
           `-- ...

### A note on caching

The npm cli utilizes its internal package cache when using the package name specified. You can use the following to change how and when the cli uses this cache. See `npm cache` for more on how the cache works.

#### prefer-online

Forces staleness checks for packages, making the cli look for updates immediately even if the package is already in the cache.

#### prefer-offline

Bypasses staleness checks for packages. Missing data will still be requested from the server. To force full offline mode, use `offline`.

#### offline

Forces full offline mode. Any packages not locally cached will result in an error.

#### workspace

- Alias: `-w`
- Type: Array
- Default: `[]`

Enable running `npm init` in the context of workspaces, creating any missing folders, generating files and adding/updating the `"workspaces"` property of the project `package.json`.

the provided names or paths provided.

Valid values for the `workspace` config are either:

- Workspace names
- Path to a workspace directory
- Path to a parent workspace directory (will result to selecting all of the children workspaces)

#### workspaces

- Alias: `-ws`
- Type: Boolean
- Default: `false`

Run `npm init` in the context of all configured workspaces for the current project.

### See Also

- init-package-json module
- package.json
- npm version
- npm scope
- npm exec
- npm workspaces