Welcome to Remix’s documentation!

Remix IDE is used for the entire journey of smart contract development by users at every knowledge level. It requires no setup, fosters a fast development cycle, and has a rich set of plugins with intuitive GUIs. The IDE comes in two flavors (web app or desktop app) and as a VSCode extension.

Remix Online IDE, see: https://remix.ethereum.org

Supported browsers: Firefox, Chrome, Brave. We do not support use of Remix on tablets or mobile devices.

Remix Desktop IDE, see releases: https://github.com/ethereum/remix-desktop/releases

Ethereum Remix, the VSCode extension, see here. Documentation for the VSCode extension is located here.

Remix Documentation Translations The Remix docs are currently in English and Simplified Chinese. More languages are on the way.

Remix Project

Remix IDE is part of the Remix Project which also includes the Remix Plugin Engine and Remix Libraries, which are low-level tools for wider use.

Remix IDE is available at remix.ethereum.org and more information can be found in these docs. Our IDE tool is available at our GitHub repository.

This set of documents covers instructions on how to use Remix. Additional information can be found in our blog and in our tutorial tool, LearnEth located inside of Remix IDE.

Useful links:

• Solidity Documentation

• Remix Alpha - The version where we test new Remix release (not stable!).

• Remix Desktop - Remix Desktop’s release page.

• Remix on Github

• Remix on Medium

• Remix on Twitter

• Our Discord support channel

• Ethereum.org’s Developer resources

Introduction

• Navigating Remix
  • Default Tools
  • Home tab
  • Plugin Manager
  • Themes
• Using Remix Safely
  • Remix’s ease makes its users a target
• Tutorials in Remix
  • Opening Learneth & associated links
  • Learneth Tutorials
  • Learneth & Tutorial Repos
• Remix URLs & Links with Parameters
  • Main Remix URLs
  • Customize Remix with URL Parameters
  • Pass commands to a plugin’s API via a url param
  • Load a file via a URL into the Editor
  • Load an encoded base64 string into a .sol file in the Editor
  • Load contracts from Etherscan via address
  • Load a Solidity contract from Github
  • Load a GIST
  • Load a specific version of the Solidity compiler:
  • Load a custom Solidity compiler:
  • Turn on autoCompile:
  • Select the language for the Solidity Compiler
• FAQ
  • Supported devices & Browsers
  • General
  • Solidity compiler
  • Deploy & Run
  • Plugin Developers
  • Analytics

Core Modules

• File Explorer
  • File Storage
  • Workspaces
  • Working with Files
  • Creating new files
  • Publish to Gist
  • Right-Click popup menu
  • Git in the File Explorer
• Search in Files
  • Search and Replace
• Plugin Manager
  • Manage permissions
  • View permissions
  • Plugin Devs: Load a local plugin
• Settings
  • Reset Button
  • General Settings
  • Github Access Token
  • Etherscan Access Token
  • Swarm Settings
  • IPFS Settings
  • Themes
• Editor
  • Editor displays information from other plugins
  • General Operations
  • TypeScript
  • Editor & Autocompile
  • Autocomplete
  • Auto complete on imports
  • Errors and Warnings
  • Quick Fixes for common mistakes
  • Gas Estimates
  • Go to Definition and References
  • Highlighted References
  • Hovering
  • Files with Errors turn Red
• Terminal
• Remixd: Access your Local Filesystem
  • remixd Installation
  • Find your version of remixd
  • Update to the latest remixd
  • remixd command
  • Ports Usage
  • Warning!
  • Clicking Connect on the modal.
  • Creating & deleting folders & files
  • Closing a remixd session

Solidity modules

• Solidity Compiler
  • Solidity Compiler Basics
  • Advanced Compiler Configurations
• Deploy & Run
  • Environment
  • Forking chains in Remix
  • More about External HTTP Provider
  • Account:
  • Gas Limit:
  • Value:
  • Deploy & AtAddress
  • Using the ABI with AtAddress
  • Pending Instances
  • Using the Recorder
• Deploy & Run (part 2)
  • Deployed contracts
  • Inputting parameters
  • Low level interactions
• Deploy & Run Proxy Contracts
  • Deploying
  • Upgrading
• Debugger
  • Use generated sources
  • The Debugger’s Navigation
  • The Debugger’s Panels
  • Breakpoints
  • Additional Info
• Solidity Analyzers
  • How to use
  • Slither
  • Solhint
  • Remix Analysis
  • Remix-analyzer

Unit Testing

• Unit Testing Plugin
  • Test directory
  • Generate
  • Write Tests
  • Run
  • Stop
  • Customization
  • Points to remember
• Command Line Interface
  • remix-tests
  • Get started
  • How to use
  • Example
  • Custom compiler context
  • As a CI solution
• Remix Assert Library
  • Assert
• Testing by Example
  • 1. Simple example
  • 2. Testing a method involving msg.sender
  • 3. Testing method execution
  • 4. Testing a method involving msg.value
  • 5. Testing a method involving msg.sender and msg.value
• Testing using Chai & Mocha
  • Write tests
  • Run tests
  • Test a contract
  • Debugging a test transaction
  • Hardhat-ethers support

External Tool Integrations

• Hardhat
  • Remixd and Hardhat
  • Enable Hardhat Compilation
  • Hardhat Provider
  • console.log in Remix IDE
• Truffle
  • Remixd and Truffle
  • Enable Truffle Compilation
  • Ganache Provider
• Slither
  • Remixd and Slither
  • Enable Slither Analysis
• Foundry
  • Foundry Provider
  • Foundry Remappings

Guides

• Creating and Deploying a Contract
  • Creating a new file
  • Compile the Contract
  • Deploy the contract
  • Select the top Remix VM environment
  • Deploying a contract
  • Interacting with the deployed instance
• Debugging Transactions
  • Initiate Debugging from the transaction log in the Terminal
  • Initiate Debugging from the Debugger
  • Using the debugger
  • 11 panels give detailed information about the execution:
• Importing & Loading Source Files in Solidity
  • Importing a library or dependency
  • Importing files for manipulation
• Contract Verification
  • Sourcify
  • Etherscan
• Running Scripts
  • Write & Run a script
  • Why run JavaScript Scripts in Remix?
  • Script to deploy a contract
  • Setup
  • JS Scripts in the File Explorers
  • Compile a contract and run a script on the fly
  • An Example Script
  • require in scripts at Remix
• Frequently Asked Scripts

Advanced

• Compilation Artifacts
  • Library Deployment with filename.json
• Remix Commands
  • Remix Commands
  • A few Ethers JS examples
  • A few Web3 JS examples
  • A few Swarm examples (these will be updated soon)

Miscellaneous

• Plugin List
  • Core Plugins
  • Additional Plugins
• Remix as code viewer
  • Through Etherscan
  • Through GitHub
• Code Contribution Guide
• Community Support