Skip to content

Requirements and limitations

Keep these requirements and limitations in mind when using the Netlify SDK to build an integration.

SDK requirements

Windows users should run the Netlify SDK through WSL 2

Support for using the Netlify SDK on Windows is currently only available through WSL 2.

To use the Netlify SDK, ensure you have the following installed:

Integration requirements

Netlify integrations are written with Node.js and TypeScript.

Your project’s root directory must have a package.json file and a tsconfig.json file. If you use npm create @netlify/sdk to create your integration, the SDK will automatically generate these files for you.