pnpm link
Aliases: ln
Makes the current local package accessible system-wide, or in another location.
pnpm link <dir|pkg name>
pnpm link
Options
pnpm link <dir>
Links package from <dir> directory to node_modules of package from where you're executing this command.
For example, if you are inside
~/projects/fooand you executepnpm link ../bar, then a link tobarwill be created infoo/node_modules/bar.
pnpm link
Links package from location where this command was executed to global node_modules, so it can be referred from another package with pnpm link <pkg>. Also if the package has a bin field, then the package's binaries become available system-wide.
pnpm link <pkg>
Links the specified package (<pkg>) from global node_modules to the node_modules of package from where this command was executed.
Use Cases
Replace an installed package with a local version of it
Let's say you have a project that uses foo package. You want to make changes to foo and test them in your project. In this scenario, you can use pnpm link to link the local version of foo to your project.
cd ~/projects/foo
pnpm install # install dependencies of foo
pnpm link # link foo globally
cd ~/projects/my-project
pnpm link foo # link foo to my-project
You can also link a package from a directory to another directory, without using the global node_modules directory:
cd ~/projects/foo
pnpm install # install dependencies of foo
cd ~/projects/my-project
pnpm link ~/projects/foo # link foo to my-project
Add a binary globally
If you are developing a package that has a binary, for example, a CLI tool, you can use pnpm link to make the binary available system-wide. This is the same as using pnpm install -g foo, but it will use the local version of foo instead of downloading it from the registry.
Remember that the binary will be available only if the package has a bin field in its package.json.
cd ~/projects/foo
pnpm install # install dependencies of foo
pnpm link # link foo globally
What's the difference between pnpm link and using the file: protocol?
When you use pnpm link, the linked package is symlinked from the source code. You can modify the source code of the linked package, and the changes will be reflected in your project. With this method pnpm will not install the dependencies of the linked package, you will have to install them manually in the source code. This may be useful when you have to use a specific package manager for the linked package, for example, if you want to use npm for the linked package, but pnpm for your project.
When you use the file: protocol in dependencies, the linked package is hard-linked to your project node_modules, you can modify the source code of the linked package, and the changes will be reflected in your project. With this method pnpm will also install the dependencies of the linked package, overriding the node_modules of the linked package.
When dealing with peer dependencies it is recommended to use the file: protocol. It better resolves the peer dependencies from the project dependencies, ensuring that the linked dependency correctly uses the versions of the dependencies specified in your main project, leading to more consistent and expected behaviors.
| Feature | pnpm link | file: Protocol |
|---|---|---|
| Symlink/Hard-link | Symlink | Hard-link |
| Reflects source code modifications | Yes | Yes |
| Installs dependencies of the linked package | No (manual installation required) | Yes (overrides node_modules of the linked package) |
| Use different package manager for dependency | Possible (e.g., use npm for linked pkg) | No, it will use pnpm |