Skip to content

Commit f84709a

Browse files
wphillipmoorewphillipmoore-claude
andauthored
docs: ban heredocs in shell commands (#340)
Add explicit ban on heredocs for multi-line CLI arguments. Always use temp files instead. Co-authored-by: wphillipmoore-claude <255925739+wphillipmoore-claude@users.noreply.github.com>
1 parent 896cc77 commit f84709a

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ creates divergent agent behavior across the multi-repo environment this project
2222
operates in. Consistency requires all guidance to live in shared, reviewable
2323
documentation.
2424

25+
## Shell command policy
26+
27+
**Do NOT use heredocs** (`<<EOF` / `<<'EOF'`) for multi-line arguments to CLI
28+
tools such as `gh`, `git commit`, or `curl`. Heredocs routinely fail due to
29+
shell escaping issues with apostrophes, backticks, and special characters.
30+
Always write multi-line content to a temporary file and pass it via `--body-file`
31+
or `--file` instead.
32+
2533
## Documentation Strategy
2634

2735
This repository uses two complementary approaches for AI agent guidance:

0 commit comments

Comments
 (0)