From 8eb94601fe895b97cbcf8c6134e6b371c5371a1e Mon Sep 17 00:00:00 2001 From: legodude17 Date: Sun, 21 Aug 2016 10:12:54 -0700 Subject: doc: npm link will link bin of project. This documents the fact that `npm link` will link the files specified in the `bin` field of `package.json` to `{prefix}/bin/{name}`. PR-URL: https://github.com/npm/npm/pull/13717 Credit: @legodude17 Reviewed-By: @zkat --- doc/cli/npm-link.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/cli/npm-link.md b/doc/cli/npm-link.md index 3970ffdf8..7ba228525 100644 --- a/doc/cli/npm-link.md +++ b/doc/cli/npm-link.md @@ -14,7 +14,8 @@ Package linking is a two-step process. First, `npm link` in a package folder will create a symlink in the global folder `{prefix}/lib/node_modules/` that links to the package where the `npm -link` command was executed. (see `npm-config(7)` for the value of `prefix`). +link` command was executed. (see `npm-config(7)` for the value of `prefix`). It +will also link any bins in the package to `{prefix}/bin/{name}`. Next, in some other location, `npm link package-name` will create a symbolic link from globally-installed `package-name` to `node_modules/` -- cgit v1.2.3