Important: This documentation covers modern versions of Yarn.
For 1.x docs, see classic.yarnpkg.com.
Yarn
sdks

sdks

External Package

To use this command, you need to use the @yarnpkg/sdks package either:

  • By installing it locally using yarn add and running it using yarn run
  • By downloading and running it in a temporary environment using yarn dlx

Generate editor SDKs and settings.

Usage

$> sdks ...

Examples

Generate the base SDKs :

sdks base

Generate the base SDKs and editor settings for supported editors :

sdks vscode vim

Update all generated SDKs and editor settings :

sdks

Options

Definition
Description

--cwd #0

The directory to run the command in

-v,--verbose

Print all skipped dependencies

Details

This command generates a new directory, .yarn/sdks, which includes the base SDKs.

When used without arguments, it:

  • throws an error on non-pnpified projects

  • updates all existing SDKs and editor settings on already-pnpified projects

The optional integrations arguments are a set of supported integrations, or the keyword base.

  • When base is used, only the base SDKs will be generated. This is useful for when an editor is not yet supported and you plan to manage the settings yourself.

  • When a set of integrations is used (e.g. vscode, vim, ...), the base SDKs will be installed plus all the settings relevant to the corresponding environments (for example on VSCode it would set typescript.tsdk).

The supported integrations at this time are: vim, vscode.

Note: This command always updates the already-installed SDKs and editor settings, no matter which arguments are passed.

For more details on Editor SDKs, please consult the dedicated page from our website: https://yarnpkg.com/getting-started/editor-sdks.