update readme
This commit is contained in:
parent
033331db98
commit
b5c507570e
42
README.md
42
README.md
|
|
@ -20,30 +20,18 @@ bun link
|
||||||
|
|
||||||
## Configure
|
## Configure
|
||||||
|
|
||||||
Set your Anthropic API key:
|
Set your Anthropic API key in `~/.env`:
|
||||||
|
|
||||||
```bash
|
```
|
||||||
export ANTHROPIC_API_KEY=sk-ant-...
|
ANTHROPIC_API_KEY=sk-ant-...
|
||||||
```
|
```
|
||||||
|
|
||||||
Optionally add a `sandlot.json` to your repo root:
|
This file is loaded automatically on startup. Variables already set in the environment take precedence.
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"vm": {
|
|
||||||
"cpus": 4,
|
|
||||||
"memory": "8GB",
|
|
||||||
"image": "ubuntu:24.04",
|
|
||||||
"mounts": { "/path/to/deps": "/deps" }
|
|
||||||
},
|
|
||||||
"ai": {
|
|
||||||
"model": "claude-sonnet-4-20250514"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
Run all commands from inside a cloned git repo.
|
||||||
|
|
||||||
### Start a session
|
### Start a session
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -77,3 +65,21 @@ sandlot open <branch> # re-enter a session's VM
|
||||||
sandlot stop <branch> # stop a VM without destroying it
|
sandlot stop <branch> # stop a VM without destroying it
|
||||||
sandlot rm <branch> # tear down without merging
|
sandlot rm <branch> # tear down without merging
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Project config
|
||||||
|
|
||||||
|
Optionally add a `sandlot.json` to your repo root:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"vm": {
|
||||||
|
"cpus": 4,
|
||||||
|
"memory": "8GB",
|
||||||
|
"image": "ubuntu:24.04",
|
||||||
|
"mounts": { "/path/to/deps": "/deps" }
|
||||||
|
},
|
||||||
|
"ai": {
|
||||||
|
"model": "claude-sonnet-4-20250514"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user