Forrest logo
back to the uvicorn tool

uvicorn:tldr:86f14

uvicorn: Turn on live reload.
$ uvicorn --reload ${import-path:app_object}
try on your machine

The command uvicorn --reload ${import-path:app_object} is used to start a server using the Uvicorn web framework.

Here's a breakdown of the command:

  • uvicorn is the name of the Uvicorn command-line interface (CLI) that helps run the server.
  • --reload is an optional flag that tells Uvicorn to automatically reload the server whenever code changes are detected. This is useful during development because it eliminates the need to manually restart the server after making code modifications.
  • ${import-path:app_object} represents the argument for the command. Here, you would replace ${import-path} with the actual import path of your application and app_object with the name of the variable or object that represents your FastAPI application.

For example, your final command might look like uvicorn --reload myapp:app, where myapp is the import path and app is the FastAPI application object named app.

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 uvicorn tool