Subcommands68 subcommands
yarn add
Installs a package and any packages that it depends on
yarn audit
Perform a vulnerability audit against the installed packages
yarn autoclean
Cleans and removes unnecessary files from package dependencies
yarn bin
Displays the location of the yarn bin folder
yarn cache
Yarn cache list will print out every cached package
yarn cache clean
Clear global cache
yarn cache dir
Print yarn’s global cache path
yarn cache list
Print out every cached package
yarn config
Configure yarn
yarn config set
Sets the config key to a certain value
yarn config get
Print the value for a given key
yarn config delete
Deletes a given key from the config
yarn config list
Displays the current configuration
yarn create
Creates new projects from any create-* starter kits
yarn generate-lock-entry
Generates a lock file entry
yarn global
Manage yarn globally
yarn global add
Install globally packages on your operating system
yarn global bin
Displays the location of the yarn global bin folder
yarn global dir
Displays the location of the global installation folder
yarn global ls
List globally installed packages (deprecated)
yarn global list
List globally installed packages
yarn global remove
Remove globally installed packages
yarn global upgrade
Upgrade globally installed packages
yarn global upgrade-interactive
Display the outdated packages before performing any upgrade
yarn help
Output usage information
yarn import
Generates yarn.lock from an npm package-lock.json file
yarn info
Show information about a package
yarn init
Interactively creates or updates a package.json file
yarn install
Install all the dependencies listed within package.json
yarn licenses list
List licenses for installed packages
yarn licenses generate-disclaimer
List of licenses from all the packages
yarn link
Symlink a package folder during development
yarn list
Lists all dependencies for the current working directory
yarn login
Store registry username and email
yarn logout
Clear registry username and email
yarn outdated
Checks for outdated package dependencies
yarn owner
Manage package owners
yarn owner list
Lists all of the owners of a package
yarn owner add
Adds the user as an owner of the package
yarn owner remove
Removes the user as an owner of the package
yarn pack
Creates a compressed gzip archive of package dependencies
yarn policies
Defines project-wide policies for your project
yarn policies set-version
Will download the latest stable release
yarn publish
Publishes a package to the npm registry
yarn remove
Remove installed package
yarn run
Runs a defined package script
yarn tag
Add, remove, or list tags on a package
yarn team
Maintain team memberships
yarn team create
Create a new team
yarn team destroy
Destroys an existing team
yarn team add
Add a user to an existing team
yarn team remove
Remove a user from a team they belong to
yarn team list
If performed on an organization name, will return a list of existing teams under that organization. If performed on a team, it will instead return a list of all users belonging to that particular team
yarn unlink
Unlink a previously created symlink for a package
yarn upgrade
Upgrades packages to their latest version based on the specified range
yarn upgrade-interactive
Upgrades packages in interactive mode
yarn version
Update version of your package
yarn versions
Displays version information of the currently installed Yarn, Node.js, and its dependencies
yarn why
Show information about why a package is installed
yarn workspace
Manage workspace
yarn workspaces
Show information about your workspaces
yarn set
Set global Yarn options
yarn set resolution
Enforce a package resolution
yarn set version
Lock the Yarn version used by the project
OptionsOn yarn itself
--disable-pnp
Disable the Plug'n'Play installation
--emoji
Enable emoji in output (default: true) <bool>
--enable-pnp--pnp
Enable the Plug'n'Play installation
--flat
Only allow one version of a package
--focus
Focus on a single workspace by installing remote copies of its sibling workspaces
--force
Install and build packages even if they were built before, overwrite lockfile
--frozen-lockfile
Don't generate a lockfile and fail if an update is needed
--global-folder
Specify a custom folder to store global packages <value>
--har
Save HAR output of network traffic
--ignore-engines
Ignore engines check
--ignore-optional
Ignore optional dependencies
--ignore-platform
Ignore platform checks
--ignore-scripts
Don't run lifecycle scripts
--json
Format Yarn log messages as lines of JSON (see jsonlines.org)
--link-duplicates
Create hardlinks to the repeated modules in node_modules
--link-folder
Specify a custom folder to store global links <value>
--modules-folder
Rather than installing modules into the node_modules folder relative to the cwd, output them here <value>
--mutex
Use a mutex to ensure only one yarn instance is executing <type> <specifier>
--network-concurrency
Maximum number of concurrent network requests <number>
--network-timeout
TCP timeout for network requests <milliseconds>
--no-bin-links
Don't generate bin links when setting up packages
--no-default-rc
Prevent Yarn from automatically detecting yarnrc and npmrc files
--no-lockfile
Don't read or generate a lockfile
--non-interactive
Do not show interactive prompts
--no-node-version-check
Do not warn when using a potentially unsupported Node version
--no-progress
Disable progress bar
--offline
Trigger an error if any required dependencies are not available in local cache
--otp
One-time password for two factor authentication <otpcode>
--prefer-offline
Use network only if dependencies are not available in local cache
--preferred-cache-folder
Specify a custom folder to store the yarn cache if possible <value>
--prod--production
<value>
--pure-lockfile
Don't generate a lockfile
--registry
Override configuration registry <url>
-s--silent
Skip Yarn console logs, other types of logs (script output) will be printed
--scripts-prepend-node-path
Prepend the node executable dir to the PATH in scripts <value>
--skip-integrity-check
Run install without checking if node_modules is installed
-s--silent
Skip Yarn console logs
--no-default-rc
Prevent Yarn from automatically detecting yarnrc and npmrc files
--use-yarnrc
Specifies a yarnrc file that Yarn should use (.yarnrc only, not .npmrc) (default: ) <path>
--verbose
Output verbose messages on internal operations
--offline
Trigger an error if any required dependencies are not available in local cache
--prefer-offline
Use network only if dependencies are not available in local cache
--enable-pnp--pnp
Enable the Plug'n'Play installation
--json
Format Yarn log messages as lines of JSON
--ignore-scripts
Don't run lifecycle scripts
--har
Save HAR output of network traffic
--ignore-platform
Ignore platform checks
--ignore-engines
Ignore engines check
--ignore-optional
Ignore optional dependencies
--force
Install and build packages even if they were built before, overwrite lockfile
--skip-integrity-check
Run install without checking if node_modules is installed
--check-files
Install will verify file tree of packages for consistency
--no-bin-links
Don't generate bin links when setting up packages
--flat
Only allow one version of a package
--prod--production
Instruct Yarn to ignore NODE_ENV and take its production-or-not status from this flag instead
--no-lockfile
Don't read or generate a lockfile
--pure-lockfile
Don't generate a lockfile
--frozen-lockfile
Don't generate a lockfile and fail if an update is needed
--update-checksums
Update package checksums from current repository
--link-duplicates
Create hardlinks to the repeated modules in node_modules
--link-folder
Specify a custom folder to store global links <path>
--global-folder
Specify a custom folder to store global packages <path>
--modules-folder
Rather than installing modules into the node_modules folder relative to the cwd, output them here <path>
--preferred-cache-folder
Specify a custom folder to store the yarn cache if possible <path>
--cache-folder
Specify a custom folder that must be used to store the yarn cache <path>
--mutex
Use a mutex to ensure only one yarn instance is executing <type[:specifier]>
--emoji
Enables emoji in output <value>
--cwd
Working directory to use <cwd>
--proxy--https-proxy
<host>
--registry
Override configuration registry <url>
--no-progress
Disable progress bar
--network-concurrency
Maximum number of concurrent network requests <number>
--network-timeout
TCP timeout for network requests <milliseconds>
--non-interactive
Do not show interactive prompts
--scripts-prepend-node-path
Prepend the node executable dir to the PATH in scripts
--no-node-version-check
Do not warn when using a potentially unsupported Node version
--focus
Focus on a single workspace by installing remote copies of its sibling workspaces
--otp
One-time password for two factor authentication <otpcode>
-v--version
Output the version number
-h--help
Output usage information
