Skip to content

Commit 825f25c

Browse files
committed
Update README with simplified quick start
1 parent c668cbf commit 825f25c

1 file changed

Lines changed: 27 additions & 16 deletions

File tree

README.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -48,27 +48,38 @@ npm install -g gitclaw
4848
export OPENAI_API_KEY="sk-..."
4949
# or: export ANTHROPIC_API_KEY="sk-ant-..."
5050

51-
# Create a minimal agent
52-
mkdir my-agent && cd my-agent
53-
git init
51+
# Point gitclaw at any directory — it handles everything
52+
gitclaw --dir ~/my-project
53+
```
5454

55-
cat > agent.yaml << 'EOF'
56-
spec_version: "0.1.0"
57-
name: my-agent
58-
version: 0.1.0
59-
description: My first gitclaw agent
60-
model:
61-
preferred: "openai:gpt-4o-mini"
62-
fallback: []
63-
tools: [cli, read, write, memory]
64-
runtime:
65-
max_turns: 50
66-
EOF
55+
That's it. Gitclaw auto-scaffolds everything on first run:
56+
- `git init` if not already a repo
57+
- Creates `agent.yaml`, `SOUL.md`, `memory/MEMORY.md`
58+
- Commits the scaffold
59+
- Drops you into the REPL
60+
61+
```
62+
? Repository path (. for current dir): ~/my-project
63+
Initializing git repository...
64+
Created agent.yaml (model: openai:gpt-4o-mini)
65+
my-project v0.1.0
66+
Model: openai:gpt-4o-mini
67+
Tools: cli, read, write, memory
68+
→ List all files and explain the project
69+
```
6770

68-
# Run it
71+
Or run without `--dir` and it will ask you interactively:
72+
73+
```bash
6974
gitclaw
7075
```
7176

77+
Single-shot mode:
78+
79+
```bash
80+
gitclaw --dir ~/my-project -p "Create a hello world script"
81+
```
82+
7283
### SDK
7384

7485
```bash

0 commit comments

Comments
 (0)