Skip to content

Install the tools

Every OT Fabric command-line tool installs with the same line. Replace modbusctl with the tool you want:

Terminal window
curl -fsSL https://get.otfabric.io/modbusctl | sh

Run the same line again to upgrade. That works for the tools with a repository of their own, such as iec104ctl or opcuactl, and for the tools that ship inside a library repository, such as otprobe in go-otfp or mbcapctl in go-modbus-capture. The list of tools is below.

  1. It detects the platform: Linux on x86-64, ARM64 and ARMv7, macOS on Intel and Apple silicon, Windows on x86-64 and ARM64.
  2. It resolves the version once, the latest stable release or the one you pin, and uses exactly that release.
  3. It downloads the archive and the release’s SHA-256 checksums file, and refuses to install when the checksum is missing, malformed or does not match.
  4. It extracts only the expected binary and runs <tool> version as a smoke test before it replaces an installed copy.
  5. It installs per user without sudo, in ~/.local/bin (or $XDG_BIN_HOME) and on Windows in %LOCALAPPDATA%\OTFabric\bin, and adds that directory to PATH unless you tell it not to.

The tools are single static binaries. There is no runtime, interpreter or package manager to install first.

All options are environment variables, and they are the same for every tool.

Variable Default Effect
OTF_VERSION latest Install a specific version, 3.6.1 or v3.6.1. For a tool that ships inside a library repository, this is the library’s version
OTF_INSTALL_DIR ~/.local/bin; Windows %LOCALAPPDATA%\OTFabric\bin Install directory. PATH may be updated
OTF_UNMANAGED_INSTALL unset Install directory for CI, containers and device images. Never touches PATH or shell profiles. Cannot be combined with OTF_INSTALL_DIR
OTF_NO_MODIFY_PATH 0 1 leaves PATH and shell profiles alone
OTF_TARGET detected Force a target, for example linux-armv7
Terminal window
# A specific version
curl -fsSL https://get.otfabric.io/modbusctl | env OTF_VERSION=3.6.1 sh
# CI, a Dockerfile or a device image: a fixed directory, no profile changes
curl -fsSL https://get.otfabric.io/modbusctl | env OTF_UNMANAGED_INSTALL=/usr/local/bin sh

The installer exits 0 when the tool is installed, 1 when the installation failed and 2 on invalid input, so a pipeline stops at the install step instead of failing later. Under irm | iex PowerShell never exits, so it cannot close your terminal. Scripts, CI and containers has complete examples for GitHub Actions, GitLab CI and Dockerfiles.

  • Linux and macOS: a POSIX sh (dash, bash, zsh or BusyBox ash), curl or wget (BusyBox wget works), tar, and sha256sum, shasum or openssl.
  • Windows: Windows PowerShell 5.1 or PowerShell 7. Nothing else.

32-bit x86 and ARMv6 are not supported. On a 64-bit ARM kernel with a 32-bit userland, common on Raspberry Pi OS, the installer picks the ARMv7 build.

The same scripts run straight from the installer repository and then download from GitHub Releases directly:

Terminal window
curl -fsSL https://raw.githubusercontent.com/otfabric/install/main/install.sh | sh -s -- modbusctl
Terminal window
$env:OTF_TOOL = 'modbusctl'; irm https://raw.githubusercontent.com/otfabric/install/main/install.ps1 | iex

For machines without internet access, download the archive and the checksums file from the tool’s GitHub Releases page on another machine, check the archive with sha256sum -c, and copy the binary across. To build from source, each tool’s README has the steps; the tools with a repository of their own, apart from modbusctl and s7commctl, also install with go install github.com/otfabric/<tool>@latest and Go 1.26 or later.

The checksums file comes from the same GitHub release as the archive. It proves that the download is intact, not who published it. In a pipeline, pin the version with OTF_VERSION so that every run installs the release you reviewed. Report vulnerabilities privately to security@otfabric.io, as described in each repository’s SECURITY.md.

ToolProtocolShips inWhat it does
bacnetctlBACnetbacnetctlBACnet/IP discovery, property read and write, COV, alarms, BBMD and a simulated device.
canbusctlCAN buscanbusctlCAN, CAN FD and CAN XL: monitor, decode, record, replay, ISO-TP and simulation.
canopenctlCANopencanopenctlCANopen SDO, PDO, NMT, LSS, EMCY, EDS and DCF, CiA 402 drives and device simulation.
dnp3ctlDNP3dnp3ctlDNP3 polling, control, discovery, file transfer and a simulated outstation.
ethernetipctlEtherNet/IPethernetipctlEtherNet/IP discovery, attributes, cyclic I/O, Logix tags, EDS and adapter simulation.
iec101ctlIEC 60870-5-101iec60870ctlIEC 101 on a serial line or terminal server: interrogate, monitor, command, unbalanced or balanced, and a simulated station.
iec102ctlIEC 60870-5-102iec60870ctlIEC 102 meters: integrated totals, events, the clock and the REE profile, and a simulated meter.
iec103ctlIEC 60870-5-103iec60870ctlIEC 103 protection relays: interrogation, commands, generic services, disturbance data and a simulated relay.
iec104ctlIEC 60870-5-104iec60870ctlIEC 104 interrogation, monitoring, commands, file transfer and a simulated RTU.
iec61850ctlIEC 61850iec61850ctlIEC 61850 MMS, GOOSE and Sampled Values: browse IEDs, control, reports and SCL.
ieee20305ctlIEEE 2030.5ieee20305ctlIEEE 2030.5 device and server roles, registration, controls, certificates and a test server.
knxctlKNXknxctlKNXnet/IP discovery, tunnelling, routing, group monitoring, datapoint types and simulation.
mbcapctlModbusgo-modbus-captureInspect, convert and validate MBCAP Modbus capture files.
mbtracectlModbusgo-modbus-traceAnalyse Modbus/TCP traffic in pcap and pcapng traces and export MBCAP.
mmstracectlIEC 61850go-mms-traceAnalyse MMS, GOOSE and Sampled Values traffic in pcap and pcapng captures, offline.
modbus-cliModbusgo-modbusMinimal Modbus TCP and RTU client for quick probing and troubleshooting.
modbusctlModbusmodbusctlModbus discovery, scanning, fingerprinting, SunSpec, recording, replay and simulation.
nsdctlIEC 61850go-iec61850-modelLook up, inspect and validate IEC 61850 logical nodes and NSD packages.
ocppctlOCPPocppctlOCPP 1.6J, 2.0.1 and 2.1: probe a CSMS, simulate stations and serve a test CSMS.
opcuactlOPC UAopcuactlOPC UA discovery, browse, read and write, subscriptions, alarms, history and PubSub.
openadrctlOpenADRopenadrctlOpenADR 3 VEN and Business Logic clients, notifications and a test VTN.
otprobeMulti-protocolgo-otfpFind out which OT protocol an endpoint speaks, and which device answers.
profinetctlPROFINETprofinetctlPROFINET discovery, DCP naming, I&M, diagnosis, topology, GSDML and cyclic I/O.
s7commctlSiemens S7s7commctlS7 PLC discovery, rack and slot probing, memory read and write, blocks and diagnostics.
sclgenIEC 61850go-iec61850Generate Go types from IEC 61850 SCL schema bundles.
sclparseIEC 61850go-iec61850Detect, summarise and validate IEC 61850 SCL configuration files.
sparkplugbctlSparkplug BsparkplugbctlSparkplug B monitoring, publishing, payload coding and edge node and host simulation.
sunspecctlSunSpecsunspecctlSunSpec Modbus inverters, meters and batteries: detect, read, poll and simulate.

The registry of tools lives in otfabric/install. The desktop apps, LAN Tracker and modbus-simulator are not on get.otfabric.io yet; download them from their GitHub Releases pages.

Delete the binary: rm ~/.local/bin/<tool>, or on Windows %LOCALAPPDATA%\OTFabric\bin\<tool>.exe. If the installer added its directory to PATH, you can take that entry out again; the installer keeps no other state.