prefect dev

<Info> Internal Prefect development.

Note that many of these commands require extra dependencies (such as npm and MkDocs) to function properly. </Info>

prefect dev build-docs

<Info> Builds REST API reference documentation for static display. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--schema-path"> </ResponseField> </Accordion> </AccordionGroup>

prefect dev build-ui

<Info> Installs dependencies and builds UI locally. Requires npm. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--no-install"> Skip installing npm dependencies before building. </ResponseField> <ResponseField name="--include-v2"> Also build the React UI v2 bundle into the Prefect package. </ResponseField> </Accordion> </AccordionGroup>

prefect dev ui

<Info> Starts a hot-reloading development UI. </Info>

prefect dev api

<Info> Starts a hot-reloading development API. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--host"> </ResponseField> <ResponseField name="--port"> </ResponseField> <ResponseField name="--log-level"> </ResponseField> <ResponseField name="--services"> </ResponseField> </Accordion> </AccordionGroup>

prefect dev start

<Info> 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. </Info>

<AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--no-api"> </ResponseField> <ResponseField name="--no-ui"> </ResponseField> </Accordion> </AccordionGroup>

prefect dev build-image

<Info> Build a docker image for development. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--arch"> The architecture to build the container for. Defaults to the architecture of the host Python. [default: x86_64] </ResponseField> <ResponseField name="--python-version"> The Python version to build the container for. Defaults to the version of the host Python. [default: 3.12] </ResponseField> <ResponseField name="--flavor"> An alternative flavor to build, for example 'conda'. Defaults to the standard Python base image </ResponseField> <ResponseField name="--build-arg"> This will directly pass a --build-arg into the docker build process. Can be added to the command line multiple times. </ResponseField> <ResponseField name="--dry-run"> </ResponseField> </Accordion> </AccordionGroup>

prefect dev container

<Info> Run a docker container with local code mounted and installed. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--bg"> </ResponseField> <ResponseField name="--name"> </ResponseField> <ResponseField name="--api"> </ResponseField> <ResponseField name="--tag"> </ResponseField> </Accordion> </AccordionGroup>