🚀 Getting Started with hoykit

Welcome to the hoykit quick-start guide! This walkthrough will show you how to go from zero to a running firmware on your ESP32-S3 board — entirely from the CLI.

1️⃣ Prerequisites

• ✅ Python 3.10+ (we recommend managing with pyenv)
• ✅ PlatformIO CLI globally installed
• ✅ Git installed
• ✅ ESP32-S3 board connected via USB

2️⃣ Install hoykit

curl -fsSL https://raw.githubusercontent.com/hoykids/hoykids-devkit/main/install.sh | bash

Then:

source ~/.zshrc  # or ~/.bashrc

hoykit --version

3️⃣ Create a Firmware Project

hoykit init-firmware test -b esp32-s3-dev

This will:

• Create firmwares/test/
• Generate platformio.ini and main.cpp
• Fill in README.md with board info

hoykit workon test

4️⃣ Build & Upload

hoykit flash

Autodetects USB port on native USB boards (like ESP32-S3).

5️⃣ Serial Monitor

hoykit monitor

Or one step:

hoykit flash --monitor

Custom baudrate:

hoykit monitor -b 74880

6️⃣ Edit Firmware

Edit firmwares/test/src/main.cpp:

  
    #include <Arduino.h>

      void setup() {
        Serial.begin(115200);
        delay(1000);
        Serial.println("🎉 Hello from hoykit!");
      }
      
      void loop() {
        Serial.println("Tick...");
        delay(1000);
      }
  

hoykit flash --monitor

🧪 Run Unit Tests

hoykit test test

💡 Summary

🙌 That's It!

You’ve built and flashed your first ESP32-S3 firmware with hoykit!

Explore:

• 📁 Multi-project firmware workflow
• 📦 SPIFFS uploads: hoykit spiffs-uploader
• 🔄 Self-update: hoykit update

hoykit help

Built for developers who love the terminal. Enjoy building with hoykit! 🎉