Skip to main content

Installing Artillery CLI

What you'll learn
  • How to install the Artillery CLI via npm
  • How to check that your Artillery CLI installation is working

System requirements

Artillery is a CLI application that is installed on your computer. Artillery runs on Windows, MacOS, and Linux systems and requires Node.js v14 or later.

Installing Artillery

Stable release

The stable release of Artillery is recommended for most users.

npm install

Install Artillery via npm:

npm install -g artillery@latest

This will install Artillery globally on your computer.

caution

If you're installing Artillery in a Docker container (or a Docker image, e.g. via RUN npm install -g artillery), make sure the installation is not run as the root user.

Artillery can also be installed as a dev dependency of a Node.js project with:

npm install -D artillery@latest
caution

We do not recommend installing Artillery as a dependency inside application codebases. This installation method is only recommended for codebases that only contain tests.

Windows PowerShell

By default, PowerShell sets an execution policy on Windows Desktop clients that prevents the execution of scripts. If you use Windows PowerShell, you may see the following error message when attempting to run Artillery:

artillery: File C:\Users\Artillery\AppData\Roaming\npm\artillery.ps1
cannot be loaded because running scripts is disabled on this system.

To allow your Windows system to use Artillery, you'll need to change the PowerShell execution policy to RemoteSigned. Open PowerShell as an administrator and use the Set-ExecutionPolicy to change the execution policy to RemoteSigned:

PS C:\Windows\system32> Set-ExecutionPolicy RemoteSigned

Execution Policy Change
The execution policy helps protect you from scripts that you do not trust. Changing the execution policy might expose
you to the security risks described in the about_Execution_Policies help topic at
https:/go.microsoft.com/fwlink/?LinkID=135170. Do you want to change the execution policy?
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "N"): Y

Dev release

If you're feeling adventurous, you can install the development release of Artillery:

npm install -g artillery@dev

The dev release is available to check the latest and greatest that's coming to Artillery in the future, or for those who want help test and report bugs. Be warned, things may break! If they do, please let us know via Github Issues.

Checking your installation

If you used npm to install Artillery globally, run:

artillery dino

If you installed Artillery locally for a project, run the following command from the root folder of that project:

$(npm bin)/artillery dino

You should see an ASCII dinosaur printed to the terminal. Something like this:

Artillery dinosaur