Title: Environment Setup
Description: Install ESP-IDF and configure your development environment for GhostESP.
URL: /v2.1/development/environment-setup/
Version: v2.1
Section: Development
Search index: /search-index.json

# Environment Setup

> Install ESP-IDF and configure your development environment for GhostESP.

## On this page

- [Prerequisites](#prerequisites)
- [Install ESP-IDF](#install-esp-idf)
- [Quick Start (Windows)](#quick-start-windows)
- [Activate the Environment](#activate-the-environment)
- [Verify Installation](#verify-installation)
- [Clone GhostESP](#clone-ghostesp)
- [Common Commands](#common-commands)
- [Next Steps](#next-steps)

---

## Prerequisites
- Hardware: ESP32-based board (S3, S2, C3, C6, C5, or original ESP32), USB cable
- Software: Python 3.8+, Git
## Install ESP-IDF
GhostESP requires ESP-IDF v6.0. Follow the official Espressif guide for your OS:
- [Windows Installation](https://docs.espressif.com/projects/esp-idf/en/v6.0/esp32/get-started/windows-setup.html)
- [Linux Installation](https://docs.espressif.com/projects/esp-idf/en/v6.0/esp32/get-started/linux-setup.html)
- [macOS Installation](https://docs.espressif.com/projects/esp-idf/en/v6.0/esp32/get-started/macos-setup.html)
### Quick Start (Windows)
-
Install via EIM:
winget install Espressif.EIM-CLI
eim install -i v6.0
-
Or manually:
git clone -b v6.0 --recursive https://github.com/espressif/esp-idf.git
cd esp-idf
install.bat
## Activate the Environment
Each new terminal session needs ESP-IDF exported:
PowerShell:
. $env:IDF_PATH\export.ps1
CMD:
%IDF_PATH%\export.bat
Linux/macOS:
source $IDF_PATH/export.sh
## Verify Installation
idf.py --version
Should output ESP-IDF v6.0.
## Clone GhostESP
git clone https://github.com/GhostESP-Revival/GhostESP.git
cd GhostESP
## Common Commands
Command |
Description |
idf.py set-target esp32s3 |
Set target chip |
idf.py menuconfig |
Open configuration menu |
idf.py build |
Build firmware |
idf.py -p COM3 flash |
Flash to device |
idf.py -p COM3 monitor |
Open serial monitor |
idf.py -p COM3 flash monitor |
Flash and monitor |
idf.py fullclean |
Clean build artifacts |
## Next Steps
- [Adjust build options](/development/build-py-kconfig/) - Configure features via menuconfig
- [Create custom board configs](/development/custom-board-configs/) - Add support for new hardware