Skip to content

Commit 269b415

Browse files
committed
docs: clarify usage instructions and restructure README
1 parent 32cbaf4 commit 269b415

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,41 @@ A bash-based orchestration system for running AI coding agents in Docker contain
99
- **Identity:** Persona + Sandbox + Keys.
1010
- **Ralph:** The heartbeat loop.
1111

12+
```bash
13+
./sandbox.sh build # Forge Golden Image (once)
14+
```
15+
1216
**go → (ralph)**
1317

1418
```bash
15-
./sandbox.sh build # Forge Golden Image
16-
./sandbox.sh go URL # Combines create + clone + in
19+
./sandbox.sh go REPO-URL # Combines create + clone + in
1720
~/mothership/ralph.sh 1 # Unleash Ralph (inside)
1821
```
1922

20-
You can split out `go` into its component parts.
23+
## Docs
24+
25+
`go` split into its component parts, for more control:
2126

2227
**create → clone → (ralph) → purge**
2328

2429
```bash
25-
./sandbox.sh build # Forge Golden Image
26-
./sandbox.sh create # Summon Identity
30+
./sandbox.sh create # Summon Identity (outputs ID)
2731
./sandbox.sh clone ID URL . # Claim Target
2832
./sandbox.sh in ID # Jack In
2933
~/mothership/ralph.sh 5 # Unleash Ralph (inside)
3034
./sandbox.sh purge ID # Scuttle
3135
```
3236

33-
## Docs
34-
3537
- **Container lifecycle**: `sandbox.sh` handles build/create/up/in/purge/list/save with Docker
3638
- **Identity management**: Animal-NATO naming (hawk-alpha, shark-bravo), unique Ed25519 SSH keys per container, emoji Git identities
3739
- **Agent execution loop**: `ralph.sh` runs inside containers as a heartbeat loop supporting Gemini CLI, Claude Code, and Pi agent (Moonshot)
3840
- **Personas**: Markdown files injected as system prompts ("killer" for YOLO velocity, "step-wise" for single-task precision)
3941
- **Workspace isolation**: Dedicated host directories per container, deploy key injection for GitHub
4042
- **Credential management**: API keys hydrated from env vars on init, never leaked to host
4143

42-
**Architecture choice**: "Monolithic Script" — bash wrapping CLIs with system prompts. Deliberately minimal: zero infrastructure overhead.
44+
*Architecture choice*: "Monolithic Script" — bash wrapping CLIs with system prompts. Deliberately minimal: zero infrastructure overhead.
4345

44-
**What it doesn't do**: No programmatic SDK integration, no agent-to-agent coordination, no feedback loops beyond ralph.sh iterations, no structured output capture, no state management beyond git commits and progress.txt.
46+
*What it doesn't do*: No programmatic SDK integration, no agent-to-agent coordination, no feedback loops beyond ralph.sh iterations, no structured output capture, no state management beyond git commits and progress.txt.
4547

4648
- [Templates](docs/TEMPLATES.md)
4749
- [Deploy Keys](docs/DEPLOY_KEYS.md)

0 commit comments

Comments
 (0)