Merge pull request #4779 from greyli/add-debug-to-run

Add `--debug` option to flask run

CHANGES.rst

@@ -7,6 +7,7 @@ Unreleased
     templates this behavior can be changed with the ``autoescape`` tag.
     :issue:`4831`
 -   Fix the type of ``template_folder`` to accept ``pathlib.Path``. :issue:`4892`
+-   Add ``--debug`` option to the ``flask run`` command. :issue:`4777`
 
 
 Version 2.2.2

docs/cli.rst

@@ -95,7 +95,7 @@ the ``--debug`` option.
 
 .. code-block:: console
 
-     $ flask --app hello --debug run
+     $ flask --app hello run --debug
       * Serving Flask app "hello"
       * Debug mode: on
       * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
@@ -550,7 +550,7 @@ a name such as "flask run".
 Click the *Script path* dropdown and change it to *Module name*, then input ``flask``.
 
 The *Parameters* field is set to the CLI command to execute along with any arguments.
-This example uses ``--app hello --debug run``, which will run the development server in
+This example uses ``--app hello run --debug``, which will run the development server in
 debug mode. ``--app hello`` should be the import or file with your Flask app.
 
 If you installed your project as a package in your virtualenv, you may uncheck the

docs/config.rst

@@ -47,15 +47,15 @@ Debug Mode
 
 The :data:`DEBUG` config value is special because it may behave inconsistently if
 changed after the app has begun setting up. In order to set debug mode reliably, use the
-``--debug`` option on the ``flask`` command. ``flask run`` will use the interactive
+``--debug`` option on the ``flask run`` command. ``flask run`` will use the interactive
 debugger and reloader by default in debug mode.
 
 .. code-block:: text
 
-    $ flask --app hello --debug run
+    $ flask --app hello run --debug
 
 Using the option is recommended. While it is possible to set :data:`DEBUG` in your
-config or code, this is strongly discouraged. It can't be read early by the ``flask``
+config or code, this is strongly discouraged. It can't be read early by the ``flask run``
 command, and some systems or extensions may have already configured themselves based on
 a previous value.
 

docs/debugging.rst

@@ -43,7 +43,7 @@ The debugger is enabled by default when the development server is run in debug m
 
 .. code-block:: text
 
-    $ flask --app hello --debug run
+    $ flask --app hello run --debug
 
 When running from Python code, passing ``debug=True`` enables debug mode, which is
 mostly equivalent.
@@ -72,7 +72,7 @@ which can interfere.
 
 .. code-block:: text
 
-    $ flask --app hello --debug run --no-debugger --no-reload
+    $ flask --app hello run --debug --no-debugger --no-reload
 
 When running from Python:
 

docs/quickstart.rst

@@ -108,7 +108,7 @@ To enable debug mode, use the ``--debug`` option.
 
 .. code-block:: text
 
-    $ flask --app hello --debug run
+    $ flask --app hello run --debug
      * Serving Flask app 'hello'
      * Debug mode: on
      * Running on http://127.0.0.1:5000 (Press CTRL+C to quit)

docs/server.rst

@@ -24,7 +24,7 @@ debug mode.
 
 .. code-block:: text
 
-    $ flask --app hello --debug run
+    $ flask --app hello run --debug
 
 This enables debug mode, including the interactive debugger and reloader, and then
 starts the server on http://localhost:5000/. Use ``flask run --help`` to see the

docs/tutorial/factory.rst

@@ -137,7 +137,7 @@ follow the tutorial.
 
 .. code-block:: text
 
-    $ flask --app flaskr --debug run
+    $ flask --app flaskr run --debug
 
 You'll see output similar to this:
 

examples/tutorial/README.rst

@@ -48,7 +48,7 @@ Run
 .. code-block:: text
 
     $ flask --app flaskr init-db
-    $ flask --app flaskr --debug run
+    $ flask --app flaskr run --debug
 
 Open http://127.0.0.1:5000 in a browser.
 

src/flask/cli.py

@@ -933,6 +933,9 @@ def run_command(
     )
 
 
+run_command.params.insert(0, _debug_option)
+
+
 @click.command("shell", short_help="Run a shell in the app context.")
 @with_appcontext
 def shell_command() -> None: