Common Conventions
These pages list all 372 Runtime system commands, split into 24 category pages, and the numbering restarts inside every page. The same catalogue can be enabled or disabled per workspace app under Integration → Apps → Agent Settings → System Commands.
A usage line is a template, not a runnable command: replace every placeholder with a value from your own environment before running it.
| Written in the usage line | What you type |
|---|---|
<uuid>, <apiName>, <CODE> | your own value, angle brackets removed: --member-id 3f2c8f0e-8b1c-4a55-9d0f-2b7a1c9e4d10 |
value, path, iso, n, json | also placeholders: your own string, a file path, an ISO datetime with offset, an integer, JSON, or a file path |
[--limit n] | square brackets are optional: the whole group may be omitted |
(--definition-json json|--definition-file path) | parentheses with a pipe mean exactly one of the two |
preset:form.submit, draft|active | type one of them as-is: keep the colon, do not type the pipe |
Never leave the angle brackets in the command. In bash and zsh < is an input redirection operator, so the shell fails before the CLI starts; quoting it as '<uuid>' reaches the CLI but the Runtime rejects it as an invalid UUID.
For example, system.form.record.get:
# usage line (template)
sl system form record get --record-id <uuid> [--json]
# real command (placeholder replaced, --json kept as needed)
sl system form record get --record-id 3f2c8f0e-8b1c-4a55-9d0f-2b7a1c9e4d10 --json
Other conventions:
- Every command accepts
--jsonfor machine-readable output - Emit true boolean options as flags and omit false or absent ones, for example
--include-detailrather than--include-detail true - Serialize a Runtime condition as compact JSON and pass it to
--condition-jsonin shell-safe single quotes - If an input has no option in the usage line, the current CLI does not expose that input
- The CLI subcommand is derived from the command name:
system.form.layout.listbecomessl system form layout list