prefect.cli.server

Server command — native cyclopts implementation.

Start and manage the Prefect server.

Functions

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

start()

Start a Prefect server instance.

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

status()

Check the status of the Prefect server.

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

stop()

Stop a Prefect server instance running in the background.

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

reset()

Drop and recreate all Prefect database tables.

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

upgrade()

Upgrade the Prefect database.

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

downgrade()

Downgrade the Prefect database.

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

revision()

Create a new migration for the Prefect database.

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

stamp(revision: str)

Stamp the revision table with the given revision; don't run any migrations.

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

list_services()

List all available services and their status.

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

start_services()

Start all enabled Prefect services in one process.

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

stop_services()

Stop any background Prefect services that were started.

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

run_manager_process()

Internal entrypoint for background services.