Skip to content

Commit f77410c

Browse files
Kasper Jungeclaude
authored andcommitted
fix: resolve ty type-check failures for optional UI deps and add agent setup guide to Getting Started
Exclude src/ralphify/ui/ from ty checking since fastapi/uvicorn/pydantic are optional dependencies. Add inline ignore for the uvicorn import in cli.py. Expand the Getting Started prerequisites with concrete Claude Code install, auth, and verification steps so new users don't get stuck before step 1. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 634b8f0 commit f77410c

3 files changed

Lines changed: 30 additions & 4 deletions

File tree

docs/getting-started.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,32 @@ This tutorial walks through setting up ralphify on a project, adding checks and
88

99
## Prerequisites
1010

11-
- Python 3.11+
12-
- [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code) installed and authenticated (or any agent CLI that accepts piped input)
13-
- A project with a test suite (we'll use this for the feedback loop)
11+
- **Python 3.11+**
12+
- **An AI coding agent CLI** — this tutorial uses Claude Code, but ralphify works with [any agent that accepts piped input](agents.md)
13+
- **A project with a test suite** (we'll use this for the feedback loop)
14+
15+
### Install Claude Code (if you don't have it)
16+
17+
```bash
18+
npm install -g @anthropic-ai/claude-code
19+
```
20+
21+
Then authenticate:
22+
23+
```bash
24+
claude # Opens an interactive session — follow the login prompts
25+
```
26+
27+
Once authenticated, verify it works non-interactively:
28+
29+
```bash
30+
echo "Say hello" | claude -p
31+
```
32+
33+
You should see a text response. If this works, you're ready.
34+
35+
!!! tip "Using a different agent?"
36+
See [Using with Different Agents](agents.md) for setup guides for Aider, Codex CLI, or your own custom wrapper.
1437

1538
## Step 1: Install ralphify
1639

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,8 @@ build-backend = "hatchling.build"
4747
packages = ["src/ralphify"]
4848
exclude = ["src/ralphify/ui/frontend/"]
4949

50+
[tool.ty.src]
51+
exclude = ["src/ralphify/ui/"]
52+
5053
[tool.pytest.ini_options]
5154
testpaths = ["tests"]

src/ralphify/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ def ui(
487487
except ImportError:
488488
rprint("[red]UI deps not installed. Run: pip install ralphify[ui][/red]")
489489
raise typer.Exit(1)
490-
import uvicorn
490+
import uvicorn # ty: ignore[unresolved-import]
491491

492492
rprint(f"[bold]Starting Ralphify UI at http://{host}:{port}[/bold]")
493493
uvicorn.run(create_app(), host=host, port=port)

0 commit comments

Comments
 (0)