* `npm install <folder>`:

Install the package in the directory as a symlink in the current

project. Its dependencies will be installed before it's linked. If

`<folder>` sits inside the root of your project, its dependencies may

If `<folder>` sits inside the root of your project, its dependencies will be installed and may

be hoisted to the top-level `node_modules` as they would for other

types of dependencies.

types of dependencies. If `<folder>` sits outside the root of your project,

*npm will not install the package dependencies* in the directory `<folder>`,

but it will create a symlink to `<folder>`.

> NOTE: If you want to install the content of a directory like a package from the registry instead of creating a link, you would need to use [`npm pack`](/commands/npm-pack) while in the `<folder>` directory, and then install the resulting tarball instead of the `<folder>` using `npm install <tarball file>`

Example:

```bash

npm install ../../other-package

npm install ./sub-package

```

* `npm install <tarball file>`:

If it works it will output something like:

```bash

Ping success: {*Details about registry*}

npm notice PING https://registry.npmjs.org/

npm notice PONG 255ms

```

otherwise you will get:

otherwise you will get an error:

```bash

Ping error: {*Detail about error}

npm notice PING http://foo.com/

npm ERR! code E404

npm ERR! 404 Not Found - GET http://www.foo.com/-/ping?write=true

```

### Configuration

{

"name": "my-workspaces-powered-project",

"workspaces": [

"workspace-a"

"packages/a"

]

}

```

Given the above `package.json` example living at a current working

directory `.` that contains a folder named `workspace-a` that itself contains

directory `.` that contains a folder named `packages/a` that itself contains

a `package.json` inside it, defining a Node.js package, e.g:

```

.

+-- package.json

`-- workspace-a

`-- package.json

`-- packages

+-- a

| `-- package.json

```

The expected result once running `npm install` in this current working

directory `.` is that the folder `workspace-a` will get symlinked to the

directory `.` is that the folder `packages/a` will get symlinked to the

`node_modules` folder of the current working dir.

Below is a post `npm install` example, given that same previous example

```

.

+-- node_modules

| `-- workspace-a -> ../workspace-a

| `-- packages/a -> ../packages/a

+-- package-lock.json

+-- package.json

`-- workspace-a

`-- package.json

`-- packages

+-- a

| `-- package.json

```

### Getting started with workspaces

</li>

<li>

<p><code>npm install &lt;folder&gt;</code>:</p>

<p>Install the package in the directory as a symlink in the current

project. Its dependencies will be installed before it's linked. If

<code>&lt;folder&gt;</code> sits inside the root of your project, its dependencies may

<p>If <code>&lt;folder&gt;</code> sits inside the root of your project, its dependencies will be installed and may

be hoisted to the top-level <code>node_modules</code> as they would for other

types of dependencies.</p>

types of dependencies. If <code>&lt;folder&gt;</code> sits outside the root of your project,

<em>npm will not install the package dependencies</em> in the directory <code>&lt;folder&gt;</code>,

but it will create a symlink to <code>&lt;folder&gt;</code>.</p>

<blockquote>

<p>NOTE: If you want to install the content of a directory like a package from the registry instead of creating a link, you would need to use <a href="../commands/npm-pack.html"><code>npm pack</code></a> while in the <code>&lt;folder&gt;</code> directory, and then install the resulting tarball instead of the <code>&lt;folder&gt;</code> using <code>npm install &lt;tarball file&gt;</code></p>

</blockquote>

<p>Example:</p>

<pre lang="bash"><code>npm install ../../other-package

npm install ./sub-package

</code></pre>

</li>

<li>

<p><code>npm install &lt;tarball file&gt;</code>:</p>

the results to only the paths to the packages named. Note that nested

packages will <em>also</em> show the paths to the specified packages. For

example, running <code>npm ls promzard</code> in npm's source tree will show:</p>

<pre lang="bash"><code>npm@8.5.0 /path/to/npm

<pre lang="bash"><code>npm@8.5.1 /path/to/npm

└─┬ init-package-json@0.0.4

└── promzard@0.1.5

</code></pre>

<h3 id="description">Description</h3>

<p>Ping the configured or given npm registry and verify authentication.

If it works it will output something like:</p>

<pre lang="bash"><code>Ping success: {*Details about registry*}

<pre lang="bash"><code>npm notice PING https://registry.npmjs.org/

npm notice PONG 255ms

</code></pre>

<p>otherwise you will get:</p>

<pre lang="bash"><code>Ping error: {*Detail about error}

<p>otherwise you will get an error:</p>

<pre lang="bash"><code>npm notice PING http://foo.com/

npm ERR! code E404

npm ERR! 404 Not Found - GET http://www.foo.com/-/ping?write=true

</code></pre>

<h3 id="configuration">Configuration</h3>

<!-- raw HTML omitted -->

<pre lang="bash"><code>npm &lt;command&gt; [args]

</code></pre>

<h3 id="version">Version</h3>

<p>8.5.0</p>

<p>8.5.1</p>

<h3 id="description">Description</h3>

<p>npm is the package manager for the Node JavaScript platform. It puts

modules in place so that node can find them, and manages dependency

<pre lang="json"><code>{

"name": "my-workspaces-powered-project",

"workspaces": [

"workspace-a"

"packages/a"

]

}

</code></pre>

<p>Given the above <code>package.json</code> example living at a current working

directory <code>.</code> that contains a folder named <code>workspace-a</code> that itself contains

directory <code>.</code> that contains a folder named <code>packages/a</code> that itself contains

a <code>package.json</code> inside it, defining a Node.js package, e.g:</p>

<pre><code>.

+-- package.json

`-- workspace-a

`-- package.json

`-- packages

+-- a

| `-- package.json

</code></pre>

<p>The expected result once running <code>npm install</code> in this current working

directory <code>.</code> is that the folder <code>workspace-a</code> will get symlinked to the

directory <code>.</code> is that the folder <code>packages/a</code> will get symlinked to the

<code>node_modules</code> folder of the current working dir.</p>

<p>Below is a post <code>npm install</code> example, given that same previous example

structure of files and folders:</p>

<pre><code>.

+-- node_modules

| `-- workspace-a -&gt; ../workspace-a

| `-- packages/a -&gt; ../packages/a

+-- package-lock.json

+-- package.json

`-- workspace-a

`-- package.json

`-- packages

+-- a

| `-- package.json

</code></pre>

<h3 id="getting-started-with-workspaces">Getting started with workspaces</h3>

<p>You may automate the required steps to define a new workspace using

'set <key>=<value> [<key>=<value> ...]',

'get [<key> [<key> ...]]',

'delete <key> [<key> ...]',

'set [<array>[<index>].<key>=<value> ...]',

'set [<array>[].<key>=<value> ...]',

]

static params = [

.

.IP \(bu 2

\fBnpm install <folder>\fP:

Install the package in the directory as a symlink in the current

project\. Its dependencies will be installed before it's linked\. If

\fB<folder>\fP sits inside the root of your project, its dependencies may

If \fB<folder>\fP sits inside the root of your project, its dependencies will be installed and may

be hoisted to the top\-level \fBnode_modules\fP as they would for other

types of dependencies\.

types of dependencies\. If \fB<folder>\fP sits outside the root of your project,

\fInpm will not install the package dependencies\fR in the directory \fB<folder>\fP,

but it will create a symlink to \fB<folder>\fP\|\.

.QP

NOTE: If you want to install the content of a directory like a package from the registry instead of creating a link, you would need to use npm help \fBpack\fP while in the \fB<folder>\fP directory, and then install the resulting tarball instead of the \fB<folder>\fP using \fBnpm install <tarball file>\fP

.

Example:

.P

.RS 2

.nf

npm install \.\./\.\./other\-package

npm install \./sub\-package

.fi

.RE

.IP \(bu 2

\fBnpm install <tarball file>\fP:

Install a package that is sitting on the filesystem\. Note: if you just