APIs & SDK
- Overview
- Python SDK Overview
- REST API
- CLI Reference
- prefect artifact
- prefect automation
- prefect block
- prefect concurrency-limit
- prefect config
- prefect dashboard
- prefect deployment
- prefect dev
- prefect event
- prefect flow-run
- prefect flow
- prefect global-concurrency-limit
- prefect init
- prefect profile
- prefect profiles
- prefect server
- prefect shell
- prefect task-run
- prefect task
- prefect variable
- prefect version
- prefect work-pool
- prefect work-queue
- prefect worker
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.
The name to give to the started worker. If not provided, a unique name will be generated.
The work pool the started worker should poll.
One or more work queue names for the worker to pull from. If not provided, the worker will pull from all work queues in the work pool.
The type of worker to start. If not provided, the worker type will be inferred from the work pool.
Number of seconds to look into the future for scheduled flow runs.
Only run worker polling once. By default, the worker runs forever.
Maximum number of flow runs to start simultaneously.
Start a healthcheck server for the worker.
Install policy to use workers from Prefect integration packages.
The path to a JSON file containing the base job template to use. If unspecified, Prefect will use the default base job template for the given worker type. If the work pool already exists, this will be ignored.
Was this page helpful?