Skip to main content

prefect dev

prefect dev [OPTIONS] COMMAND [ARGS]...
Internal Prefect development.Note that many of these commands require extra dependencies (such as npm and MkDocs) to function properly.

prefect dev build-docs

prefect dev build-docs [OPTIONS]
Builds REST API reference documentation for static display.

Options

--schema-path

prefect dev build-ui

prefect dev build-ui [OPTIONS]
Installs dependencies and builds UI locally. Requires npm.

Options

--no-install

prefect dev ui

prefect dev ui [OPTIONS]
Starts a hot-reloading development UI.

prefect dev api

prefect dev api [OPTIONS]
Starts a hot-reloading development API.

Options

--host
--port
--log-level
--services

prefect dev start

prefect dev start [OPTIONS]
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.

Options

--no-api
--no-ui

prefect dev build-image

prefect dev build-image [OPTIONS]
Build a docker image for development.

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

prefect dev container [OPTIONS]
Run a docker container with local code mounted and installed.

Options

--bg
--name
--api
--tag
I