Merge pull request #1311 from locustio/cli-cleanup

Group related command line options together

docs/changelog.rst

@@ -10,6 +10,7 @@ For full details of the Locust changelog, please see https://github.com/locustio
 Breaking changes
 ----------------
 
+* The option for running Locust without the Web UI has been renamed from ``--no-web`` to ``--headless``.
 * Removed ``Locust.setup``, ``Locust.teardown``, ``TaskSet.setup`` and ``TaskSet.teardown`` hooks. If you want to 
   run code at the start or end of a test, you should instead use the :py:attr:`test_start <locust.event.Events.test_start>`
   and :py:attr:`test_stop <locust.event.Events.test_stop>` events:

docs/retrieving-stats.rst

@@ -7,11 +7,11 @@ You may wish to consume your Locust results via a CSV file. In this case, there
 First, when running Locust with the web UI, you can retrieve CSV files under the Download Data tab. 
 
 Secondly, you can run Locust with a flag which will periodically save two CSV files. This is particularly useful
-if you plan on running Locust in an automated way with the ``--no-web`` flag:
+if you plan on running Locust in an automated way with the ``--headless`` flag:
 
 .. code-block:: console
 
-    $ locust -f examples/basic.py --csv=example --no-web -t10m
+    $ locust -f examples/basic.py --csv=example --headless -t10m
 
 The files will be named ``example_response_times.csv`` and ``example_stats.csv`` (when using ``--csv=example``) and mirror Locust's built in stat pages.
 

docs/running-locust-distributed.rst

@@ -84,7 +84,7 @@ listen to. Defaults to 5557.
 ``--expect-workers=X``
 ----------------------
 
-Used when starting the master node with ``--no-web``. The master node will then wait until X worker
+Used when starting the master node with ``--headless``. The master node will then wait until X worker
 nodes has connected before the test is started.
 
 

docs/running-locust-docker.rst

@@ -56,7 +56,7 @@ To run in standalone mode without the web UI, you can use the ``LOCUST_OPTS`` en
 
 .. code-block:: console
 
-    docker run --volume $PWD/dir/of/locustfile:/mnt/locust -e LOCUSTFILE_PATH=/mnt/locust/locustfile.py -e TARGET_URL=https://abc.com -e LOCUST_OPTS="--clients=10 --no-web --run-time=600" locustio/locust
+    docker run --volume $PWD/dir/of/locustfile:/mnt/locust -e LOCUSTFILE_PATH=/mnt/locust/locustfile.py -e TARGET_URL=https://abc.com -e LOCUST_OPTS="--clients=10 --headless --run-time=600" locustio/locust
 
 
 If you are Kubernetes user, you can use the `Helm chart <https://github.com/helm/charts/tree/master/stable/locust>`_ to scale and run locust.

docs/running-locust-in-step-load-mode.rst

@@ -39,7 +39,7 @@ If you want to run Locust in step load mode without the web UI, you can do that
 
 .. code-block:: console
 
-    $ locust -f --no-web -c 1000 -r 100 --run-time 1h30m --step-load --step-clients 300 --step-time 20m
+    $ locust -f --headless -c 1000 -r 100 --run-time 1h30m --step-load --step-clients 300 --step-time 20m
 
 Locust will swarm the clients by step and shutdown once the time is up.
 

docs/running-locust-without-web-ui.rst

@@ -5,11 +5,11 @@ Running Locust without the web UI
 =================================
 
 You can run locust without the web UI - for example if you want to run it in some automated flow, 
-like a CI server - by using the ``--no-web`` flag together with ``-c`` and ``-r``:
+like a CI server - by using the ``--headless`` flag together with ``-c`` and ``-r``:
 
 .. code-block:: console
 
-    $ locust -f locust_files/my_locust_file.py --no-web -c 1000 -r 100
+    $ locust -f locust_files/my_locust_file.py --headless -c 1000 -r 100
 
 ``-c`` specifies the number of Locust users to spawn, and ``-r`` specifies the hatch rate 
 (number of users to spawn per second).
@@ -22,7 +22,7 @@ If you want to specify the run time for a test, you can do that with ``--run-tim
 
 .. code-block:: console
 
-    $ locust -f --no-web -c 1000 -r 100 --run-time 1h30m
+    $ locust -f --headless -c 1000 -r 100 --run-time 1h30m
 
 Locust will shutdown once the time is up.
 
@@ -33,7 +33,7 @@ By default, locust will stop your tasks immediately. If you want to allow your t
 
 .. code-block:: console
 
-    $ locust -f --no-web -c 1000 -r 100 --run-time 1h30m --stop-timeout 99
+    $ locust -f --headless -c 1000 -r 100 --run-time 1h30m --stop-timeout 99
 
 .. _running-locust-distributed-without-web-ui: