Important: This documentation covers modern versions of Yarn.
For 1.x docs, see classic.yarnpkg.com.
Yarn
yarn addyarn binyarn cache cleanyarn config getyarn config setyarn config unsetyarn configyarn constraints queryyarn constraints sourceyarn constraintsyarn dedupeyarn dlxyarn execyarn explain peer-requirementsyarn explainyarn infoyarn inityarn installyarn linkyarn nodeyarn npm audityarn npm infoyarn npm loginyarn npm logoutyarn npm publishyarn npm tag addyarn npm tag listyarn npm tag removeyarn npm whoamiyarn packyarn patch-commityarn patchyarn plugin import from sourcesyarn plugin importyarn plugin listyarn plugin removeyarn plugin runtimeyarn rebuildyarn removeyarn runyarn searchyarn set resolutionyarn set version from sourcesyarn set versionyarn stageyarn unlinkyarn unplugyarn upyarn upgrade-interactiveyarn version applyyarn version checkyarn versionyarn whyyarn workspaceyarn workspaces focusyarn workspaces foreachyarn workspaces list

yarn config set

Change a configuration settings.

Usage

$> yarn config set <name> <value>

Examples

Set a simple configuration setting (a string, a number, or a boolean) :

yarn config set initScope myScope

Set a simple configuration setting (a string, a number, or a boolean) using the --json flag :

yarn config set initScope --json \"myScope\"

Set a complex configuration setting (an Array) using the --json flag :

yarn config set unsafeHttpWhitelist --json '["*.example.com", "example.com"]'

Set a complex configuration setting (an Object) using the --json flag :

yarn config set packageExtensions --json '{ "@babel/parser@*": { "dependencies": { "@babel/types": "*" } } }'

Set a nested configuration setting :

yarn config set npmScopes.company.npmRegistryServer "https://npm.example.com"

Set a nested configuration setting using indexed access for non-simple keys :

yarn config set 'npmRegistries["//npm.example.com"].npmAuthToken' "ffffffff-ffff-ffff-ffff-ffffffffffff"

Options

Definition
Description

--json

Set complex configuration settings to JSON values

-H,--home

Update the home configuration instead of the project configuration

Details

This command will set a configuration setting.

When used without the --json flag, it can only set a simple configuration setting (a string, a number, or a boolean).

When used with the --json flag, it can set both simple and complex configuration settings, including Arrays and Objects.