Installation & Usage
Set up the Aderyn VS Code extension
Installation & Usage
Microsoft Windows Users: For the Aderyn Extension to work, you must run VSCode using WSL.
Installation
Open Extensions
In VSCode, open the "Extensions" tab
Search and Install
Search and install "Aderyn"
Welcome Page
Open the "Aderyn: Welcome" page (if it hasn't automatically opened)
Done!
You're ready to start using Aderyn
Available now in the VS Code Marketplace.
Project Structure
Aderyn works seamlessly on commonly recognized project structures, i.e., when a foundry.toml or hardhat.config.js is found in the workspace's root.
In addition, you can configure how Aderyn analyzes your project by creating an aderyn.toml file in the project root. This is important when running Aderyn on a project that does not use a well-known Solidity development framework like Foundry or Hardhat.
To create this file, open the VSCode command palette and hit Aderyn: Initialize Config. For instructions on how to configure aderyn.toml, visit Using the config file.
Usage
Automatic Scanning
The extension automatically scans your code when you:
- Save a Solidity file
- Open a Solidity project
View Issues
- Click the Aderyn icon in the sidebar
- Browse issues organized by severity
- Click an issue to jump to the code
Apply Fixes
Hover over squiggly underlines and click Quick Fix to apply AI-suggested remediation.