Skip to content

Commit 5b27fc1

Browse files
authored
slightly clarify install instructions (#19165)
1 parent cc76780 commit 5b27fc1

File tree

2 files changed

+29
-15
lines changed

2 files changed

+29
-15
lines changed

docs/snippets/installation.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
To install Prefect with `pip`, run:
1+
To install Prefect, run:
22

33
<CodeGroup>
44

@@ -7,7 +7,11 @@ pip install -U prefect
77
```
88

99
```bash uv
10-
uv pip install -U prefect
10+
# add prefect to an existing virtual environment
11+
uv pip install prefect
12+
13+
# add prefect to your pyproject.toml
14+
uv add prefect
1115
```
1216

1317

docs/v3/get-started/install.mdx

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,33 @@ Prefect is published as a Python package, which requires Python 3.9 or newer. We
1111

1212
To confirm that Prefect was installed successfully, run:
1313

14-
```bash
14+
<CodeGroup>
15+
16+
```bash pip
1517
prefect version
1618
```
1719

20+
```bash uv
21+
uv run prefect version
22+
```
23+
24+
</CodeGroup>
25+
1826
You should see output similar to:
1927

2028
```bash
21-
Version: 3.1.10
22-
API version: 0.8.4
23-
Python version: 3.12.2
24-
Git commit: d6bdb075
25-
Built: Thu, Apr 11, 2024 6:58 PM
26-
OS/Arch: darwin/arm64
29+
Version: 3.4.24
30+
API version: 0.8.4
31+
Python version: 3.12.8
32+
Git commit: 2428894e
33+
Built: Mon, Oct 13, 2025 07:16 PM
34+
OS/Arch: darwin/arm64
2735
Profile: local
28-
Server type: ephemeral
36+
Server type: server
37+
Pydantic version: 2.11.7
2938
Server:
30-
Database: sqlite
31-
SQLite version: 3.45.2
39+
Database: sqlite
40+
SQLite version: 3.47.1
3241
```
3342

3443
<Accordion title="More commands for power users">
@@ -45,11 +54,12 @@ uvx --python 3.12 --with prefect ipython
4554
install prefect into a `uv` virtual environment:
4655

4756
```bash
48-
uv venv --python 3.12 && source .venv/bin/activate
49-
uv pip install -U prefect
57+
uv venv --python 3.12
58+
source .venv/bin/activate
59+
uv add prefect
5060
```
5161

52-
add prefect to an active project:
62+
add prefect to a project:
5363

5464
```bash
5565
uv add prefect

0 commit comments

Comments
 (0)