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) without any arguments prints the following text:

[...]
COMMAND LINE OPTIONS:
  -B, --no-banner        (Default: false) Suppress the banner. A verbosity level of 'q' will automatically set this flag.
  -N, --no-plugins       (Default: false) Prevent the loading of interpreter plugins.
  -s, --strict           (Default: false) Support only strict Au3-features and -syntax.
  -e, --ignore-errors    (Default: false) Ignores syntax and evaluation errors during parsing (unsafe!).
  -t, --telemetry        (Default: false) Prints the interpreter telemetry. A verbosity level of 'n' or 'v' will automatically set this flag.
  -v, --verbosity        (Default: n) The interpreter's verbosity level. (q=quiet, n=normal, v=verbose)
  -l, --lang             (Default: en) The CLI language code to be used by the compiler.
  --help                 Display this help screen.
  --version              Display version information.
  value pos. 0           Required. The file path 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
-B	--no-banner	(not provided)	(provided / not provided)	[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	--verbosity	n	q (quiet) n (normal) v (verbose)	[TODO]
-l	--lang	"en"	"en" Other values depend on the language packs.	[TODO]

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 -vq ~/Documents/my_script.au3
  #         ^^^- sets the verbosity level to 'q' (quiet). This implicitly sets the flag '-B'/'--no-banner'

• 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 AutoIt Interpreter in full debug mode:

  $ autoit3 -vv ~/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:password@example.com/path/to/script.au3
  $ autoit3 ssh://username:password@example.com/~/Documents/my_script.au3
  $ autoit3 scp://username:password@192.168.0.100: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.

    autoit3 -vq ~/Documents/my_script.au3
    autoit3 -vq C:\User\Public\Script              (you can also omit the file extension)

Run the interpreter in telemetry/full debugging mode:
    autoit3 -t ~/Documents/my_script.au3
    autoit3 -vv ~/Documents/my_script.au3

Run a script which is not on the local machine:
    autoit3 ""\\192.168.0.1\Public Documents\My Script.au3""
    autoit3 https://example.com/my-script.au3
    autoit3 ftp://username:password@example.com/path/to/script.au3
    autoit3 ssh://username:password@example.com/~/Documents/my_script.au3
    autoit3 scp://username:password@192.168.0.100:22/script.au3

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