Skip to content

Commit ea4490c

Browse files
Kasper Jungeclaude
authored andcommitted
docs: add gitignore guidance for users who generate log files with --log-dir
Users following the getting-started guide create ralph_logs/ via --log-dir but had no guidance on excluding them from version control. Added: - ralph_logs/ to .gitignore - A tip in the getting-started guide after the first --log-dir usage - A "What files should I commit?" FAQ entry with a clear table Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 3129a9c commit ea4490c

3 files changed

Lines changed: 26 additions & 1 deletion

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ dist/
55
.venv/
66
.claude/
77
.codex/
8-
site/
8+
site/
9+
ralph_logs/

docs/faq.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,23 @@ Each loop operates independently with its own prompt and checks.
119119

120120
## Configuration
121121

122+
### What files should I commit?
123+
124+
Ralphify creates several files and directories. Here's what belongs in version control and what doesn't:
125+
126+
| File / directory | Commit? | Why |
127+
|---|---|---|
128+
| `ralph.toml` | **Yes** | Loop configuration — shared across your team |
129+
| `PROMPT.md` | **Yes** | The prompt is the core of your loop |
130+
| `.ralph/` | **Yes** | Checks, contexts, and instructions — project config your team should share |
131+
| `ralph_logs/` | **No** | Iteration output logs — large, machine-specific, regenerated every run |
132+
133+
Add `ralph_logs/` to your `.gitignore`:
134+
135+
```bash
136+
echo "ralph_logs/" >> .gitignore
137+
```
138+
122139
### Should I commit the `.ralph/` directory?
123140

124141
Yes. It contains your checks, contexts, and instructions — this is project configuration that your team should share:

docs/getting-started.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,13 @@ ls ralph_logs/
100100
cat ralph_logs/001_*.log
101101
```
102102

103+
!!! tip "Add `ralph_logs/` to `.gitignore`"
104+
Log files are useful for debugging but shouldn't be committed. Add them to your `.gitignore`:
105+
106+
```bash
107+
echo "ralph_logs/" >> .gitignore
108+
```
109+
103110
If the agent produced useful work, you're ready to add guardrails.
104111

105112
## Step 5: Add a test check

0 commit comments

Comments
 (0)