Skip to content

Commit 6ebdc77

Browse files
Kasper Jungeclaude
authored andcommitted
docs: add pipx and pip install alternatives for users who don't have uv
The install instructions only showed `uv tool install`, blocking anyone without uv from getting started. Now README, landing page, and tutorial all offer uv/pipx/pip options with tabbed UI in the MkDocs site. Also adds project.urls to pyproject.toml so PyPI links to the docs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 25765e7 commit 6ebdc77

4 files changed

Lines changed: 48 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,17 @@ Ralphify wraps this pattern into a proper tool with config, iteration tracking,
1515
## Install
1616

1717
```bash
18-
uv tool install ralphify
18+
uv tool install ralphify # recommended
1919
```
2020

21-
This gives you the `ralph` command.
21+
Or if you don't have `uv`:
22+
23+
```bash
24+
pipx install ralphify # isolated install via pipx
25+
pip install ralphify # plain pip (use a virtualenv or --user)
26+
```
27+
28+
Any of these gives you the `ralph` command.
2229

2330
## Quickstart
2431

docs/getting-started.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,23 @@ This tutorial walks through setting up ralphify on a project, adding checks and
1010

1111
## Step 1: Install ralphify
1212

13-
```bash
14-
uv tool install ralphify
15-
```
13+
=== "uv (recommended)"
14+
15+
```bash
16+
uv tool install ralphify
17+
```
18+
19+
=== "pipx"
20+
21+
```bash
22+
pipx install ralphify
23+
```
24+
25+
=== "pip"
26+
27+
```bash
28+
pip install ralphify
29+
```
1630

1731
Verify it's working:
1832

docs/index.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,23 @@ Ralphify is a minimal CLI harness for autonomous AI coding loops, inspired by th
1616

1717
## Install
1818

19-
```bash
20-
uv tool install ralphify
21-
```
19+
=== "uv (recommended)"
20+
21+
```bash
22+
uv tool install ralphify
23+
```
24+
25+
=== "pipx"
26+
27+
```bash
28+
pipx install ralphify
29+
```
30+
31+
=== "pip"
32+
33+
```bash
34+
pip install ralphify
35+
```
2236

2337
## Two commands to start
2438

pyproject.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ dev = [
1515
"pytest>=8.0",
1616
]
1717

18+
[project.urls]
19+
Documentation = "https://computerlovetech.github.io/ralphify/"
20+
Repository = "https://github.com/computerlovetech/ralphify"
21+
Issues = "https://github.com/computerlovetech/ralphify/issues"
22+
1823
[build-system]
1924
requires = ["hatchling"]
2025
build-backend = "hatchling.build"

0 commit comments

Comments
 (0)