Clavda Docs
Install Clavda on any device
Step-by-step tutorials for putting a Linux server, Raspberry Pi, Windows PC, Mac or ESP32 board online in Clavda, so you can reach its terminal, files and firmware from the browser.
New here? See what to set up before you install
How it works
- 1
Add a device
Create it in the Clavda dashboard and pick its platform. That mints the credentials it connects with.
- 2
Install the agent
One command on Linux, the desktop app or a binary on Windows and macOS, a library in your ESP32 firmware.
- 3
Reach it from anywhere
The device dials out to Clavda, so it works behind NAT and firewalls with no port forwarding or VPN.
Linux
Install Clavda on Linux with one command
Connect a Linux server, VM or single-board computer to Clavda with the one-line installer, as root or without root, then keep the agent up to date.
Read tutorialRemote access to a Raspberry Pi from anywhere with Clavda
Reach a Raspberry Pi's terminal and files from your browser, behind any router and without port forwarding: pick the right ARM build and install with one command.
Read tutorialInstall Clavda manually on Linux with a systemd service
Install the Clavda agent by hand: put the binary and its .env in place, test it in the foreground, then start it on boot with a system or per-user systemd unit.
Read tutorial
Windows & macOS
Install Clavda on Windows: desktop app or command-line agent
Connect a Windows PC or server to Clavda with the desktop app, or run the command-line agent and start it automatically with a scheduled task.
Read tutorialInstall Clavda on macOS: desktop app or command-line agent
Connect a Mac to Clavda with the desktop app, or run the command-line agent: clear the Gatekeeper quarantine and start it at login with a launchd agent.
Read tutorial
ESP32
Connect an ESP32 to Clavda with the ClavdaOTA library
Add the ClavdaOTA library to an Arduino IDE or PlatformIO sketch, flash the ESP32 once over USB, and manage it over Wi-Fi from then on.
Read tutorialUpdate ESP32 firmware over the air from anywhere
Install new firmware on an ESP32 from your browser, over the internet and without a USB cable: export the .bin, upload it in Clavda, and confirm the new version.
Read tutorialRemote Serial Monitor for ESP32 over Wi-Fi
Read an ESP32's serial output in your browser and type commands back to it, from anywhere, by printing to ClavdaSerial instead of Serial.
Read tutorialBuild a live ESP32 dashboard with gauges, charts and controls
Lay out cards, charts, toggles and sliders for an ESP32 in the Clavda console, then feed them from your sketch with ClavdaWidget. No server or MQTT broker to run.
Read tutorial
Help
Clavda troubleshooting: device offline and common install errors
Why a Clavda device stays offline and how to fix it: read the agent's log, and solutions for Exec format error, WEB_CLIENT_ID is required, sudo and ESP32 problems.
Read tutorialHow to uninstall Clavda from Linux, Windows, macOS and ESP32
Remove the Clavda agent completely: stop the service, delete its files, erase an ESP32's stored identity, and delete the device so its credentials stop working.
Read tutorial