Get Started
Get Artillery

Get Artillery

Installing Artillery CLI

Install Artillery via npm:

npm install -g artillery@latest

This will install Artillery globally on your machine.

System requirements

Artillery runs on Windows, MacOS, and Linux systems and requires the most recent LTS release of Node.js (opens in a new tab).

Intellisense in your IDE

If you're using Visual Studio Code, you should also install the Artillery VS Code Extension to get Intellisense (and other features) in Artillery YAML files.

You can also get Intellisense features in other editors.

Common issues

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 (opens in a new tab). 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:/ 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

Installing as root in Docker

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.

Installing as a devDependency in Node.js projects

Generally we do not recommend installing Artillery as a dev dependency inside application codebases (i.e. installing it with npm install -D). The recommended best practice is to maintain a separate repository/project with performance tests and install Artillery as a dependency in that project.

Canary releases

A canary release is published on every new commit to Artillery's GitHub repository. You can install the latest canary release with:

npm install -g artillery@canary

Canary releases are made available to users who want to try the latest changes that haven't been officially released yet, and for users who want help test and report bugs. Be warned, things may break! If they do, please let us know via Github Issues (opens in a new tab).

Checking your installation

Check if Artillery is installed by running:

npx artillery dino

You can also check the version of Artillery you have installed by running:

artillery version