johno/beads
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add quoting guidance to AGENTS.md and SKILL.md

Browse Source 
Fixes #194 - Claude Code was failing to quote titles/descriptions with
special characters. Added explicit warnings and examples showing proper
quoting for arguments containing spaces, apostrophes, and special chars.

Amp-Thread-ID: https://ampcode.com/threads/T-0570ff80-8115-479d-b39c-dbdf2ada5215
Co-authored-by: Amp <amp@ampcode.com>
This commit is contained in:
Steve Yegge
2025-11-01 12:23:39 -07:00
parent d12b5b7221
commit e5a3f8ce25
2 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
AGENTS.md
View File

@@ -141,6 +141,7 @@ bd stale --days 90 --status in_progress --json # Filter by status
bd stale --limit 20 --json # Limit results bd stale --limit 20 --json # Limit results
# Create new issue # Create new issue
# IMPORTANT: Always quote titles and descriptions with double quotes
bd create "Issue title" -t bug|feature|task -p 0-4 -d "Description" --json bd create "Issue title" -t bug|feature|task -p 0-4 -d "Description" --json
# Create with explicit ID (for parallel workers) # Create with explicit ID (for parallel workers)
@@ -149,6 +150,10 @@ bd create "Issue title" --id worker1-100 -p 1 --json
# Create with labels # Create with labels
bd create "Issue title" -t bug -p 1 -l bug,critical --json bd create "Issue title" -t bug -p 1 -l bug,critical --json
# Examples with special characters (all require quoting):
bd create "Fix: auth doesn't validate tokens" -t bug -p 1 --json
bd create "Add support for OAuth 2.0" -d "Implement RFC 6749 (OAuth 2.0 spec)" --json
# Create multiple issues from markdown file # Create multiple issues from markdown file
bd create -f feature-plan.md --json bd create -f feature-plan.md --json

7
examples/claude-code-skill/SKILL.md
View File

@@ -224,11 +224,18 @@ bd ready --assignee alice # Filter by assignee
``` ```
**Create new issue:** **Create new issue:**
**IMPORTANT**: Always quote title and description arguments with double quotes, especially when containing spaces or special characters.
```bash ```bash
bd create "Fix login bug" bd create "Fix login bug"
bd create "Add OAuth" -p 0 -t feature bd create "Add OAuth" -p 0 -t feature
bd create "Write tests" -d "Unit tests for auth module" --assignee alice bd create "Write tests" -d "Unit tests for auth module" --assignee alice
bd create "Research caching" --design "Evaluate Redis vs Memcached" bd create "Research caching" --design "Evaluate Redis vs Memcached"
# Examples with special characters (requires quoting):
bd create "Fix: auth doesn't handle edge cases" -p 1
bd create "Refactor auth module" -d "Split auth.go into separate files (handlers, middleware, utils)"
``` ```
**Update issue status:** **Update issue status:**