prefect dev

prefect dev [OPTIONS] COMMAND [ARGS]...

Internal Prefect development.

prefect dev build-docs

prefect dev build-docs [OPTIONS] [SCHEMA_PATH]

Builds REST API reference documentation for static display.

Arguments

SCHEMA_PATH · string

prefect dev build-ui

prefect dev build-ui [OPTIONS]

Installs dependencies and builds UI locally. Requires npm.

Options

--no-install

Skip installing npm dependencies before building.

--include-v2

Also build the React UI v2 bundle into the Prefect package.

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

API host address.

--port

API port number.

--log-level

Log level for the server.

--services/--no-services

Run services in app.

prefect dev start

prefect dev start [OPTIONS]

Starts a hot-reloading development server with API, UI, and agent processes.

Options

--no-api

Exclude the API service.

--no-ui

Exclude the UI service.

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: x86_64]

--python-version

The Python version to build the container for. Defaults to the version of the host Python.

--flavor

An alternative flavor to build, for example ‘conda’. Defaults to the standard Python base image

--build-arg

This will directly pass a —build-arg into the docker build process. Can be added to the command line multiple times.

--dry-run

Print the command instead of running.

prefect dev container

prefect dev container [OPTIONS]

Run a docker container with local code mounted and installed.

Options

--bg

Run in background.

--name

Container name.

--api/--no-api

Start API in container.

--tag

Docker image tag.