yarn add
Add dependencies to the project.
Usage
$> yarn add ...
Examples
Add a regular package to the current workspace :
yarn add lodash
Add a specific version for a package to the current workspace :
yarn add lodash@1.2.3
Add a package from a GitHub repository (the master branch) to the current workspace using a URL :
yarn add lodash@https://github.com/lodash/lodash
Add a package from a GitHub repository (the master branch) to the current workspace using the GitHub protocol :
yarn add lodash@github:lodash/lodash
Add a package from a GitHub repository (the master branch) to the current workspace using the GitHub protocol (shorthand) :
yarn add lodash@lodash/lodash
Add a package from a specific branch of a GitHub repository to the current workspace using the GitHub protocol (shorthand) :
yarn add lodash-es@lodash/lodash#es
Options
Definition | Description |
---|---|
| Format the output as an NDJSON stream |
| Store dependency tags as-is instead of resolving them |
| Don't use any semver modifier on the resolved range |
| Use the ~ semver modifier on the resolved range |
| Use the ^ semver modifier on the resolved range |
| Add a package as a dev dependency |
| Add a package as a peer dependency |
| Add / upgrade a package to an optional regular / peer dependency |
| Add / upgrade a package to a dev dependency |
| Reuse the specified package from other workspaces in the project |
| Reuse the highest version already used somewhere within the project |
| Change what artifacts installs generate |
Details
This command adds a package to the package.json for the nearest workspace.
If it didn't exist before, the package will by default be added to the regular
dependencies
field, but this behavior can be overriden thanks to the-D,--dev
flag (which will cause the dependency to be added to thedevDependencies
field instead) and the-P,--peer
flag (which will do the same but forpeerDependencies
).If the package was already listed in your dependencies, it will by default be upgraded whether it's part of your
dependencies
ordevDependencies
(it won't ever updatepeerDependencies
, though).If set, the
--prefer-dev
flag will operate as a more flexible-D,--dev
in that it will add the package to yourdevDependencies
if it isn't already listed in eitherdependencies
ordevDependencies
, but it will also happily upgrade yourdependencies
if that's what you already use (whereas-D,--dev
would throw an exception).If set, the
-O,--optional
flag will add the package to theoptionalDependencies
field and, in combination with the-P,--peer
flag, it will add the package as an optional peer dependency. If the package was already listed in yourdependencies
, it will be upgraded tooptionalDependencies
. If the package was already listed in yourpeerDependencies
, in combination with the-P,--peer
flag, it will be upgraded to an optional peer dependency:"peerDependenciesMeta": { "<package>": { "optional": true } }
If the added package doesn't specify a range at all its
latest
tag will be resolved and the returned version will be used to generate a new semver range (using the^
modifier by default unless otherwise configured via thedefaultSemverRangePrefix
configuration, or the~
modifier if-T,--tilde
is specified, or no modifier at all if-E,--exact
is specified). Two exceptions to this rule: the first one is that if the package is a workspace then its local version will be used, and the second one is that if you use-P,--peer
the default range will be*
and won't be resolved at all.If the added package specifies a range (such as
^1.0.0
,latest
, orrc
), Yarn will add this range as-is in the resulting package.json entry (in particular, tags such asrc
will be encoded as-is rather than being converted into a semver range).
If the --cached
option is used, Yarn will preferably reuse the highest version
already used somewhere within the project, even if through a transitive
dependency.
If the -i,--interactive
option is used (or if the preferInteractive
settings
is toggled on) the command will first try to check whether other workspaces in
the project use the specified package and, if so, will offer to reuse them.
If the --mode=<mode>
option is set, Yarn will change which artifacts are
generated. The modes currently supported are:
skip-build
will not run the build scripts at all. Note that this is different from settingenableScripts
to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.update-lockfile
will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.
For a compilation of all the supported protocols, please consult the dedicated page from our website: https://yarnpkg.com/features/protocols.