Get started
Install the agent
One command as root. The device shows up in seconds.
In the dashboard, click Add devices, create an install command and run it as root on the device:
curl -fsSL https://api.fieldhand.dev/install.sh | sudo sh -s -- --token fhe_…
On systems with wget but no curl (BusyBox, Alpine), click No curl? Use wget under the command and run that one as root. BusyBox wget doesn't check HTTPS certificates, so that command checks the script's SHA-256 before running it, and the script checks the agent binary against the signed release manifest. A changed download is refused.
What the installer does
- Detects the CPU (amd64, arm64, armv7, armv6 or 386) and downloads the matching agent.
- Runs it once to make sure it works on this machine, then installs it as
/usr/local/bin/fieldhand. - Enrolls the device. Its key is written to
/etc/fieldhand/agent.json, readable by root only. - Registers a systemd or OpenRC service that restarts on failure. The agent keeps itself to about 12 MB of memory and runs at low CPU priority, so it can't starve your application.
Options
| Option | Effect |
|---|---|
--name kiosk-014 | Device name in the dashboard. Default: the hostname. Rename later in the dashboard. |
--shell-user ops | Open shells and run fleet commands as this account. Default: the account that ran sudo, or root when the installer runs as root. --shell-user root forces root. See agent configuration. |
--uninstall | Remove the agent. See uninstall. |
Running the installer again on an enrolled device keeps the same device, name, tags and history in the dashboard.
Install tokens
A token for one device works once and expires after 24 hours. For many devices, see enroll a whole fleet. Tokens are only shown once; we store a hash of them.
Something wrong or missing on this page? Tell us.