Command-line options¶
This is a list of all the flags you can specify to the sbot
command-line runner.
- --outputfile <FILENAME>, -o <FILENAME>
Run in headless mode, outputting the result directly to a file.
Supported extensions are
.png
,.svg
,.pdf
and.ps
.
- --socketserver, -s
Run a socket server for controlling live variables from other programs.
- --serverport <PORT>, -s <PORT>
Set the socket server port to listen for connections (default is 7777).
- --vars <VARS>, -v <VARS>
Initial live variables, in JSON format.
Use single quotes outside, and double quotes inside, e.g.:
--vars='{"variable1": 1}'
- --namespace <NAMESPACE>, -ns <NAMESPACE>
Initial namespace, in JSON format.
Use single quotes outside, and double quotes inside, e.g.:
--namespace='{"variable1": 1}'
TODO: Document the difference between –namespace and –vars
- --l, -l
Open a shell to control the bot as it runs. See the Shell mode documentation for the available commands.
- --repeat <TIMES>, -r <TIMES>
Set number of iterations to run the script, producing multiple images.
- --window, -w
Run the script in a GTK window (default).
- --fullscreen, -f
Run the script in fullscreen mode.
- --title <TITLE>, -t <TITLE>
Set the window title.
- --close, -c
Close the window after running the script. Use with
--repeat
for benchmarking.
- --disable-vars, -dv
Disable the variables pane when in windowed mode.
- --disable-background-thread, -dt
Don’t run code in a background thread. This option is only useful if running on OSX turns up issues.
- --verbose, -V
Show internal error information in tracebacks.
- --args <ARGS>, -a <ARGS>
Pass arguments to bot. [TODO: explain better]