loadster-cli

This is a simple Loadster Command Line Interface, to work with Loadster's cloud-hybrid load testing platform at loadster.app.

Start a Load Test

You can use this utility to kick off load tests from your Loadster scenarios. To run a load test, you must first create a scenario in your Loadster Dashboard, and obtain the trigger code unique to that scenario.

To launch a load test and exit immediately:

$ loadster start <trigger-code> [--json]

If you include the --json flag, the output will be printed in JSON instead of human-friendly text. This is useful if you're writing your own scripts.

Once the test is launched, the CLI will print out URLs for monitoring the progress or viewing the live test on your Loadster dashboard.

Run a Load Test (Blocking)

You can also start a load test, and block until it finishes:

$ loadster run <trigger-code> [--json]

The run option will monitor the test as it runs, printing out high-level metrics every few seconds. At the end of the test, final test metrics are printed.

Assertions

With the run option, you can easily evaluate certain high-level metrics with pass/fail assertions. For example:

$ loadster run <trigger-code> --assert 'totalErrors == 0' --assert 'avgHitsPerSecond > 7.5' --assert 'avgBytesPerSecond <= 10000'

All assertions are evaluated immediately after the test finishes. If the test launched successfully and all assertions passed, the process will exit with a 0 exit code. Otherwise, it will exit with a non-zero exit code.

Getting Help

This open source CLI is fully supported by Loadster as a companion tool to our load testing platform. We would be happy to assist you if you're having trouble, but also would enjoy hearing how you're using the Loadster CLI in your Continuous Integration process or for whatever other situation you find it useful for.

Email us at [email protected]!