Usage

Usage Reference

⮜ Installation Guide | ⮨ Back to the Index | ➤ Features

The AutoIt Interpreter is mainly accessed via the command line. Executing the command autoit3 on Windows (or dotnet autoit3.dll on non-Windows) with the argument --help prints the following text:

[...]
-m, --mode              (Default: normal) The program's execution mode. Possible values are 'view' (v), 'normal'
                        (n), and 'interactive' (i). The default value is 'normal'. This will run the specified
                        script. The value 'view' implies the flags '-B -s -v q' and indicates that the interpreter
                        shall only display a syntax highlighted version of the script. The value 'interactive'
                        starts the interactive AutoIt shell.
-N, --no-plugins        (Default: false) Prevents the loading of interpreter plugins/extensions.
-s, --strict            (Default: false) Indicates that only strict Au3-features and -syntaxes should be be
                        supported (Extensions to the AutoIt language will be interpreted as errors).
-e, --ignore-errors     (Default: false) Ignores syntax and evaluation errors during parsing (unsafe!). This can
                        lead to undefined and non-deterministic behaviour.
-t, --telemetry         (Default: false) Prints the interpreter telemetry. A verbosity level of 'n' or 'v' will
                        automatically set this flag.  NOTE: All telemetry data stays on this machine
                        contrary to what this option might suggest. No part of the telemetry will be
                        uploaded to an external (web)server.
-v, --verbose           (Default: false) Indicates that the interpreter should also print debug messages.
-u, --check-for-update  (Default: release) Specifies how the interpreter should check for software updates.
                        Possible values are 'release' (default), 'beta', and 'none'. 'none' indicates that no
                        updates shall be downloaded; 'beta' indicates that beta-releases should be included in the
                        search for the newest update. Updates will be downloaded from the GitHub repository
                        (https://github.com/Unknown6656/AutoIt-Interpreter/releases).
-l, --lang              (Default: en) The CLI language code to be used by the compiler shell. The default value is
                        'en' for the English language.
--help                  Display this help screen.
--version               Display version information.
value pos. 0            The AutoIt-3 script path. This can be a local file or a web resource
                        (HTTP/HTTPS/SMB/FTP/SFTP/SCP/SSH/...).
--                      All subsequent arguments will be passed to the AutoIt-3 script.

Let's go through the command line options one-by-one:

Short option	Long option	Default value	Possible Values	Description
-m	--mode	normal	normal, view, interactive	[TODO]
-N	--no-plugins	(not provided)	(provided / not provided)	[TODO]
-s	--strict	(not provided)	(provided / not provided)	[TODO]
-e	--ignore-errors	(not provided)	(provided / not provided)	[TODO]
-t	--telemetry	(not provided)	(provided / not provided)	[TODO]
-v	--verbose	(not provided)	(provided / not provided)	[TODO]
-l	--lang	"en"	"en" Other values depend on the language packs.	[TODO]

All options can generally used as follows:

-o              # short option '-o'
-ovalue         # short option '-o' with the value 'v' (if 'o' accepts a non-boolean value)
-o value        # short option '-o' with the value 'value'
-abC            # combination of boolean switches '-a', '-b' and '-C'
--option value  # long option '--option' with the value 'value'
--option=value  # long option '--option' with the value 'value'

Examples

The following commands use autoit3 as a substitution for the commands ./autoit3 (Linux and MacOS), autoit3.exe (Windows), or dotnet autoit3.dll (all Platforms). Please refer to this article for more information about the build and installation process.

• Run the AutoIt Interpreter quietly (only print the script's output instead of a normal or debug log):

  $ autoit3 ~/Documents/my_script.au3

• Run the AutoIt Interpreter in telemetry mode:

  $ autoit3 -t ~/Documents/my_script.au3	# enables telemetry output using the flag '-t'/'--telemetry'
  $ autoit3 -vn ~/Documents/my_script.au3	# enables telemetry implicitly using a verbosity level of 'n' (normal)

• Run the interpreter in interactive mode:

  $ autoit3 -m interactive

• Run the interpreter in view-only mode:

  $ autoit3 -m view ~/Documents/my_script.au3

• Run a script which is not located on the local machine:

  $ autoit3 "\\192.168.0.1\Public Documents\My Script.au3"
  $ autoit3 https://example.com/my-script.au3
  $ autoit3 ftp://username:[email protected]/path/to/script.au3
  $ autoit3 ssh://username:[email protected]/~/Documents/my_script.au3
  $ autoit3 scp://username:[email protected]:22/script.au3

  These commands require that the Interpreter is not launched with the -s/--strict option, as non-local paths are not supported by the official AutoIt3 specification. Refer to this article for more information about non-local file resolution.

[TODO]

    

Use an other display language than English for the interpreter:
    autoit3 -l fr C:\User\Public\Script.au3