diff --git a/docs/images/modern-webui-splash-screenshot.png b/docs/images/modern-webui-splash-screenshot.png new file mode 100644 index 0000000000..a6824fb4de Binary files /dev/null and b/docs/images/modern-webui-splash-screenshot.png differ diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 7c9dd98148..e20d6abed9 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -58,6 +58,14 @@ The following screenshots show what it might look like when running this test us If you need some help digging into server side problems, or you're having trouble generating enough load to saturate your system, have a look at the `Locust FAQ `_. +There is now a modern version of the Web UI available! Try it out by setting the ```--modern-ui``` flag. + +.. image:: images/modern-webui-splash-screenshot.png + +.. note:: + + This feature is experimental and you may experience breaking changes. + Direct command line usage / headless ==================================== diff --git a/locust/argument_parser.py b/locust/argument_parser.py index 0b3ec3955d..f6d524a77d 100644 --- a/locust/argument_parser.py +++ b/locust/argument_parser.py @@ -362,7 +362,7 @@ def setup_parser_arguments(parser): "--modern-ui", default=False, action="store_true", - help="*Experimental* Enable using a modern React frontend as the Web UI", + help="*Experimental* enable using a modern React frontend as the Web UI", env_var="LOCUST_MODERN_UI", )