summaryrefslogtreecommitdiff
path: root/deps/npm/man/man3/npm-link.3
blob: 28d418cc15c4ea881bff21dad9614c24f3500660 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
.\" Generated with Ronnjs 0.3.8
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-LINK" "3" "May 2014" "" ""
.
.SH "NAME"
\fBnpm-link\fR \-\- Symlink a package folder
.
.SH "SYNOPSIS"
.
.nf
npm\.command\.link(callback)
npm\.command\.link(packages, callback)
.
.fi
.
.SH "DESCRIPTION"
Package linking is a two\-step process\.
.
.P
Without parameters, link will create a globally\-installed
symbolic link from \fBprefix/package\-name\fR to the current folder\.
.
.P
With a parameters, link will create a symlink from the local \fBnode_modules\fR
folder to the global symlink\.
.
.P
When creating tarballs for \fBnpm publish\fR, the linked packages are
"snapshotted" to their current state by resolving the symbolic links\.
.
.P
This is
handy for installing your own stuff, so that you can work on it and test it
iteratively without having to continually rebuild\.
.
.P
For example:
.
.IP "" 4
.
.nf
npm\.commands\.link(cb)           # creates global link from the cwd
                                # (say redis package)
npm\.commands\.link(\'redis\', cb)  # link\-install the package
.
.fi
.
.IP "" 0
.
.P
Now, any changes to the redis package will be reflected in
the package in the current working directory