Skip to content

Commit

Permalink
docs: Add info about tarball requirements (#20986)
Browse files Browse the repository at this point in the history
  • Loading branch information
Maximaximum authored and zkat committed Jun 28, 2018
1 parent 8f033d7 commit 833efe4
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion doc/cli/npm-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,13 @@ after packing it up into a tarball (b).

Install a package that is sitting on the filesystem. Note: if you just want
to link a dev directory into your npm root, you can do this more easily by
using `npm link`. The filename *must* use `.tar`, `.tar.gz`, or `.tgz` as
using `npm link`.

Tarball requirements:
* The filename *must* use `.tar`, `.tar.gz`, or `.tgz` as
the extension.
* The package contents should reside in a subfolder inside the tarball (usually it is called `package/`). npm strips one directory layer when installing the package (an equivalent of `tar x --strip-components=1` is run).
* The package must contain a `package.json` file with `name` and `version` properties.

Example:

Expand Down

0 comments on commit 833efe4

Please sign in to comment.