Skip to content

Add coding assistant prompt to OSS quickstart #21113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
zzstoatzz wants to merge 2 commits into
base: main
Choose a base branch
from
+26 −2
Draft

Add coding assistant prompt to OSS quickstart #21113

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f0ec20
Add coding assistant prompt to OSS quickstart
zzstoatzz Mar 13, 2026
fdf48a8
stash
zzstoatzz Mar 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions docs/v3/get-started/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,24 @@ In this tutorial, you'll deploy your first workflow to Prefect -- by specifying
</Steps>
</Tab>
<Tab title="Open Source">
<Accordion title="Using a coding assistant?">
Paste this into Claude Code, Cursor, Codex CLI, or a similar coding assistant to get started:

```text
I'd like to get started with Prefect open source and complete the QuickStart at https://docs.prefect.io/v3/get-started/quickstart. Use https://docs.prefect.io/v3/get-started/install for installation guidance if Prefect is not installed yet.

Please inspect my environment first. If Prefect is not installed, install it using the docs, preferably with `uv` (`uv add prefect` in a project, or another minimal docs-aligned approach if needed). Then help me:
1. start a local Prefect server,
2. clone https://github.com/PrefectHQ/quickstart,
3. run `01_getting_started.py` locally,
4. update the file to use `main.serve(name="my-first-deployment")`,
5. run it again so the deployment is served,
6. trigger an ad hoc deployment run from the CLI,
7. update it again to add `cron="0 8 * * *"`.

Use the documented commands, filenames, and deployment name unless my environment requires a small adjustment. Use a Prefect MCP server if one is available, but do not assume it is installed. Explain what you're doing briefly as you go, and stop if you need me to keep a long-running process open or complete a manual step.
```
</Accordion>
<Steps>
<Step title="Install Prefect and start the server">
If you're using Prefect Open Source, you'll run a server that backs your workflows. [Install Prefect](/v3/get-started/install) and start your local server:
Expand Down Expand Up @@ -206,7 +224,13 @@ In this tutorial, you'll deploy your first workflow to Prefect -- by specifying
python 01_getting_started.py
```

This starts a process listening for scheduled runs. You can now trigger the flow from the Prefect UI or programmatically.
This starts a process listening for scheduled runs. While it is running, trigger an ad hoc run of the deployment:

```bash
uv run prefect deployment run 'main/my-first-deployment'
```

This lets you confirm that the served deployment runs immediately before adding a schedule.
</Step>
<Step title="When should it run?">
Now let's schedule your workflow to run automatically. Update the file to add a cron schedule:
Expand Down Expand Up @@ -259,4 +283,4 @@ Now that you've created your first workflow, explore Prefect's features to enabl
- Learn more about [flows](/v3/concepts/flows) and [tasks](/v3/concepts/tasks).
- Learn more about [deployments](/v3/concepts/deployments).
- Learn more about [work pools](/v3/concepts/work-pools).
- Learn how to [run work concurrently](/v3/how-to-guides/workflows/run-work-concurrently).
- Learn how to [run work concurrently](/v3/how-to-guides/workflows/run-work-concurrently).