`prefect.cli.dev`

Dev command — native cyclopts implementation. Internal Prefect development commands.

Functions

`build_docs`

build_docs(schema_path: Optional[str] = None)

Builds REST API reference documentation for static display.

`build_ui`

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`

ui()

Starts a hot-reloading development UI.

`api`

api()

Starts a hot-reloading development API.

`start`

start()

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

`build_image`

build_image()

Build a docker image for development.

`container`

container()

Run a docker container with local code mounted and installed.

deployment events

⌘I

​prefect.cli.dev

​Functions

​build_docs

​build_ui

​ui

​api

​start

​build_image

​container