- Home
-
- Multilogin X
-
- Task automation with API
-
- Basic automation with CLI
-
- How to use Script runner with Multilogin CLI
How to use Script runner with Multilogin CLI
Written by
( Updated on April 11th, 2025 )
Updated on April 11th, 2025
All set up with Multilogin X CLI? You are now ready to use scripts in your browser profiles via Multilogin X CLI. The steps below will walk you through setting up Script runner in CLI, so that you can start running scripts in no time from a prompt command. Follow the steps below!
Step 1: download and install
How to download and install Multilogin X CLI
Installing Multilogin CLI locally only takes a few steps:
- Download the latest version according to your OS:
-
Save it to your local user folder
- Windows:
C:/Users/%yourusername% - macOS:
/Users/%username% - Linux:
/home/%username%
- Windows:
-
Rename the executable to
xclifor better convenience
Step 2: run the application
-
Open your local command prompt (
cmdfor Windows andTerminalfor macOS/Linux) - Using the command line, move to the folder where
xcli.exewas saved. Instructions: Windows | macOS | Linux
Once in the correct folder, you will be able to launch Multilogin X CLI by simply calling xcli commandname --flag “value”.
Step 3: log in to authenticate
In order to get your API token, you will need to first log in to your account via the login command.
- Paste this prompt:
xcli login --username yourusername --password yourpassword - Edit
“values”for each flag
Step 4: run script commands
Script runner is a series of API endpoints that offers tools to automate scripting in your Multilogin profiles. You can check them via xcli -h!
script-list
Lists all the scripts stored in the folder via xcli script-list. Files should be stored in:
-
Windows:
C:\Users\%username%\mlx\deps\scripts -
macOS:
/Users/%username%/mlx/deps/scripts -
Linux:
/home/%username%/mlx/deps/scripts
script-start
Once you confirm that the script is located in the mlx\deps\scripts folder, you are ready to start your profile while running it.
To use this command, you need to specify your profile ID (--profile-id) and your script file (--script). Lets see it applied in an example:
script-stop
This command stops one or more profiles that are running scripts. The only required flag is --profile-id.
cookie-robot
Instead of manually specifying the script in script-start, you can directly the command xcli cookie-robot --profile-id “profileid” to start it!
Seems you're all set with Script runner! We prepared a special article for running Cookie Robot in Multilogin X CLI tool.
