Skip to content

Commit 99267f3

Browse files
committed
fix(setup): clarify config auto-discovery validation
The onboarding skill implied users needed --config for validation and included a repo-local example that only works when ./remobi.config.ts exists. Clarify that remobi auto-discovers config from cwd then XDG, and keep --config only for custom paths.
1 parent 8c65b08 commit 99267f3

1 file changed

Lines changed: 19 additions & 6 deletions

File tree

.agents/skills/remobi-setup/SKILL.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -166,13 +166,19 @@ export default {
166166

167167
Place at `~/.config/remobi/remobi.config.ts` (XDG location) unless the user prefers elsewhere.
168168

169-
After writing, validate by starting remobi:
169+
After writing, validate by starting remobi. remobi auto-discovers config from the current directory first, then `~/.config/remobi/`, so `--config` is only needed when you want to force a specific file:
170170

171171
```bash
172-
remobi serve --config ~/.config/remobi/remobi.config.ts --port 18765 -- /bin/true
172+
remobi serve --port 18765 -- /bin/true
173173
```
174174

175-
A zero exit means the config loaded and the command started cleanly. Fix any errors and re-validate until clean.
175+
A zero exit means the config loaded and the command started cleanly. If the user stored config somewhere custom, validate that path explicitly instead:
176+
177+
```bash
178+
remobi serve --config /path/to/remobi.config.ts --port 18765 -- /bin/true
179+
```
180+
181+
Fix any errors and re-validate until clean.
176182

177183
See [Config reference](#config-reference) below for the full schema, allowed keys, action types, and escape codes.
178184

@@ -587,11 +593,18 @@ Requires matching tmux bindings (see `references/tmux-basics.md` popup section).
587593
## Validation
588594

589595
```bash
590-
remobi serve --config ~/.config/remobi/remobi.config.ts --port 18765 -- /bin/true
591-
remobi serve --config ./remobi.config.ts --port 18765 -- /bin/true
596+
remobi serve --port 18765 -- /bin/true
597+
```
598+
599+
A zero exit means the config is valid when the file is in the normal search path (current directory or `~/.config/remobi/`).
600+
601+
For a custom location, validate explicitly:
602+
603+
```bash
604+
remobi serve --config /path/to/remobi.config.ts --port 18765 -- /bin/true
592605
```
593606

594-
A zero exit means the config is valid. Any error output means fix the reported paths before proceeding.
607+
Any error output means fix the reported paths before proceeding.
595608

596609
### Common validation errors
597610

0 commit comments

Comments
 (0)