Environment Setup

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

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 v5.5.3. Follow the official Espressif guide for your OS:

Quick Start (Windows)

  1. Install via EIM:

    winget install Espressif.EIM-CLI
eim install -i v5.5.3

  2. Or manually:

    git clone -b v5.5.3 --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 v5.5.3.

Clone GhostESP 

git clone https://github.com/GhostESP-Revival/GhostESP.git
cd GhostESP

Common Commands

CommandDescription
idf.py set-target esp32s3Set target chip
idf.py menuconfigOpen configuration menu
idf.py buildBuild firmware
idf.py -p COM3 flashFlash to device
idf.py -p COM3 monitorOpen serial monitor
idf.py -p COM3 flash monitorFlash and monitor
idf.py fullcleanClean build artifacts

Next Steps