Skip to content

Commit 76944a1

Browse files
committed
docs(CLAUDE[code-blocks]) Prefer longform flags and split multi-flag commands
why: Shortform flags are cryptic in user-facing docs; multi-flag one-liners are hard to scan and copy-paste. what: - Add "Prefer longform flags" rule to Documentation Standards - Add "Split multi-flag commands" rule with \-continuation style - Include Good/Bad examples showing both rules together
1 parent a786511 commit 76944a1

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,24 @@ $ vcspull search django
332332
$ vcspull search "name:flask"
333333
```
334334

335+
**Prefer longform flags** — use `--workspace` not `-w`, `--file` not `-f`.
336+
337+
**Split multi-flag commands** — when a command has 2+ flags/options, place each on its own `\`-continuation line, indented by 4 spaces.
338+
339+
Good:
340+
341+
```console
342+
$ vcspull import gh my-org \
343+
--mode org \
344+
--workspace ~/code/
345+
```
346+
347+
Bad:
348+
349+
```console
350+
$ vcspull import gh my-org --mode org -w ~/code/
351+
```
352+
335353
## Debugging Tips
336354

337355
When stuck in debugging loops:

0 commit comments

Comments
 (0)