diff options
| author | legodude17 <legodudejb@gmail.com> | 2016-08-21 20:12:54 +0300 |
|---|---|---|
| committer | Kat Marchán <kzm@sykosomatic.org> | 2016-09-09 00:53:09 +0300 |
| commit | 8eb94601fe895b97cbcf8c6134e6b371c5371a1e (patch) | |
| tree | 1a82144734925308d50884085a822f7bea1e8286 /doc | |
| parent | a3a2fb97adc87c2aa9b2b8957861b30efafc7ad0 (diff) | |
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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli/npm-link.md | 3 |
1 files changed, 2 insertions, 1 deletions
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/<package>` 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/` |