Appearance
Change safely
The agent follows one order: read, preview, ask, change, check. It reads the state first, previews a change with --dry-run, shows you the preview and asks, changes only after your yes, then reads again to confirm.
What a change prints
A change prints what it did, then the new state. Read it before you go on. s32 rack list reads it again, as the ground rules ask.
bash
s32 rack set 0 bypass=on
s32 rack listOutput
text
rack 0 bypass=on
[0] id=100 bypass=on in=yes devices=1 Rack 1Commands that ask first
A few commands change a lot at once, so the S32 asks first. Each needs your approval and --yes:
project deleteremoves a stored project.project loadreplaces the live project.push --activatesends a project and plays it.rack clearremoves every device in a rack.rack duplicatecopies a rack over another.snapshot deleteremoves a snapshot.globals setchanges a global setting.
Before one of them, the agent backs up the project and previews the change with --dry-run. It shows you the preview and asks. It adds --yes only after you say yes to that exact change.
bash
s32 active
s32 pull <VOLUME> <UID> s32-backup-<UID>-<DATE_TIME>.s32p
s32 project load internal 2 --dry-runAsk: "Load project 2? Changes you have not saved in the live project are lost."
bash
s32 project load internal 2 --yes
s32 activeOutput
text
loaded uid 2 job 1
volume=0 uid=2 dirty=0 dirtyGen=0 name=Project 2Exit codes and errors
Every command ends with an exit code. A script stops at the first one that is not 0.
| Code | Meaning | What to do |
|---|---|---|
0 | ok | Done. Read the new state. |
1 | local file/OS error | A file on this computer. Check the path. |
2 | usage | A typo or a missing value. Nothing was sent. Read the error. |
3 | link | No answer from the S32, or the s32 CLI and your S32's firmware speak different editor protocols. Do what the error's next: line says. If the error names the older side, a retry or another cable does not help. |
4 | refused by the S32 | The S32 said no, or the target is not in its list. Do not retry. If the error says the S32 changed during the read, tell the user and run the command again when they are done. An add that says it was saved is saved: do not add it again. |
5 | not confirmed | A command that asks first ran without --yes, or the answer was no. Nothing changed. |
A typo in a key name stops the command with exit code 2. The S32 is not changed. The error shows the keys the command takes, and the next line suggests the closest one.
bash
s32 rack set 0 bypas=onOutput
text
error: unknown key 'bypas'; usage: rack set bypass=on|off
did you mean: bypass=What the CLI cannot do
Some things happen on the S32 panel only: firmware update, formatting, compacting or migrating storage, pressing panel buttons, and turning ARRANGE on. The CLI and the web editor use the same USB connection, so only one app at a time can be connected.