[1.0.1] Command Line Usage completely revised

Created by RaiMan on
Last updated by:
RaiMan on

the docs entry http://doc.sikuli.org/faq/010-command-line.html
does no longer reflect the command line usage with version 1.0 +

*** the highlights

the command scripts now are
-- runIDE(.cmd) that internally uses sikuli-ide.jar (option 1)
-- runScript(.cmd) that internally uses sikuli-script.jar (option 2)

and they are exported to the setup folder at setup time
depending on the selected option.

both accept the same parameters
... and can be used to run scripts (.sikuli or .skl) from the command line or
to start an interactive Jython session on command line

... use option -h, to get the info about possible parameters

user args, that will be available at runtime in sys.argv[1 .. n]
... can be specified at will after a -- (double hyphen or any word, that begins with a -- ).
This is true for IDE and Script usages.
They are split into the argv items by whitespaces, but enclosing " are honored and will put the enclosed string into one argv item

When the IDE is started as application
(Mac only currently or when started by double-clicking on sikuli-ide.jar)
... a startup dialog allows to specify options like being on the command line.
... So you may run scripts this way as well, but be aware, that output, that would go to a command line window will be lost (but you might redirect the log at least to a file)

-- to be flexible anyway about where the output goes use Debug.user() instead of print. These messages will go to a log file, if specified at startup or during script run.