Yarn API Manual

Command

• yarn add <package...>
• yarn add <package...> [--dev/-D]
• yarn add <package...> [--peer/-P]
• yarn add <package...> [--optional/-O]
• yarn add <package...> [--exact/-E]
• yarn add <package...> [--tilde/-T]
• yarn add <package...> [--ignore-workspace-root-check/-W]
• yarn add <alias-package>@npm:<package>
• yarn autoclean [-I/--init] [-F/--force]
• yarn bin
• yarn cache list [--pattern]
• yarn cache dir
• yarn cache clean [<module_name...>]
• yarn check
• yarn check --integrity
• yarn config set <key> <value> [-g|--global]
• yarn config get <key>
• yarn config delete <key>
• yarn config list
• yarn create <starter-kit-package> [<args>]
• yarn generate-lock-entry
• yarn global <add/bin/list/remove/upgrade> [--prefix]
• yarn help
• yarn import
• yarn info <package> [<field>]
• yarn init
• yarn init
• yarn init --yes/-y
• yarn init --private/-p
• yarn install
• yarn install --check-files
• yarn install --flat
• yarn install --force
• yarn install --har
• yarn install --ignore-scripts
• yarn install --modules-folder <path>
• yarn install --no-lockfile
• yarn install --production[=true|false]
• yarn install --pure-lockfile
• yarn install --focus
• yarn install --frozen-lockfile
• yarn install --silent
• yarn install --ignore-engines
• yarn install --ignore-optional
• yarn install --offline
• yarn install --non-interactive
• yarn install --update-checksums
• yarn licenses list
• yarn licenses generate-disclaimer
• yarn link
• yarn link [package...]
• yarn list
• yarn list [--depth] [--pattern]
• yarn login
• yarn logout
• yarn outdated
• yarn outdated [package...]
• yarn owner list <package>
• yarn owner add <user> <package>
• yarn owner remove <user> <package>
• yarn pack
• yarn pack --filename <filename>
• yarn publish
• yarn publish [tarball]
• yarn publish [folder]
• yarn publish --new-version <version>
• yarn publish --tag <tag>
• yarn publish --access <public|restricted>
• yarn remove <package...>
• yarn run [script] [<args>]
• yarn run env
• yarn run
• yarn self-update
• yarn tag add <package>@<version> <tag>
• yarn tag remove <package> <tag>
• yarn tag list [<package>]
• yarn team
• yarn team create <scope:team>
• yarn team destroy <scope:team>
• yarn team add <scope:team> <user>
• yarn team remove <scope:team> <user>
• yarn team list <scope>|<scope:team>
• yarn test
• yarn run test
• yarn unlink
• yarn unlink [package]
• yarn upgrade [package | package@tag | package@version | @scope/]... [--ignore-engines] [--pattern]
• yarn upgrade [package]... --latest|-L [--caret | --tilde | --exact] [--pattern]
• yarn upgrade (--scope|-S) @scope [--latest] [--pattern]
• yarn upgrade-interactive [--latest]
• yarn version
• yarn version --new-version <version>
• yarn version --major
• yarn version --minor
• yarn version --patch
• yarn version --no-git-tag-version
• yarn version --no-commit-hooks
• yarn versions
• yarn why <query>
• yarn workspace <workspace_name> <command>
• yarn workspaces info