Command Line Interface

Installing Flask installs the flask script, a Click command line interface, in your virtualenv. Executed from the terminal, this script gives access to built-in, extension, and application-defined commands. The --help option will give more information about any commands and options.

Application Discovery

The flask command is installed by Flask, not your application; it must be told where to find your application in order to use it. The FLASK_APP environment variable is used to specify how to load the application.

BashFishCMDPowershell

  1. $ export FLASK_APP=hello
  2. $ flask run
  1. $ set -x FLASK_APP hello
  2. $ flask run
  1. > set FLASK_APP=hello
  2. > flask run
  1. > $env:FLASK_APP = "hello"
  2. > flask run

While FLASK_APP supports a variety of options for specifying your application, most use cases should be simple. Here are the typical values:

(nothing)

The name “app” or “wsgi” is imported (as a “.py” file, or package), automatically detecting an app (app or application) or factory (create_app or make_app).

FLASK_APP=hello

The given name is imported, automatically detecting an app (app or application) or factory (create_app or make_app).

FLASK_APP has three parts: an optional path that sets the current working directory, a Python file or dotted import path, and an optional variable name of the instance or factory. If the name is a factory, it can optionally be followed by arguments in parentheses. The following values demonstrate these parts:

FLASK_APP=src/hello

Sets the current working directory to src then imports hello.

FLASK_APP=hello.web

Imports the path hello.web.

FLASK_APP=hello:app2

Uses the app2 Flask instance in hello.

FLASK_APP="hello:create_app('dev')"

The create_app factory in hello is called with the string 'dev' as the argument.

If FLASK_APP is not set, the command will try to import “app” or “wsgi” (as a “.py” file, or package) and try to detect an application instance or factory.

Within the given import, the command looks for an application instance named app or application, then any application instance. If no instance is found, the command looks for a factory function named create_app or make_app that returns an instance.

If parentheses follow the factory name, their contents are parsed as Python literals and passed as arguments and keyword arguments to the function. This means that strings must still be in quotes.

Run the Development Server

The run command will start the development server. It replaces the Flask.run() method in most cases.

  1. $ flask run
  2.  * Serving Flask app "hello"
  3.  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

Warning

Do not use this command to run your application in production. Only use the development server during development. The development server is provided for convenience, but is not designed to be particularly secure, stable, or efficient. See Deploying to Production for how to run in production.

If another program is already using port 5000, you’ll see OSError: [Errno 98] or OSError: [WinError 10013] when the server tries to start. See Address already in use for how to handle that.

Open a Shell

To explore the data in your application, you can start an interactive Python shell with the shell command. An application context will be active, and the app instance will be imported.

  1. $ flask shell
  2. Python 3.10.0 (default, Oct 27 2021, 06:59:51) [GCC 11.1.0] on linux
  3. App: example [production]
  4. Instance: /home/david/Projects/pallets/flask/instance
  5. >>>

Use shell_context_processor() to add other automatic imports.

Environments

Changelog

New in version 1.0.

The environment in which the Flask app runs is set by the FLASK_ENV environment variable. If not set it defaults to production. The other recognized environment is development. Flask and extensions may choose to enable behaviors based on the environment.

If the env is set to development, the flask command will enable debug mode and flask run will enable the interactive debugger and reloader.

BashFishCMDPowershell

  1. $ export FLASK_ENV=development
  2. $ flask run
  3.  * Serving Flask app "hello"
  4.  * Environment: development
  5.  * Debug mode: on
  6.  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
  7.  * Restarting with inotify reloader
  8.  * Debugger is active!
  9.  * Debugger PIN: 223-456-919
  1. $ set -x FLASK_ENV development
  2. $ flask run
  3.  * Serving Flask app "hello"
  4.  * Environment: development
  5.  * Debug mode: on
  6.  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
  7.  * Restarting with inotify reloader
  8.  * Debugger is active!
  9.  * Debugger PIN: 223-456-919
  1. > set FLASK_ENV=development
  2. > flask run
  3.  * Serving Flask app "hello"
  4.  * Environment: development
  5.  * Debug mode: on
  6.  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
  7.  * Restarting with inotify reloader
  8.  * Debugger is active!
  9.  * Debugger PIN: 223-456-919
  1. > $env:FLASK_ENV = "development"
  2. > flask run
  3.  * Serving Flask app "hello"
  4.  * Environment: development
  5.  * Debug mode: on
  6.  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
  7.  * Restarting with inotify reloader
  8.  * Debugger is active!
  9.  * Debugger PIN: 223-456-919

Watch Extra Files with the Reloader

When using development mode, the reloader will trigger whenever your Python code or imported modules change. The reloader can watch additional files with the --extra-files option, or the FLASK_RUN_EXTRA_FILES environment variable. Multiple paths are separated with :, or ; on Windows.

BashFishCMDPowershell

  1. $ flask run --extra-files file1:dirA/file2:dirB/
  2. # or
  3. $ export FLASK_RUN_EXTRA_FILES=file1:dirA/file2:dirB/
  4. $ flask run
  5.  * Running on http://127.0.0.1:8000/
  6.  * Detected change in '/path/to/file1', reloading
  1. $ flask run --extra-files file1:dirA/file2:dirB/
  2. # or
  3. $ set -x FLASK_RUN_EXTRA_FILES file1 dirA/file2 dirB/
  4. $ flask run
  5.  * Running on http://127.0.0.1:8000/
  6.  * Detected change in '/path/to/file1', reloading
  1. > flask run --extra-files file1:dirA/file2:dirB/
  2. # or
  3. > set FLASK_RUN_EXTRA_FILES=file1:dirA/file2:dirB/
  4. > flask run
  5.  * Running on http://127.0.0.1:8000/
  6.  * Detected change in '/path/to/file1', reloading
  1. > flask run --extra-files file1:dirA/file2:dirB/
  2. # or
  3. > $env:FLASK_RUN_EXTRA_FILES = "file1:dirA/file2:dirB/"
  4. > flask run
  5.  * Running on http://127.0.0.1:8000/
  6.  * Detected change in '/path/to/file1', reloading

Ignore files with the Reloader

The reloader can also ignore files using fnmatch patterns with the --exclude-patterns option, or the FLASK_RUN_EXCLUDE_PATTERNS environment variable. Multiple patterns are separated with :, or ; on Windows.

Debug Mode

Debug mode will be enabled when FLASK_ENV is development, as described above. If you want to control debug mode separately, use FLASK_DEBUG. The value 1 enables it, 0 disables it.

Environment Variables From dotenv

Rather than setting FLASK_APP each time you open a new terminal, you can use Flask’s dotenv support to set environment variables automatically.

If python-dotenv is installed, running the flask command will set environment variables defined in the files .env and .flaskenv. This can be used to avoid having to set FLASK_APP manually every time you open a new terminal, and to set configuration using environment variables similar to how some deployment services work.

Variables set on the command line are used over those set in .env, which are used over those set in .flaskenv. .flaskenv should be used for public variables, such as FLASK_APP, while .env should not be committed to your repository so that it can set private variables.

Directories are scanned upwards from the directory you call flask from to locate the files.

The files are only loaded by the flask command or calling run(). If you would like to load these files when running in production, you should call load_dotenv() manually.

Setting Command Options

Click is configured to load default values for command options from environment variables. The variables use the pattern FLASK_COMMAND_OPTION. For example, to set the port for the run command, instead of flask run --port 8000:

BashFishCMDPowershell

  1. $ export FLASK_RUN_PORT=8000
  2. $ flask run
  3.  * Running on http://127.0.0.1:8000/
  1. $ set -x FLASK_RUN_PORT 8000
  2. $ flask run
  3.  * Running on http://127.0.0.1:8000/
  1. > set FLASK_RUN_PORT=8000
  2. > flask run
  3.  * Running on http://127.0.0.1:8000/
  1. > $env:FLASK_RUN_PORT = 8000
  2. > flask run
  3.  * Running on http://127.0.0.1:8000/

These can be added to the .flaskenv file just like FLASK_APP to control default command options.

Disable dotenv

The flask command will show a message if it detects dotenv files but python-dotenv is not installed.

  1. $ flask run
  2.  * Tip: There are .env files present. Do "pip install python-dotenv" to use them.

You can tell Flask not to load dotenv files even when python-dotenv is installed by setting the FLASK_SKIP_DOTENV environment variable. This can be useful if you want to load them manually, or if you’re using a project runner that loads them already. Keep in mind that the environment variables must be set before the app loads or it won’t configure as expected.

BashFishCMDPowershell

  1. $ export FLASK_SKIP_DOTENV=1
  2. $ flask run
  1. $ set -x FLASK_SKIP_DOTENV 1
  2. $ flask run
  1. > set FLASK_SKIP_DOTENV=1
  2. > flask run
  1. > $env:FLASK_SKIP_DOTENV = 1
  2. > flask run

Environment Variables From virtualenv

If you do not want to install dotenv support, you can still set environment variables by adding them to the end of the virtualenv’s activate script. Activating the virtualenv will set the variables.

BashFishCMDPowershell

Unix Bash, venv/bin/activate:

  1. $ export FLASK_APP=hello

Fish, venv/bin/activate.fish:

  1. $ set -x FLASK_APP hello

Windows CMD, venv\Scripts\activate.bat:

  1. > set FLASK_APP=hello

Windows Powershell, venv\Scripts\activate.ps1:

  1. > $env:FLASK_APP = "hello"

It is preferred to use dotenv support over this, since .flaskenv can be committed to the repository so that it works automatically wherever the project is checked out.

Custom Commands

The flask command is implemented using Click. See that project’s documentation for full information about writing commands.

This example adds the command create-user that takes the argument name.

  1. import click
  2. from flask import Flask
  4. app = Flask(__name__)
  6. @app.cli.command("create-user")
  7. @click.argument("name")
  8. def create_user(name):
  9.     ...
  1. $ flask create-user admin

This example adds the same command, but as user create, a command in a group. This is useful if you want to organize multiple related commands.

  1. import click
  2. from flask import Flask
  3. from flask.cli import AppGroup
  5. app = Flask(__name__)
  6. user_cli = AppGroup('user')
  8. @user_cli.command('create')
  9. @click.argument('name')
  10. def create_user(name):
  11.     ...
  13. app.cli.add_command(user_cli)
  1. $ flask user create demo

See Running Commands with the CLI Runner for an overview of how to test your custom commands.

Registering Commands with Blueprints

If your application uses blueprints, you can optionally register CLI commands directly onto them. When your blueprint is registered onto your application, the associated commands will be available to the flask command. By default, those commands will be nested in a group matching the name of the blueprint.

  1. from flask import Blueprint
  3. bp = Blueprint('students', __name__)
  5. @bp.cli.command('create')
  6. @click.argument('name')
  7. def create(name):
  8.     ...
  10. app.register_blueprint(bp)
  1. $ flask students create alice

You can alter the group name by specifying the cli_group parameter when creating the Blueprint object, or later with app.register_blueprint(bp, cli_group=’…’). The following are equivalent:

  1. bp = Blueprint('students', __name__, cli_group='other')
  2. # or
  3. app.register_blueprint(bp, cli_group='other')
  1. $ flask other create alice

Specifying cli_group=None will remove the nesting and merge the commands directly to the application’s level:

  1. bp = Blueprint('students', __name__, cli_group=None)
  2. # or
  3. app.register_blueprint(bp, cli_group=None)
  1. $ flask create alice

Application Context

Commands added using the Flask app’s cli command() decorator will be executed with an application context pushed, so your command and extensions have access to the app and its configuration. If you create a command using the Click command() decorator instead of the Flask decorator, you can use with_appcontext() to get the same behavior.

  1. import click
  2. from flask.cli import with_appcontext
  4. @click.command()
  5. @with_appcontext
  6. def do_work():
  7.     ...
  9. app.cli.add_command(do_work)

If you’re sure a command doesn’t need the context, you can disable it:

  1. @app.cli.command(with_appcontext=False)
  2. def do_work():
  3.     ...

Plugins

Flask will automatically load commands specified in the flask.commands entry point. This is useful for extensions that want to add commands when they are installed. Entry points are specified in setup.py

  1. from setuptools import setup
  3. setup(
  4.     name='flask-my-extension',
  5.     ...,
  6.     entry_points={
  7.         'flask.commands': [
  8.             'my-command=flask_my_extension.commands:cli'
  9.         ],
  10.     },
  11. )

Inside flask_my_extension/commands.py you can then export a Click object:

  1. import click
  3. @click.command()
  4. def cli():
  5.     ...

Once that package is installed in the same virtualenv as your Flask project, you can run flask my-command to invoke the command.

Custom Scripts

When you are using the app factory pattern, it may be more convenient to define your own Click script. Instead of using FLASK_APP and letting Flask load your application, you can create your own Click object and export it as a console script entry point.

Create an instance of FlaskGroup and pass it the factory:

  1. import click
  2. from flask import Flask
  3. from flask.cli import FlaskGroup
  5. def create_app():
  6.     app = Flask('wiki')
  7.     # other setup
  8.     return app
  10. @click.group(cls=FlaskGroup, create_app=create_app)
  11. def cli():
  12.     """Management script for the Wiki application."""

Define the entry point in setup.py:

  1. from setuptools import setup
  3. setup(
  4.     name='flask-my-extension',
  5.     ...,
  6.     entry_points={
  7.         'console_scripts': [
  8.             'wiki=wiki:cli'
  9.         ],
  10.     },
  11. )

Install the application in the virtualenv in editable mode and the custom script is available. Note that you don’t need to set FLASK_APP.

  1. $ pip install -e .
  2. $ wiki run

Errors in Custom Scripts

When using a custom script, if you introduce an error in your module-level code, the reloader will fail because it can no longer load the entry point.

The flask command, being separate from your code, does not have this issue and is recommended in most cases.

PyCharm Integration

PyCharm Professional provides a special Flask run configuration. For the Community Edition, we need to configure it to call the flask run CLI command with the correct environment variables. These instructions should be similar for any other IDE you might want to use.

In PyCharm, with your project open, click on Run from the menu bar and go to Edit Configurations. You’ll be greeted by a screen similar to this:

Screenshot of PyCharms's run configuration settings.

There’s quite a few options to change, but once we’ve done it for one command, we can easily copy the entire configuration and make a single tweak to give us access to other commands, including any custom ones you may implement yourself.

Click the + (Add New Configuration) button and select Python. Give the configuration a name such as “flask run”. For the flask run command, check “Single instance only” since you can’t run the server more than once at the same time.

Select Module name from the dropdown (A) then input flask.

The Parameters field (B) is set to the CLI command to execute (with any arguments). In this example we use run, which will run the development server.

You can skip this next step if you’re using Environment Variables From dotenv. We need to add an environment variable (C) to identify our application. Click on the browse button and add an entry with FLASK_APP on the left and the Python import or file on the right (hello for example). Add an entry with FLASK_ENV and set it to development.

Next we need to set the working directory (D) to be the folder where our application resides.

If you have installed your project as a package in your virtualenv, you may untick the PYTHONPATH options (E). This will more accurately match how you deploy the app later.

Click Apply to save the configuration, or OK to save and close the window. Select the configuration in the main PyCharm window and click the play button next to it to run the server.

Now that we have a configuration which runs flask run from within PyCharm, we can copy that configuration and alter the Script argument to run a different CLI command, e.g. flask shell.