Skip to main content

How to Install Extensions

This guide explains what are extensions and how to use them in your Scaffold-ETH 2 project.

What are Extensions?​

Extensions are modular add-ons for Scaffold-ETH 2 that provide additional functionality or serve as examples for specific features.

Info

Extensions can only be installed during the initial setup of a new Scaffold-ETH 2 project.

They offer several benefits:

  • Seamless integration with the base Scaffold-ETH 2 project
  • Quick addition of new features, pages, contracts, or components at project creation
  • Compatibility with Scaffold-ETH 2 core updates and improvements

Extensions are compact packages containing specific code (such as a smart contract or UI component) that automatically integrate with the latest version of Scaffold-ETH 2 when initializing a new project via npx. They are starting points for your project, not finished products.

Installing Extensions​

To install an extension when creating a new Scaffold-ETH 2 project, run:

npx create-eth@latest -e {github-username}/{extension-repo-name}:{branch-name}

The {branch-name} is optional. If not specified, it uses the default branch.

E.g.: npx create-eth@latest -e ChangoMan/charts-extension

Available Extensions​

You can find a complete list of available extensions, including both curated (by BuidlGuidl) and community extensions, on scaffold-eth website.