Skip to content

Scripts

Create a Script File

Using the Live Mode is good for testing and learning how TagUI scripts work.

Scripts can also be written and saved as text files which allow for more complex and modular flow to be created and saved.

TagUI recognises text files with a .tag extension.

This is the starting point of creating modular and advanced automation.

Add Code

Using a text editor, or any application that can save text only files, enter the following into a file and save it as example.tag

https://google.com
wait 3
type input as Dylan[enter]
wait 3
snap page to websnap.png
wait 3

Save the file into the TagUI folder (where your TagUI application was installed).

Launch terminal and navigate to the folder where you have saved the .tag file.

Note

You can create folders to keep your scripts organised and run the script from the appropriate folder.

Do not enter Live Mode.

Run a Script File

In the terminal type:

tagui example.tag

Press Enter

Typing tagui and the name of the file starts the automation engine and then executes the scripts within the specified file.

This example runs a flow from start to finish. In the previous section each command was run individually in Live Mode.

Here all the steps are saved in a file and executed by running the .tag file.

The Google search page should open in the browser and the word "Dylan" entered in the search box and the search started.

The wait 3 (wait 3 seconds) step slows the flow down so that you can see each individual step. Sometimes it is necessary to add this e.g. when a page requires to process something before the next step can run or link clicked.

The snap steps take a screen shot of the browser page and saves it to your folder as websnap.png

Once the last wait 3 has completed the automation will stop and the browser will close.

TagUI Options

In the terminal type:

tagui

Press Enter

This will display a list of switches that can be used when starting TagUI.

TagUI options in Terminal

If your automation does not require the browser then using the -n switch can be used:

tagui script.tag -n

Running the browser in "headless" mode -h ensures the browser runs but does not display on screen

tagui script.tag -h

Script Examples

More TagUI script examples can be found in the Scripts section.

Reference

The TagUI documentation is the best resource to start learning about the TagUI scripting language.