prefect worker

prefect worker [OPTIONS] COMMAND [ARGS]...

Start and interact with workers.

prefect worker start

prefect worker start [OPTIONS]

Start a worker process to poll a work pool for flow runs.

Options

--name

The name to give to the started worker.

--pool

The work pool the started worker should poll.

--work-queue

Work queue names to pull from (repeatable).

--type

The type of worker to start.

--prefetch-seconds

Seconds to look ahead for scheduled flow runs. [from PREFECT_WORKER_PREFETCH_SECONDS]

--run-once

Only run worker polling once.

--limit

Maximum concurrent flow runs.

--with-healthcheck

Start a healthcheck server.

--install-policy

Install policy for worker packages.

--base-job-template

Path to JSON file containing base job template.

--create-pool-if-not-found

Create the work pool if it does not exist. Set to false when the work pool is managed externally (e.g. via Terraform or another provisioning tool).