prefect.cli.dev

Dev command — native cyclopts implementation.

Internal Prefect development commands.

Functions

build_docs ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/dev.py#L61" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

build_docs(schema_path: Optional[str] = None)

Builds REST API reference documentation for static display.

build_ui ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/dev.py#L87" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

build_ui(no_install: Annotated[bool, cyclopts.Parameter('--no-install', negative='', help='Skip installing npm dependencies before building.')] = False, include_v2: Annotated[bool, cyclopts.Parameter('--include-v2', negative='', help='Also build the React UI v2 bundle into the Prefect package.')] = False)

Installs dependencies and builds UI locally. Requires npm.

ui ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/dev.py#L164" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

ui()

Starts a hot-reloading development UI.

api ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/dev.py#L180" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

api()

Starts a hot-reloading development API.

start ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/dev.py#L263" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

start()

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

build_image ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/dev.py#L297" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

build_image()

Build a docker image for development.

container ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/dev.py#L393" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

container()

Run a docker container with local code mounted and installed.