@loadmill/agent

Loadmill Agent

Users of Loadmill can use @loadmill/agent to run API and Load tests locally or on their servers.

Setup

In order to use the Loadmill Agent you will need to generate an API Token.

Installation

Locally

Using npm:

npm i @loadmill/agent --save

Using yarn:

yarn add @loadmill/agent

Globally

Using npm:

npm i @loadmill/agent -g

Using yarn:

yarn add @loadmill/agent -g

API

CLI

Start an agent:

loadmill-agent start -t INSERT_TOKEN_HERE

The start command accepts the following options:

• --token - (REQUIRED). can be retrieved through the UI, see above.
• --loads-capacity - (default = 50). Optionally you can supply the number of users this agent can simulate. can be 0 in order to not run load tests.
• --no-api - Can be supplied in order to prevent the agent from running API tests.
• --config - Alternatively, you can supply a path to a yaml file that will contain all the options above.

Extended Example

loadmill-agent start -t INSERT_TOKEN_HERE --no-api --loads-capacity 80

loadmill-agent start --config /path/to/config.yml

Programmatically

Start the agent:

const {start} = require('@loadmill/agent');
const stop = start({
  token: 'INSERT_TOKEN_HERE',
  // loadsCapacity: 80,
  // api: false
});

// Stop the agent at a later time

Learn More

• About Loadmill