Prefect Docs

# Prefect Tutorial Examples

Looking for the latest Prefect 2 release? Prefect 2 and Prefect Cloud 2 have been released for General Availability. See https://docs.prefect.io/ for details.

Prefect includes a number of examples covering different features. Some are covered in the tutorials, and all can be accessed from the GitHub repo here.

# Running examples with Prefect Cloud or Server

When running with Prefect Cloud or Prefect Server, you can register the examples in a new project with the Prefect CLI. You can either register all the examples at once, or select specific examples by name.

# Create a new project named "Prefect Examples"
$ prefect create project "Prefect Examples"

# Register all the examples into the "Prefect Examples" project
$ prefect register --json https://docs.prefect.io/examples.json \
    --project "Prefect Examples"

# OR register only specific examples by specifying them by name
$ prefect register --json https://docs.prefect.io/examples.json \
    --project "Prefect Examples" \
    --name "Example: Parameters" \
    --name "Example: Mapping"

These can then be run using any agent with a prefect-examples label. Before starting the agent, make sure the Github extra is installed so the agent can pull the flows by doing:

pip install "prefect[github]"

Then to start a local agent for running the examples:

$ prefect agent local start -l prefect-examples

If you haven't already, we recommend going through the Getting Started Orchestration Layer topics beforehand.

← Parameters →