Forrest logo
back to the locust tool

locust:tldr:4c299

locust: Run test without web interface, spawning 1 user a second until there are 100 users.
$ locust --no-web --clients=${100} --hatch-rate=${1} --host=${http:--example-com}
try on your machine

This command is used to start a Locust load testing tool in the command-line interface. Let's break down each argument:

  1. locust: The keyword locust is the command to start the Locust load testing tool.

  2. --no-web: This flag is used to run Locust without the web interface. It means that the test will be executed in the command-line interface without opening the web UI for monitoring.

  3. --clients=${100}: This argument specifies the number of virtual users (clients) that will be simulated during the load test. In this case, it sets the number of clients to 100.

  4. --hatch-rate=${1}: This parameter defines the rate at which new clients are spawned per second. It sets the hatch rate to 1 client per second. That means a new client will be added every second until the total number of clients mentioned in the previous argument is reached.

  5. --host=${http:--example-com}: This parameter specifies the base URL or host of the target application to be tested. In this case, the host is set to http://example.com. By providing this argument, Locust will direct the simulated users to this host for load testing purposes.

Note that ${} is used in the command to denote variable substitution, but it appears to be misplaced in this command. Typically, the ${} syntax is used in shell scripting or configuration files to substitute the values of predefined or user-defined variables.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the locust tool