Skip to content

AyresShell 1.0.0 — DOS-style Serial Shell for ESP32

Latest

Choose a tag to compare

@ayresnet ayresnet released this 05 Sep 20:39
· 3 commits to main since this release
b841803

🚀 What’s new (v1.0.0)

Initial public release of AyresShell, a tiny DOS-style serial console for ESP32.

  • Familiar commands: DIR, TYPE, DEL, REN, MV, MKDIR, RMDIR, CD, FORMAT, CLS, HELP
  • JSONSET to live-edit JSON config files (pretty-printed save)
  • LittleFS integration with relative/absolute paths
  • Safe FORMAT with confirmation prompt
  • Ready for Arduino IDE and PlatformIO

✅ Requirements

  • Board: ESP32 (Arduino core)
  • FS: LittleFS
  • Dependency: ArduinoJson ≥ 6.21.0

📦 Installation

Arduino IDE

  • (Once indexed) Library Manager: AyresShell
  • Manual: Sketch → Include Library → Add .ZIP Library… (use the release ZIP)

PlatformIO

  • Add to platformio.ini:
    lib_deps =
      https://github.com/ayresnet/AyresShell.git#1.0.0
    

#include <Arduino.h>
#include <LittleFS.h>
#include "AyresShell.h"

AyresShell shell;

void setup() {
  Serial.begin(115200);
  while (!Serial) {}

  if (!LittleFS.begin(true)) {
    Serial.println("LittleFS mount failed");
  }

  shell.begin();
  Serial.println("Type HELP");
}

void loop() {
  shell.handleInput();
}

🧭 Command Cheat-Sheet

DIR · TYPE · DEL · REN · MV ·
MKDIR

· RMDIR · CD <dir|..|/> · FORMAT · CLS · HELP ·
JSONSET ""


Examples

DIR
TYPE /config/wifi.json
JSONSET /config/wifi.json password "my-new-pass"
CD /logs
MKDIR /backup
MV /readme.txt /backup/

⚠️ Notes

FORMAT is destructive; it asks for confirmation before erasing LittleFS.

Serial Monitor: 115200 baud, line ending Newline (or Both NL & CR).


📄 License

MIT © AyresNet

Tip: el tag “1.0.0” coincide con version=1.0.0 en library.properties, perfecto para el Library Manager. Cuando publiques esta release, ya podés abrir el PR al arduino/library-registry.
::contentReference[oaicite:0]{index=0}