Skip to content

Commit 084044e

Browse files
committed
docs(skill): update balatrobot skill for turbo profile and clarify usage
- Switch recommended settings profile from "fast" to "turbo" - Remove env var mapping reference (duplicated in config.py) - Remove BalatroBot profile requirement note (outdated) - Add quotes around glob patterns in --requests examples Reorder API docs to surface method lookup first
1 parent 7948d14 commit 084044e

1 file changed

Lines changed: 8 additions & 12 deletions

File tree

.agents/skills/balatrobot/SKILL.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,16 @@ balatrobot serve --help
1616
Typical invocation:
1717

1818
```bash
19-
balatrobot serve --render headless --settings fast --debug
19+
balatrobot serve --render headless --settings turbo --debug
2020
```
2121

2222
Key flags:
2323

2424
- `--render [headfull|headless|ondemand]` — rendering mode (default: headfull)
2525
- `--settings NAME` — settings profile name (default: "default")
26-
- `--debug` — enable debug endpoints
26+
- `--debug` — enable debug endpoints (during divergence we need to turn this on)
2727
- `--num` — number of instances
28-
- `--path-*` — path overrides (`--path-balatro`, `--path-lovely`, `--path-love`, `--path-logs`)
29-
30-
All flags have `BALATROBOT_*` env var equivalents (e.g. `BALATROBOT_RENDER=headless`). See `src/balatrobot/config.py` for the full mapping.
31-
32-
**Requirement:** The mod only activates when the selected Balatro in-game profile is named exactly `BalatroBot`. Create this profile in Balatro's profile selector and select it before launching via `serve`.
28+
- `--path-*` — path overrides (don't need to use these)
3329

3430
`serve` auto-allocates ports, prints instance URLs and the session logs directory, then blocks until Ctrl+C. It writes a state file so other commands can discover the running instances.
3531

@@ -57,7 +53,7 @@ balatrobot api <method> [JSON_PARAMS]
5753
balatrobot api <method> --help
5854
```
5955

60-
Auto-discovers the running instance from the state file — no `--host`/`--port` needed for single-instance sessions. For multi-instance pools, use `-i`/`--index` (0-based, default 0).
56+
**Important**: to use the right `<method>` and `[JSON_PARAMS]` you must read `docs/api.md` which contains the full API reference (methods, errors, states).
6157

6258
Params are a JSON string (default `{}`). Examples:
6359

@@ -78,8 +74,8 @@ balatrobot api gamestate | jq '.state'
7874
balatrobot api gamestate | jq '{state, money, hand: .hand.count}'
7975
```
8076

81-
API errors surface as `<NAME> - <message>` on stderr (e.g. `INVALID_STATE`, `BAD_REQUEST`).
82-
Full API reference (methods, errors, states): `docs/api.md`.
77+
`balatrobot api` auto-discovers the running instance from the state file — no `--host`/`--port` needed for single-instance sessions.
78+
For multi-instance pools, use `-i`/`--index` (0-based, default 0).
8379

8480
## Logs
8581

@@ -88,8 +84,8 @@ Each session directory (`logs/<timestamp>/`) contains per-instance files: `<port
8884
## `api --requests` — replay & verify
8985

9086
```bash
91-
balatrobot api --requests logs/<ts>/<port>.req.jsonl
92-
balatrobot api --requests logs/<ts>/<port>.req.jsonl --responses logs/<ts>/<port>.res.jsonl
87+
balatrobot api --requests "logs/<ts>/<port>.req.jsonl"
88+
balatrobot api --requests "logs/<ts>/<port>.req.jsonl" --responses "logs/<ts>/<port>.res.jsonl"
9389
```
9490

9591
Replays a JSONL request trace against a running instance. `--responses` compares each live response against the recorded one (exits on first divergence). Mutually exclusive with positional `METHOD`.

0 commit comments

Comments
 (0)