Skip to content

RaftCommandFileSysMod

Rob Dobson edited this page May 3, 2026 · 1 revision

CommandFile SysMod

Built-in SysMod that runs scripted REST API calls from a text file on the local file system. Useful for one-shot automation, demos, or first-boot setup sequences.

Source: RaftSysMods/components/CommandFile/

What it provides

  • Reads a text file (max 5 KB), executes each non-blank line as a REST API call.
  • Supports a simple sleep <ms> directive between commands and an optional repeat count.
  • Useful for scripted demos and self-tests.

SysType configuration

{
    "name": "CommandFile"
}

No required configuration — the SysMod is driven entirely by the filerun REST endpoint.

REST endpoints exposed

Endpoint Method Purpose
filerun/<fs>/<path> GET Run the named API script file

The script file is a plain text list of REST API requests, one per line, e.g.

subscription?action=update&topic=devjson&rateHz=10
sleep 500
pubtopics

Related

Clone this wiki locally