CLI Introduction

Yarn provides a rich set of command-line commands to help you with various aspects of your Yarn package, including installation, administration, publishing, etc.

While all of the available commands are provided here, in alphabetical order, some of the more popular commands are:

  • yarn add: adds a package to use in your current package.
  • yarn init: initializes the development of a package.
  • yarn install: installs all the dependencies defined in a package.json file.
  • yarn publish: publishes a package to a package manager.
  • yarn remove: removes an unused package from your current package.

Default Command

Running yarn with no command will run yarn install, passing through any provided flags.

Concurrency and --mutex

When running multiple instances of yarn as the same user on the same server, you can ensure only one instance runs at any given time (and avoid conflicts) by passing the global flag --mutex followed by file or network.

When using file Yarn will write/read a mutex file .yarn-single-instance in the current working directory by default. You can also specify an alternate or global filename.

--mutex file
--mutex file:/tmp/.yarn-mutex

When using network Yarn will create a server at port 31997 by default. You can also specify an alternate port.

--mutex network
--mutex network:30330