CLI Reference
prefect dev
Internal Prefect development.Note that many of these commands require extra dependencies (such as npm and MkDocs)
to function properly.
prefect dev build-docs
Builds REST API reference documentation for static display.
Options
Options
--schema-path
prefect dev build-ui
Installs dependencies and builds UI locally. Requires npm.
Options
Options
--no-install
prefect dev ui
Starts a hot-reloading development UI.
prefect dev api
Starts a hot-reloading development API.
prefect dev start
Starts a hot-reloading development server with API, UI, and agent processes.Each service has an individual command if you wish to start them separately.
Each service can be excluded here as well.
prefect dev build-image
Build a docker image for development.
Options
Options
--arch
The architecture to build the container for. Defaults to the architecture of the host Python. [default: arm64]
--python-version
The Python version to build the container for. Defaults to the version of the host Python. [default: 3.10]
--flavor
An alternative flavor to build, for example ‘conda’. Defaults to the standard Python base image
--dry-run
prefect dev container
Run a docker container with local code mounted and installed.